TIF Administration and Configuration Guide

1. Overview

The Admin UI is bundled with the TIF product. The application is a role based web based application and is used to monitor what currently is happening on the TIF server as well as what has happened in the past.

The default URL to the Admin UI: http://<host>:8181/enovia/adminui. Note that the HTTP port (and/or HTTPS port) and the context path can be changed via configurations.

The Admin UI is accessible on each TIF server instance.

If you have multiple TIF instances operating in the same environment, you should consider using an external database for the TIF data.

That will then enable accessing the same information regardless what instance you log-in to.

1.1. User Accounts

Within the file ${TIF_ROOT}/modules/enovia/etc/module.custom.properties you configure the admin user including the initial password for this user.

When starting TIF, the internal user-database will be populated with this user name / password combination IF there are no users defined in the database. Any further change to this user can only be made from within the application.

The default login user name is admin and the default password is S3cr3t.

From the admin UI you can create additional accounts that are allowed to use the application.

In order to make the admin UI application work properly regarding the process of requesting password resets or creation of new users, it is of importance that TIF is configured correctly regarding mail settings. E.g. TIF needs the ability to send emails.

You can turn off the user-accounts by setting the property user.account.db.enabled to false. Then you can only log in using the user name / password as defined in the properties file.

In this mode, the admin ui feature allowing you to create new user accounts is disabled.

1.2. Supported Browsers

The Admin UI is supported/tested on these (evergreen) browsers

Firefox
Chrome
Microsoft Edge

The application may work on other browsers too, however, we only support the browsers listed above.

Regarding Internet Explorer 11 (IE-11): Please consider using another browser such as any in the previous list, since this browser is very old and have poor support for newer web-technologies. If you still insist on using IE-11, you should be aware of that the Admin UI may either not work at all or only work partly. You should also know that the application will not work at all if the "Compatibility mode" is turned on.

1.3. REST API

The Admin UI application is a single page application that communicates with the TIF server via REST endpoints.

These endpoints are documented in this document.

To use the endpoints, you need to authenticate the user to obtain a token. Example:

curl -X POST "http://localhost:8181/enovia/adminapi/v1/auth/login" -H "Content-type: application/json" -d '{"username":"admin","password":"the-password"}'

This will return a token like this:

{
  "token" : {
    "type" : "Bearer",
    "value" : "..................."
  }
}

For any further call, the above token should be sent in each request:

curl -X GET "http://localhost:8181/enovia/adminapi/v1/..." -H "Authorization: Bearer abcdef.abc.def"

NOTE:

If password is wrong, HTTP 401 is returned.
Trying to an invalid token returns HTTP 403
Logout will revoke the token (or after 24h inactivity)

You can disable the authorization check via a property in module.properties. This should only be used for test or during development.

adminapi.authorization.enabled=false

2. Search Indexer

TIF can be integrated with a search indexer; e.g the internal data in TIF is added into an index in order to speed up queries from TIF and reduce the overall load on the TIF server.

Please read this page for details how to enable this.

Once you have configured TIF to utilize a search indexer, you will see some new things in the Admin UI. See image below:

Figure 1. Search

In the top menu, you will have an input field that allows you to execute global queries against the jobs in the search index. The query is made against all data related to the job such as payload content etc.

Secondly, you will have some new functions related to indexing and searching settings.

2.1. Query Mode

The query mode is per default set to "use search engine if available". However, during some period when all data not have been added to the index yet, you may want to query the database instead.

This can be changed from the query mode settings page.

Figure 2. Query Mode Settings

Note that after changing the mode to "Database", the global query will not be available and possible other features as well.

You should toggle this back once your search index is up-to-date with the TIF database.

2.2. Re Indexing

It may happen that your search index is lost or needs to be re-created for one or another reason.

From the TIF Amin UI you can mark jobs that needs to be re-indexed via the "Data Indexer" page as seen below.

