Integration into Other Systems
Valid for: enaio webclient version 8.50 SP1
You can integrate enaio with other systems and web applications: Links to a enaio URL can be integrated wherever URLs are evaluated, primarily in web pages.
You can also define a specific action to be performed automatically after logging in to enaio, for example opening a enaio document or running a saved search. Enter parameters into the URL to specify the action to be executed and the enaio object with which the action will be performed.
This URL reads as follows:
http://<DOMAIN>/<Name_der_Webanwendung>/#/entry?<Parameter>=<Parameterwert>
You enter this URL into your web application, for example. Clicking the URL will perform the action, e.g. showing an enaio document.
The following actions are available:

The enaio home screen can be integrated.
The URL has the following structure:
http://<DOMAIN>/osweb/
If the web application was given a name other than osweb during the installation, the URL will have the following structure:
http://<DOMAIN>/<Name_der_Webanwendung>/
If enaio gateway uses the default port, specifying the port in the URL is optional.

You can specify the ID of an object to be opened by clicking on the embedded URL.
Whether the object or its index data is opened depends on the setting of the parameter com.os.osdrt.hitlist.document.default.action.
Parameter: /#/entry?osid=<Object-ID>
http://<DOMAIN>/osweb/#/entry?osid=4300
Result: The object with ID 4300 will open.
Optionally, you can also specify the object type ID. This opens the object faster.
Parameter: /#/entry?osid=<Objekt-ID>&objecttypeid=<Objekttyp-ID>
http://<DOMAIN>/osweb/#/entry?osid=478645961&objecttypeid=262144
Optionally, you can also specify the parameter activeVariant. This parameter causes an inactive variant that is queried from outside to be transformed into the current active variant. If the parameter is set to true, the system checks whether the object is the active variant of the object. If the object is not an active variant, the active variant of the desired object is opened. If the parameter is not set or false, exactly the object with the requested OSID is opened.
Parameter: /#/entry?osid=<Objekt-ID>&activeVariant=<Wert>
http://<DOMAIN>/osweb/#/entry?osid=478645961&activeVariant=true
Result: The active variant of the requested object with the ID 478645961 is opened.
http://<DOMAIN>/osweb/#/entry?osid=478645961&activeVariant=false
Result: The requested object with ID 478645961 is opened.

You can specify the ID of an object whose index data will be opened by clicking on the embedded URL. The object can be a folder, a register, or a document.
Parameter: /#/entry?indexdata=<Object-ID>
http://<DOMAIN>/osweb/#/entry?indexdata=4300
Result:
The index data of the object with ID 4300 will open.
Optionally, you can also specify the object type ID. This opens the index data of the object faster.
Parameter: /#/entry?indexdata=<Objekt-ID>&objecttypeid=<Objekttyp-ID>
http://<DOMAIN>/osweb/#/entry?indexdata=478645961&objecttypeid=262144
Optionally, you can also specify the parameter activeVariant. This parameter causes an inactive variant that is queried from outside to be transformed into the current active variant. If the parameter is set to true, the system checks whether the object is the active variant of the object. If the object is not an active variant, the index data of the active variant of the required object is opened. If the parameter is not set or false, the index data of the object with the requested OSID is opened.
Parameter: /#/entry?indexdata=<Objekt-ID>&activeVariant=<Wert>
http://<DOMAIN>/osweb/#/entry?indexdata=478645961&activeVariant=true
Result: The index data of the active variant of the requested object with the ID 478645961 is opened.
http://<DOMAIN>/osweb/#/entry?indexdata=478645961&activeVariant=false
Result: The index data of the requested object with ID 478645961 is opened.

