Copyright 2021 OPTIMAL SYSTEMS GmbH
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Please visit our official Dashlet API documentation for more information about developing and integrating dashlets into enaio® webclient.
In the enaio® webclient, from version 10.0 Service Release 2, we provide you with the option of integrating customer-specific and freely configurable areas - so-called dashlets. Dashlets support you in the implementation of a wide variety of business processes and scenarios by making them available as additional information and interaction options for users, depending on the context.
For the preview area, in which the content and detailed previews are currently displayed, you can configure individual dashlets that, for example, integrate other information sources with the help of so-called dashlet services (e.g. websites such as Wikipedia or Google Maps). Alternatively, you can integrate complete web applications such as the enaio® documentviewer.
The enaio® webclient works on an event basis. The individual events are shown in an overview below. Details about each event can then be found on the respective event subpage. Below are the currently available events:
The onInit event is triggered every time the dashlet is activated and thus made visible. The payload of the event contains information about the current status, which enables the dashlet to initialize itself directly without having to call many methods afterwards.
You can find more information about this event on our documentation page.
The onUpdate event is triggered every time the object selection has changed in the enaio® webclient. It contains the same properties as the onInit event.
You can find more information about this event on our documentation page.
Dashlets can control the enaio® webclient and trigger actions. This is also done via the browser API postMessage. The window.postMessage method enables secure cross-origin communication between Window objects; for example, between a page and a pop-up generated by it or between a page and an iframe embedded in it. Below are the methods currently available:
For more information on methods, see our documentation page.
The openLocation method is used to call the enaio® webclient's Open Location scripting method, which opens the location (or a location selection if there are several possible locations) for the DMS object transferred as a parameter.
Using the method openIndexData, the scripting method Show Indexdata or Edit Indexdata of the enaio® webclient is called, which opens the index data mask for the DMS object transferred as a parameter.
The getSelectedObjects method is used to query the currently selected objects. If no objects are selected or no hit list is currently displayed, an empty list is returned.
Please visit our official Dashlet API documentation for more information about developing and integrating dashlets into enaio® webclient.