Figure 3. Re-indexing

You can from this page also statistics regarding how much data that is unindexed. To do so, you need to click a separate button that will load this information. That action will take some time in case you have a large database.

Here you select what data (or all) that should be marked for reindexing. You can also specify a date range, e.g. after/before/between.

The reindexing will take place as soon as the Search Index Synchronizer is triggered the next time.

3. Navigation

Depending on what role(s) a particular admin user have, different actions/menu items will be available.

3.1. User Roles

Support for assigning roles to an administration user were added as of release 2022.2.0. Assigning different users different roles will enable/disable certain actions in the UI.

The available roles an administration user can have are listed in the table below together with what actions such user normally can perform.

Role Name

Parent Role

Description

Job Data Viewer

Can view job data, job-services and job statistics

Job Data Editor

Job Data Viewer

Can delete, resend, resolve jobs.

Service Editor

Edit service settings etc.

App Event Viewer

View Application Events

App Event Editor

App Event Viewer

Can delete app events

Job Queue Viewer

Can view job queues

Job Queue Editor

Job Queue Viewer

Can edit job queue settings such as thread count.

Instance Viewer

Can view:

Runtime log levels
Performance info
System thread info
Server configurations
Query mode
Log files

Instance Editor

Instance Viewer

Can:

Update Runtime log levels
Change Query Mode
Trigger re-index of data

Scheduled Job Viewer

Can view the scheduled jobs and the status/logs from them

Scheduled Job Editor

Scheduled Job Viewer

Can:

Inactivate scheduled job
Start a scheduled job manually

Configuration Viewer

Can view integration configurations

Configuration Editor

Configuration Viewer

Can edit integration configurations

Service Activator Viewer

Can view the service activators

Service Activator Editor

Service Activator Viewer

Can Start/Stop a service activator

User Viewer

Can view the admin users in the system

User Editor

User Viewer

Can create and edit users.

A user with role user-editor can not assign a user a role, which the current user lacks.

To access Admin UI, you are required to login with administrator user name and password.

Figure 4. Login

See this page how to configure password.

3.3. Dashboard

Once logged in you will reach the dashboard. It shows an overview of recent activities in TIF.

Figure 5. Dashboard

You can do the following:

See throughput statistics across all services
See list of recently active services on the TIF server
See most recent jobs that have failed.
View Services
View Jobs
View Statistics
Monitor events, job queues, scheduler and features
View configurations and do runtime changes
Global search enabled if a Search Indexer has been configured.
TIF Internals, such as indexer/query settings, see version and license details etc.
Log Out

3.4. Services

TIF supports different types of services: inbound and outbound integrations, batch jobs and web services. In the Admin UI they are displayed together with the common name "Service".

Figure 6. Services

In the services view, it is possible to list services grouped by their type. In addition, the list may be shown as tiles or as a list, filter services by name and sorted by different criterias.

As of TIF 2017.2.0, service type MESSAGING is deprecated. Instead, new services in this category appear in Admin UI with more specific type such as AMQP, JMS and MQ.

However, existing MESSAGING services registered in TIF’s DB are still visible with legacy type MESSAGING in Admin UI.

3.4.1. View Service

In Service view you find information specific for that service. For instance you find throughput statistic and a list of jobs for the service. The view also contains a chart that displays filtered jobs as graphical columns. There are unit and zoom selections available for the chart.

Figure 7. Service View

From Action menu you can view service settings, create, delete and export (CSV, PDF) jobs. If the service is of type ENOVIA/3DExperience, you may also resend one or more jobs that are completed with errors. A warning triangle is shown on left to actions menu if there are some important messages regarding the service. You can click the icon to see messages.
Jobs are filtered by status which can be selected using buttons in the view.
Job View shows details of job. Press row on the table.
Table contents can be refreshed and filtered by date. When changing the date, table can be reloaded from the refresh icon that appears on orange color.