You can specify the ID of an object whose location will be opened by clicking on the embedded URL. If the specified object is a folder, its contents will be opened.
Parameter: /#/entry?location=<Object-ID>
http://<DOMAIN>/osweb/#/entry?location=4300
Result: The location of the object with ID 4300 will open.
Optionally, you can also specify the object type ID. This opens the location of the object faster.
Parameter: /#/entry?location=<Objekt-ID>&objecttypeid=<Objekttyp-ID>
http://<DOMAIN>/osweb/#/entry?location=478645961&objecttypeid=262144
If an object has multiple locations, you can determine the location to open by clicking on the embedded URL by specifying the ID of the object and the ID of the register.
Parameter: /#/entry?location=<Objekt-ID>&parentid=<Parent-ID>
http://<DOMAIN>/osweb/#/entry?location=4300&parentid=110
Result: The register with ID 110 with the object will open with the ID 4300.
Optionally, you can also specify the register type ID. This opens the location of the object faster.
Parameter: /#/entry?location=<Objekt-ID>&parentid=<Register-ID>&parenttypeid=<Registertyp-ID>
http://<DOMAIN>/osweb/#/entry?location=478645961&parentid=55632&parenttypeid=110
In addition to the ID of the register type, you can also specify the ID of the object type. This opens the location of the object even faster.
Parameter: /#/entry?location=<Objekt-ID>&objecttypeid=<Objekttyp-ID>&parentid=<Register-ID>&parenttypeid=<Registertyp-ID>
http://<DOMAIN>/osweb/#/entry?location=478&objecttypeid=264&parentid=532&parenttypeid=110
You can also specify the parameter flat. This parameter allows you to jump to a flat folder view. It causes the register structure to be switched off and all documents in a folder to be displayed in a hit list. If the parameter is set to true, the register structure is switched off. If the parameter is not set or false, the register structure is displayed.
Parameter: /#/entry?location=<Objekt-ID>&flat=<Wert>
http://<DOMAIN>/osweb/#/entry?location=478645961&flat=true
Result: The register structure of the requested object with the ID 478645961 is switched off.
http://<DOMAIN>/osweb/#/entry?location=478645961&flat=false
Result: The register structure of the requested object with the ID 478645961 is displayed.

You can specify the ID of a workflow work item to be opened by clicking on the embedded URL.
The IDs of work items can be determined with the help of program libraries such as the Java workflow API.
Parameter: /#/entry?workflow=<ID of process step>
http://<DOMAIN>/osweb/#/entry?workflow=0A3F88A13FA4445AA5D0CFE062B941E
Result: The workflow work item with the ID 0A3F88A13FA4445AA5D0CFE062B941E is opened. If you are one of the editors of the work item, it will appear in your inbox a short time later.

You can specify the ID of a saved search that can be executed by clicking on the embedded URL.
Saved searches are set up in enaio client.
Parameter: /#/entry?search=<Search-ID>
http://<DOMAIN>/osweb/#/entry?search=26889
Result: The result of the search with ID 26889 will be shown in a hit list.
You can determine the ID of a saved search via the enaio appconnector. To do this, access the following URL in your browser: http://<DOMAIN>/osrest/api/documents/storedqueries?showglobal=true. In the JSON output in the browser, you can then search for the name of the search and determine the ID of the saved search.

You can specify the ID of a saved search with variables that can be executed by clicking on the embedded URL.
The action is limited to saved searches with dynamic variables. Saved searches with static variables and/or special values (#User#, #Date#, etc.) cannot be executed via URL.
Parameter: /#/entry?search=<Anfrage-ID>&var1=<Variablenwert>
Multiple variables are combined using the & character.
http://<DOMAIN>/osweb/#/entry?search=26889&var1=a&var2=100077
Result: The result of the search with ID 26889, variable 1=a, and variable 2=100077 will be shown in a hit list.
You can determine the ID of a saved search via the enaio appconnector. To do this, access the following URL in your browser: http://<DOMAIN>/osrest/api/documents/storedqueries?showglobal=true. In the JSON output in the browser, you can then search for the name of the search and determine the ID of the saved search.

You can specify the ID of a document whose document file is downloaded by clicking on the embedded URL.
Parameter: /#/entry?download=<ID des Dokuments>
http://<DOMAIN>/osweb/#/entry?download=4421
Result: The document file of the document with the ID 4421 is downloaded.
Optionally, you can also specify the object type ID. This will start downloading the document file faster.
Parameter: /#/entry?download=<Objekt-ID>&objecttypeid=<Objekttyp-ID>
http://<DOMAIN>/osweb/#/entry?download=4421&objecttypeid=2621
Furthermore, you can download a PDF of the document file instead of the original document file.
Parameter: /#/entry?download=<ID des Dokuments>&rendition=pdf
http://<DOMAIN>/osweb/#/entry?download=4421&rendition=pdf
Optionally, you can also specify the parameter activeVariant. This parameter causes an inactive variant that is queried from outside to be transformed into the current active variant. If the parameter is set to true, the system checks whether the object is the active variant of the object. If the object is not an active variant, the active variant of the desired object is downloaded. If the parameter is not set or false, then exactly the object with the requested OSID is downloaded.
Parameter: /#/entry?download=<Objekt-ID>&activeVariant=<Wert>
http://<DOMAIN>/osweb/#/entry?download=478645961&activeVariant=true
Result: The active variant of the requested object with the ID 478645961 is downloaded.
http://<DOMAIN>/osweb/#/entry?download=478645961&activeVariant=false
Result: The requested object with the ID 478645961 is downloaded.
If a document contains several document files, they are downloaded together in a ZIP file. Similarly, several document files of a document are combined into one PDF when downloading using the parameter rendition=pdf.
© Copyright OPTIMAL SYSTEMS 2020. | Legal and Data Privacy