Links to External URLs/Applications/Functions

enaio® webclient • 11.10 »

External web applications, as well as any URLs or JavaScript functions, can be called via embedded URLs in enaio® webclient, enaio® webclient as a desktop application, and enaio® mobile. The call is made via links in the context menu.

External applications can also be called by transferring data in enaio® webclient as a desktop application.

The configuration is done via the tools.json file that has to be created in the\service-manager\config\apps\osweb\public\external_tools directory.

We provide a configuration file as a template for downloading.

The configuration specifies authorized users, object types, client types, localizable labels, icons, and URLs, as well as paths to applications/JavaScript functions.

Parameters of the Configuration File

Parameter Value
users / groups

Users and groups for which the link is made available.

Example: "groups": ["DEV","CON"]
objectTypes

One or more object types for the link.

Example: "objectTypes": ["object1","object2","object3"]

Enter the table name or the internal name.

Value for all object types:

"objectTypes": "*"

type

"type": "url" for URL links

"type": "application" for application links

"type": "function" for calling JavaScript functions that are integrated into 'GlobalWebClientScript' or 'AfterWebClientLogin' sections via enaio® editor-for-events.
platforms

"platforms": ["desktop_app"] for enaio® webclient as a desktop application

"platforms": ["web"] for enaio® webclient

"platforms": ["mobile"] for enaio® webclient on mobile devices

"platforms": ["mobile_app"] for enaio® mobile

Multiple clients can be specified.

Example: "platforms": ["mobile","desktop_app"]
path

Path for the external application or URL

Examples:

"path": "C:\\Program Files\\Notepad++\\notepad++.exe"

"path": "https://help.optimal-systems.com"

The 'path' parameter can contain placeholders:

$username$ – Name of the current user.

$osid$ – The ID of the object. If multiple objects are selected, the IDs are output in comma-separated format.

Example:

"path": "https://app.optimal-systems.com?soos=$username$&osid=$osid$",

Example for the enaio® coLab-Project-Room-Creator call:

"path": "http://<gateway>/colab/create-project-room/$osid$/$username$",

name

Name of the link, can be localized.

Example:

"name_EN": "Open documentation portal",
"name_DE": "Dokumentationsportal öffnen",
"name_FR": "Ouvrir portal de documentation"

iconId

Icon that is shown for a link (optional).

Icon IDs can be determined via the Icon assignment dialog in enaio® editor. New icons can be integrated there.
argument

Application links (optional)

Parameter for transferring data to applications

The parameters depend on the external applications.

Example: "argument": "%f"
workingDirectory

Application links (optional)

Applications can require files that need to be in the specified source directory.

The following parameters are used for data transfer:

  • %o

    One or more paths to enaio® objects are directly transferred. Spaces are used as a separator. If the path or file name contains spaces, the file path is placed in quotation marks.

  • %p

    A path to a text file which contains a path to an enaio® object for each line.

  • %i

    A path to a text file which contains a unique ID and the object type, separated with a comma, for each line. This parameter is useful if you are transferring a large number of objects.

  • %f

    One or more paths to files. If the files are not yet available in the CACHE area, they will be transferred there. Spaces serve as separators in the same way they do with the parameter %o.

  • %g

    A path to a text file which contains a path to a file in the CACHE area in each line. This parameter is useful if you are transferring a large number of objects. If the files are not yet available in the CACHE area, they will be transferred there.