The information displayed for each job is slightly different depending on what kind of service you are looking on. For instance are the input parameters supplied by the user visible when viewing a web service, but no such information exists when viewing a message integration service.

3.4.2. Delete Service and Jobs

Figure 8. Delete Actions

It is possible to delete jobs with custom date range or all jobs from a service. When deleting all jobs, only completed, pending or awaiting reply jobs are deleted. Jobs that are initialized or being processed are excluded.

Figure 9. Delete All Jobs

When deleting the service, it will also delete its all jobs.

When deleting the service, make sure it does not have jobs that are initialized or being processed as those will prevent the deletion.

3.4.3. Service Settings

In Settings view you can specify the number of days to keep jobs for this service. Also it is possible to choose whether to store payload data of jobs.

Default service history settings are defined in ${TIF_ROOT}/modules/enovia/etc/module.properties.

An example of default service history settings:

# Specifies how many days jobs are kept in the TIF DB. By default jobs are kept 20 days.
defaultServiceSetting.jobKeepDays=20
# Specifies whether payloads are persisted by TIF. Default is true.
defaultServiceSetting.storePayload=true

To view current XML configuration of the service, press "View Configuration" link. See also chapter Configuration.

It is not possible to view configurations of service of deprecated type MESSAGING. See Services.

Figure 10. Service Settings

3.5. Jobs

Jobs view provides an overview of jobs from all services.

Figure 11. Jobs

From Action menu you can create, delete, resend and resolve jobs.
Jobs are filtered by status which can be selected using buttons in the view.
Press table row to view a job.
Jobs found with the current filter can be deleted, resent or resolved (depending on the state).
Jobs can be filtered by date and/or service.
Table pagination actions.
Access table column visibility settings.
Search jobs.

Table column order can be changed by dragging column headers.

Table column order and visibility settings are stored in browser’s local storage. If the storage is cleared, the settings are also reset.

3.5.1. View Job

All details regarding the job is found on the Job view. What information that is displayed is dependent on what kind of service the job is. For message integrations you can for instance see the payload and destinations.

Figure 12. Job View

From Job Actions you can manage job.
Service View is accessed from service link.
Outbound and/or inbound payloads can be viewed from Payloads section.
For outbound jobs, transfers section displays transfer statuses for each destination.

3.5.2. View payload

The admin UI will only display payload having certain content-types. Moreover, payloads having a size larger than a certain threshold should never be displayed in the admin UI.

In addition, you can now also download the payload data from the TIF admin UI to your local computer.

These settings are defined within the ${TIF_HOME}/modules/enovia/etc/module.properties file and the particular settings controlling these behaviors are:

adminui.payload.sizeThresholdForDisplay=5KB
adminui.payload.displayableContentTypes=application/xml,text/xml,text/plain,text/csv,application/json
adminui.payload.allowDownload=true

adminui.payload.sizeThresholdForDisplay: If unit is omitted, bytes is the assumed size. Note that if set to a negative value, the size limitation is disabled. Allowed units are: b, bytes, k, kb, ki, kib, m, mb, mi, mib, g, gb, gi, gib.
adminui.payload.displayableContentTypes: Comma separated list of allowed content types.
adminui.payload.allowDownload: Whether or not to allow downloading the payload from the admin UI.

3.5.3. Job Actions

Depending on service type, there are one or more actions available to manage jobs.

Figure 13. Job Actions - Resend, Delete and Resolve

For outbound integrations it is possible to resend a job that is of type ENOVIA/3DExperience. This will create a new job, process it and transfers it to all destinations.
Job and its information may be deleted.
In case job is completed with errors, you may either Resolve or unresolve it.

There are some restrictions for the resend action:

The resend action is only available for outbound jobs of type ENOVIA/3DExperience. Other types of jobs are filtered out by the action.
If your TIF server uses an external database that is shared by multiple server instances, you cannot resend jobs by choosing a date range.

