System Areas

System areas allow you to divide an installation into several (possibly spatially separated) areas. The standard area could be the head office (small installations or those with no spatial separation have only the standard area). A further system area can be created for an additional, spatially separated branch office which has its own IQ4docs server to run services locally. The main advantage of areas is the local execution of services and storage of files.

Each system area has a local installation of services and the message broker RabbitMQ (can also be designed as a cluster, see also Cluster Installation). Workflow files (scans, print jobs...) are also stored locally in the system area and might not need to be transmitted via long-distance lines.

System areas can be assigned IP ranges. These ensure that devices are automatically assigned to the correct system area (the assignment takes place automatically as soon as the DeviceClient is displayed on the device).

There is only one MongoDB in one IQ4docs installation. Without access to the database, the services of a server cannot be operated.

To open the web administration, enter http://<hostname>/webadmin in the web browser (where hostname corresponds to the server on which IQ4docs WebAdmin was installed). In a client environment, enter the URL that you received from the client administrator (for example, http://server/webadmin/#/cf992178-4bd6-431c-b815-b9d734d0ded3). If you are not already logged in, log in with a user that has administrator rights (login and password) or as the IQ4docs system administrator (administrator with password admin by default).

In the Web administration, click System > System Areas in the menu. The list view of the system areas opens. The Standard Area system area is present by default.

The Standard Area system area is present by default. You can edit the settings of the area using the Edit icon at the end of the line or the Edit System Area button below the table.

A system area can be deleted by clicking the delete symbol at the end of the line of the area list. The standard area that exists initially cannot be deleted.

Use the + Create System Area button to create a system area. The detail dialog of the system area opens.

  • Name: Enter any name of your choice for the area. The name must not remain blank.

Workflow files are stored in a share that the installer creates and automatically authorizes (share and directory access) for the user specified in the installer. These data include print@me print jobs and temporary scan files. For running workflows in a waiting state (e.g. print@me print jobs), the path is contained in the workflow. If the path is changed, files of running workflows are still searched for using the old path.

Image files for zone OCR are also stored in the WorkflowFiles directory. After changing the path, they must be copied into the new path or uploaded again via the web administration. However, the image is only used for visualization when configuring zone OCR – it is not required for the actual execution of a zone OCR process.

Before making any changes, remember that the IQ4docs components must be able to access this directory. See also Change System User.

Field Description
Hostname Specify the hostname of the server where the share specified under Path is located.
Save files locally This setting is only relevant if several services are used on different servers. If this setting is set, the hostname specified under Hostname is not used to reach the share specified under Path, but it is instead always assumed that the share is present locally (this must be set up accordingly). This is intended to reduce the network traffic.
Path Share name under which the system relevant files are stored.
Username Username that is authorized to access the share (and underlying directory) specified under Path.
Password Password of the user for sharing and directory access.
Save Print Data Encrypted Enable this option if workflow data (print jobs, scan jobs...) should be cached encrypted in the directory specified under Path. Remember that encryption and decryption require system resources and time.

When the system is set to communicate using encryption, the protocol type for the encryption can be set. Only the set protocol type will then be used for any encrypted transmission between the IQ4docs components (not for e-mail transmission).

  • Tls (TLS 1.0, no longer supported in some modern applications)
  • Tls11 (TLS 1.1)
  • Tls12 (TLS 1.2)
  • Ssl3 (SSLv3, deprecated, no longer supported in many modern applications)

This setting is not relevant for unencrypted communication.

You can assign one or more IP ranges to a system area. You can use this in the device search, for example, to find only devices in this IP range, see also Find and create devices. Based on the IP range, devices are automatically assigned to a system area; the system area is displayed in the detail dialog of the device.

To add an IP range, click Add IP Range (a new line is added). Enter the first address of the range in the Address From field and the last address of the range in the Address To field (IPV4).

If you want to delete an IP range, click ... at the end of the line and then select Delete IP Range.

IP address ranges must not overlap with those of other system areas.

The Windows servers of an installation are specified here. If you have a single-server installation, only one server is entered here for the standard area. If you operate a cluster system with several cluster nodes, enter them here (see also Cluster Installation).

You can modify the server details directly in the list view. Simply edit the desired field. To add a server (cluster node), click + Add Server (Cluster Node). To delete a server, click ... at the end of the line and select Delete Server.

