enaio® appconnector

enaio® 9.10 »

enaio® appconnector is a core service of enaio®.

The core services are default components of enaio® and are required for operating the enaio® platform and the proper functioning of the individual enaio® components.

enaio® appconnector, as a REST (Representation State Transfer) interface, enables resource-oriented, flexible HTTP access to index and document data in enaio®.

enaio® appconnector thus offers several application areas:

  • It serves as an interface to mobile applications, such as enaio® app for Android-based smartphones, iPhones, and tablets.
  • It can be deployed as the Details Preview for showing index data and other data in enaio® client and other external applications.
  • It can be deployed as a communications component, allowing enaio® webclient, enaio® webclient as a desktop application, and enaio® mobile structured access to the enaio® server.

The OSRest API documentation can be found here.

System Requirements

You need the APP license for configuration and administration of enaio® appconnector. The APP license has to be registered in enaio® server.

The system role 'DMS: Supervisor' is required for the configuration.

Installing enaio® appconnector

The enaio® appconnector REST interface is installed as a service via the enaio® setup. To do so, select the core service enaio® appconnector in the setup.

The 'Server: Switch job context' system role must be assigned to the technical user whose user account is used to execute enaio® appconnector.

enaio® appconnector requires at least 2 GB of memory by default. The runtime environment (JDK and application server) will also be automatically installed.

The installed runtime environment should be used only for this core service, because the runtime environment is also updated when the core service is updated. If other enaio® components or third-party components are run in the runtime environment, update errors may occur or the other components may no longer function after the update.

The following data must be entered during the installation process:

  • Server name and port

  • Name and password of the technical user

The service is automatically registered with enaio® server during the setup.

The installation of enaio® appconnector is now complete and you can start the enaio® appconnector application in the services administrative tool.

enaio® appconnector registers its service endpoint with enaio® server during installation, so that it can be read by other components. The service endpoint can be viewed and changed in enaio® enterprise-manager under Server properties > Category: Services > 'Core Service' > Service endpoint.

Installing a Hotfix

A hotfix installation will only replace the obsolete files of the existing version with new, modified files. Updating your installation to a newer version using a hotfix is not possible.

A hotfix replaces only a few system files so the enaio® appconnector installation may not need to be configured again.

The existing enaio® appconnector installation will not be backed up.

When installing a hotfix and before replacing files, a check is carried out to establish whether the version of the existing installation matches that of the hotfix. If this is not the case or a newer hotfix was already installed, no file will be replaced. The installation then stops and a corresponding message is shown.

Hotfixes (osappconnector_hotfix.exe) are located in the SP directory of the installation data.

Updating enaio® appconnector

A core service enaio® appconnector update is performed from the enaio® setup. A backup of the current configuration file versions is performed automatically. After an update, the backed up configuration files can be found in the subdirectory backup-(timestamp) of the core service.