3.5.4. Abort Job

If job is awaiting reply, it can be aborted. This is useful in case of reply is never received. Aborting means job will be completed with error and message "Job aborted by admin".

Figure 14. Job Actions - Abort

3.5.5. Resolve Job

When a job is completed with errors, it might be useful to indicate when an administrator has taken care of it and error is resolved.

Once resolved, the job it is not visible in the list of errors in Dashboard. Also in Service View and in Jobs view jobs can be filtered by resolve status.

Figure 15. Resolved Jobs

It is possible to view only those jobs are unresolved by clicking on the toggle button.

3.5.6. Create Job

Usually jobs are triggered from the ENOVIA/3DExperience application, but it is also possible to create jobs manually from Admin UI. This is available in action menu of Jobs.

Figure 16. Create Job

Select what service to create jobs
Provide object ids. Multiple object ids are separated with commas (,). If no object id is provided, a confirmation dialog is displayed to verify the job is created without object id.

3.6. Statistics

In Statistics you can see a chart that displays job counts with selected criterias. You may include jobs from all or only from selected services.

When criteria is changed, the reload icon turns into orange to indicate reload is needed. Press the icon to apply changes and reload the statistics. You may also press the icon whenever to reload statistics.

Zoom buttons is used to adjust the time interval of the chart.

Figure 17. Statistics

You may also drill down into statistics by clicking on bar elements in the chart. Drill-down changes the date range of statistics according to the selection and opens a table containing jobs of the selected range.

When drill-down is active, selected criteria cannot be changed. You may reset the filter by clicking on the reset icon.

Filter reset icon
A chart bar that can be clicked
Table displaying jobs that matches with drill-down range

Figure 18. Statistics

3.7. Monitor

In Monitor view administrator can see Applications Events, monitor resources and start or stop service activators.

3.7.1. Application Events

In this view you can browse application events.

Figure 19. Application Events

The following can be done:

Applications Event details by clicking on table row.
Delete event from the list.
Delete all events.

3.7.2. Job Queues

This view displays an overview of Queue objects located in the ENOVIA/3DExperience database.

Figure 20. Job Queues

The view contains:

An icon to expand and view queue statistics and details.
Statistics that are grouped by job object state. A statistic number can be clicked to view jobs in the particular state.
Active listeners are displayed below statistics.
A listener can be started/stopped from the toggle icon.
Thread count of a listener can be adjusted.
Access thread information.

Thread count setting

In the popup, you may adjust the thread count value. In practice, the queue listener is assigned with the value and restarted if needed. This does not affect on jobs that are already being executed.

Figure 21. Thread Count

Job details

Jobs in a particular state can be viewed by clicking on a statistic number. The view displays job and source object information and job configuration. Each row in the table can be expanded to view details such as RPE and job parameters.

Figure 22. Job Details

Thread information

Thread information view provides detailed information about queue listener by showing associated threads and their states. The information includes thread id, state and stack trace.

Figure 23. Thread information

3.7.3. Resource Monitor

Resource monitor displays graphical presentation of recent resource consumption. Charts include CPU, JVM heap and ENOVIA/3DExperience memory usage. In addition, it is possible to configure one or more file system locations of which disk space is monitored.

Figure 24. Resource Monitor

Also see chapter Monitor configuration to learn how to enable disk space monitoring and/or change update interval of charts.

3.7.4. Service Activators

In this view you can see service activators.

To start or stop an activator, press toggle button that is shown on left of activator name.

Figure 25. Service Activators

3.7.5. Scheduler Jobs/Logs

This view will show the currently configured jobs being managed by the scheduler in TIF.

You will from this view be able to view the history from the last executions of a job including inactivate / activate jobs and trigger a new execution of a job.

You can maximum view the last 20 executions of a particular job.

Figure 26. Scheduled Jobs

3.7.6. System Thread Information

This view contains information about system threads. It can be used as an error monitoring tool.