Field Description
Computer Name Specify the computer name of the server running the services and RabbitMQ. Enter the name as it is stored in the Windows environment variable (%COMPUTERNAME%) - always without a domain specification. The computer name is used to query the service status in WebAdmin and has no influence on the function of the services themselves.

If there are several system areas, the computer name must be specified for all system areas.

Protocol Specify the protocol with which the data transmission is to be carried out, http (unencrypted) or https (encrypted, note that encrypted transmission requires further settings, see SSL transmission between IQ4docs components and to the browser).
Hostname Specify the hostname of the server on which the services and RabbitMQ are running (for https, with exact names as specified in the certificate)
Port Specify the port on which the services communicate. By default, the services in IIS are entered in the default web site that communicates on port 80 (if the Port field remains empty, port 80 is assumed). This means only one entry is required if this has been changed manually.

You can disable services of a server or cluster node of the system area. No further attempts will then be made to access these services. This is useful if these services have not even been installed in this system area. Attempting to contact non-existent services for queries can result in misleading information in the dashboard, see also Dashboard.

Clicking on ... at the end of the line of a server (cluster node) and then on Query Service Versions opens a window in which all services are listed.

You can query the versions of all services of the server here – this also happens automatically when you open the list. This also checks whether the services are available.

Services that were queried correctly are marked with a green check mark and show the version number. If services cannot be queried, a yellow warning symbol appears along with Service Unavailable or Not Found.

The following information is available for each service:

Field Description
Service name Designation of the service.
Version Version number of the service with build commit (this allows developers to accurately identify the version).
MongoDB hostname Name of the MongoDB server (cluster node) to which the service is connected. This can also be more than one if a comma separated list is entered in the LocalService.config of the service.
RabbitMQ hostname Name of the RabbitMQ server (cluster node) to which the service is connected. This can also be more than one if a comma separated list is entered in the LocalService.config of the service.
Area System area of the service

For this purpose, all technical configuration data for each service can be displayed using the > at the beginning of the line. This is the actual data in JSON format that the service uses.

If the MongoDB, RabbitMQ or System Area data in the list are not filled in, the version of the service is not (yet) able to provide this information.

At the end of the line, click ... and in the menu that opens, click Reload Configuration. This causes the configuration to be requested again by the service, i.e. the configuration with which the service is currently running is loaded again.

At the end of the line, click ... and in the menu that opens, click Reload Version. This will reload the version from the service and display it in the Version column.

At the end of the line, click ... and in the menu that opens, click Reconfigure Service to reconfigure a single service. The service then requests its configuration data from ConfigService again and uses it.

To reconfigure all services at once, use the Reconfigure All Services button below the list.

To access the web interface of RabbitMQ, click ... at the end of the line and then click RabbitMQ Management. You can log in to the web page which opens.

If IQ4docs consists of several individual complete installations (with database), data can be distributed across installations, see Data Distribution Over Several Installations. If the DbSyncService is not installed on a different server than all the other IQ4docs services, then the same entries are to be made here as for Server (cluster nodes).

You can change the details of the server running the DbSyncService directly in the list view. Simply edit the desired field. To add a server, click on + Add service for data distribution. To delete a server, click ... at the end of the line and select Delete Server.

Field Description
Protocol Specify the protocol with which the data transmission is to be carried out, http (unencrypted) or https (encrypted, note that encrypted transmission requires further settings, see SSL transmission between IQ4docs components and to the browser).
Hostname Specify the hostname of the server on which the DbSyncService is running (for https with exact names as specified in the certificate).
Port Specify the port on which the services communicate. By default, the services in IIS are entered in the default web site that communicates on port 80 (if the Port field remains empty, port 80 is assumed). This means only one entry is required if this has been changed manually.

If changes have been made that affect the device (e.g. changing URLs), these data must be transferred to the device. Then reconfigure the Embedded Client as described below.

In the web administration, click Devices > Device List in the menu. The list appears showing all devices that have already been added to the system manually or via the device search (see also Device List).

Select one or more devices with the checkbox at the beginning of the line. Then click the Configure Devices drop-down list and select Configure Device For IQ4docs. Once the process has been successfully completed and the list view has been reloaded with the Refresh button , the device is marked with a green dot.

The Restart Devices function in the Configure Devices drop-down list cannot be used for Toshiba devices.

With some manufacturers, installation of the client and automatic configuration of the device is not possible when a user is logged in to the device.