Clicking a table row displays detailed information such as thread state and thread dump.

Thread dump can be also downloaded as a plain text file from Actions → Export.

Figure 27. System Thread Information

3.8. User Administration

User administration is reached from the "Internals→User Management" menu item:

Figure 28. User management

This will show a list of all administration users like below:

Figure 29. User list

The roles are shown with different colors, where Blue color indicates both "View" and "Edit" access while Green color indicates "View" access only.

Edit or create a user uses the same dialog:

Figure 30. Edit user dialog

Note that the user that creates or edits a user, can not assign the other user a role that the current user is not assigned (except the Job Data View role).

4. Configuration

The Admin UI contains features that can be configured in ${TIF_ROOT}/modules/enovia/etc/module.custom.properties.

Please see ${TIF_ROOT}/modules/enovia/etc/module.properties that contains detailed explanation for each property.

4.1. Monitor

Configurations introduced in this chapter apply to Monitor view.

4.1.1. Resource Charts

Reload delay of charts displayed in Monitor Resources view can be adjusted. See property adminui.resourceChart.reloadDelay.

For example:

adminui.resourceChart.reloadDelay = 5000

The value must be in milliseconds. The minimum delay is 5000ms.

4.1.2. Free Disk Space

In Monitor Resources view, free disk space can be monitored from one or more locations in the file system. See property adminui.resourceChart.diskSpace.path.

For example:

adminui.resourceChart.diskSpace.path = C:

The property is a list of paths from which disk space is monitored. Each path must point to an existing location in the file system.

4.1.3. Units

In Monitor Resources view, unit for measuring used JVM heap and ENOVIA/3DExperience memory and used disk space can be configured. See properties:

adminui.resourceChart.unit.memoryData
adminui.resourceChart.unit.enoviaData
adminui.resourceChart.unit.diskSpaceData

For example:

adminui.resourceChart.unit.memoryData = MB

Supported values for properties are: MB, GB or TB. Default is MB, if value is empty.

4.2. Maximum Number of Rows in Job Table Export

When table contents are exported, the maximum number of rows is limited. See properties:

adminapi.export.csv.maxRows
adminapi.export.pdf.maxRows

4.3. Log settings

Configurations introduced in this chapter applies to the Log Settings view.

4.3.1. Runtime Log Levels

You may configure the list of features that appears in the Log Settings view. Runtime log level for these features can be adjusted from that view.

A feature can be added to the list by introducing new property in the following format:

logPackages.FEATURENAME=a.b.c, d.e.f

Property name must contain prefix logPackages.FEATURENAME., where FEATURENAME is a unique name for the feature. Property value is a comma separated list of package name(s) that belong to the feature. In this example, level change of feature FEATURENAME would affect classes that belong to package "a.b.c" or "d.e.f".

4.4. Configuration Editor

The configuration editor can be accessed from the "Configuration" menu.

With the editor you may read and modify configuration files that are accessible by TIF, typically located under ${TIF_ROOT}/modules/enovia/cfg and webapp folders.

Figure 31. Configuration Editor

Overview:

Namespace selector.
Tree view lists files found from selected namespace. The files are grouped by resource type.
File name tab panel displays opened files.
Editor view displays the contents of opened file.
Context menu that be accessed by right clicking on file or folder.

The editor has some restictions:

For security reasons, files that are located outside the folder ${TIF_ROOT}/modules/enovia/cfg cannot be deleted or renamed and can be viewed only in read-only mode. This is indicated with a lock symbol in file name tab panel.
New files are always created in a sub folder under ${TIF_ROOT}/modules/enovia/cfg according to the selected type and namespace.

4.4.1. Create Namespace

New namespace can be created by typing name into the namespace selector field and pressing "Create …" action below the selector.

To avoid creating possibly unnecessary empty folders, a folder for new namespace is created under ${TIF_ROOT}/modules/enovia/cfg only after the first resource (of any type) is added. If you create namespace but do not add any resources, the namespace disappears from the namespace selector list if you reload the editor.

Figure 32. Create namespace

4.4.2. Save File

To save a file, use Ctrl+S keyboard combination.

4.4.3. Add, Delete, Rename file

Add, delete and rename actions are available in the context menu.

To rename or add new file, enter the file name (suffix is appended automatically) and press Enter keyboard key.

Figure 33. Add New File

Directories cannot be modified or added.

4.5. Using Admin UI with Proxy Server or Load Balancer

In cases when you have a proxy server, you might need to configure Admin UI web application to be aware of this in order to return correct information on the HttpServletRequest class; otherwise the URLs that are generated will not point correctly.

The proxy server typically passes the correct values behind the request headers:

X-Forwarded-Host
X-Forwarded-Port
X-Forwarded-Proto

Admin UI web application has a servlet filter enabled by default that will honor the values set there. If no such header is present, the filter will fall back to the default value obtained via the HttpServletRequest API.

If needed, request headers can be defined in ${TIF_ROOT}/modules/enovia/etc/module.custom.properties:

adminui.lbfilter.host=X-Forwarded-Host
adminui.lbfilter.port=X-Forwarded-Port
adminui.lbfilter.scheme=X-Forwarded-Proto

4.6. Multiple TIF Server Instances with Shared External Database

Sharing an external database with multiple TIF server instances allows you to work with the same data regardless which TIF Admin UI instance you log in to. This set-up however requires some configuration in ${TIF_ROOT}/modules/enovia/etc/module.custom.properties to allow the web browser to submit cross-site requests and let Admin UI communicate with remote server instances via their Admin REST API. Cross-site requests allow accessing payload data that is persisted locally in a server outside the database.

This example configuration allows cross-site requests to this server from any Admin UI webapp:

adminapi.corsFilter.enabled = true
adminapi.corsFilter.allowedOrigin.value = *

Other option is to only allow requests from specific origins:

adminapi.corsFilter.enabled = true
adminapi.corsFilter.allowedOrigin.list = http://allowedhost:8181;\
    http*://secondallowedhost:*

The above example only allows requests to this server from Admin UI instances that are accessed via URL http://allowedhost:8181 or http*://secondallowedhost:*. Notice that the latter URL contains wildcards that allow e.g. both HTTP and HTTPS protocol, and any port number.

Please see ${TIF_ROOT}/modules/enovia/etc/module.properties for further documentation.

TIF Administration and Configuration Guide - Admin UI

1. Overview

1.1. User Accounts

1.2. Supported Browsers

1.3. REST API

2. Search Indexer

2.1. Query Mode

2.2. Re Indexing

3. Navigation

3.1. User Roles

3.2. Login

3.3. Dashboard

3.4. Services

3.4.1. View Service

3.4.2. Delete Service and Jobs

3.4.3. Service Settings

3.5. Jobs

3.5.1. View Job

3.5.2. View payload

3.5.3. Job Actions

3.5.4. Abort Job

3.5.5. Resolve Job

3.5.6. Create Job

3.6. Statistics

3.7. Monitor

3.7.1. Application Events

3.7.2. Job Queues

3.7.3. Resource Monitor

3.7.4. Service Activators

3.7.5. Scheduler Jobs/Logs

3.7.6. System Thread Information

3.8. User Administration

4. Configuration

4.1. Monitor

4.1.1. Resource Charts

4.1.2. Free Disk Space

4.1.3. Units

4.2. Maximum Number of Rows in Job Table Export

4.3. Log settings

4.3.1. Runtime Log Levels

4.4. Configuration Editor

4.4.1. Create Namespace

4.4.2. Save File

4.4.3. Add, Delete, Rename file

4.5. Using Admin UI with Proxy Server or Load Balancer

4.6. Multiple TIF Server Instances with Shared External Database