Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Adapting the Global Settings
The Process Mining services need some settings on the Scheer PAS BRIDGE to match your configuration. If you have deployed the services for the first time, some setting variables will be created. The variables will be empty, you will have to configure them.
Figure: Global Bridge Settings Used by the Process Mining Services
Image Removed
All these values appear in red (undefined), because they are not configured yet. You need to configure them now. If you need more information on global settings and their usage, refer to the BRIDGE Documentation > Using Global Setting Variables.
Change these settings to the following:
E2E_Dashboards_AnalyticDB_ConnectionString
<name of your database>
E2E_Dashboards_AnalyticDB_Password
<password of your database user>
E2E_Dashboards_AnalyticDB_Type
MySQL, Oracle, SQLServer
E2E_Dashboards_AnalyticDB_User
<your database user>
C:\DashboardWorkDirectory
Info |
---|
If you want to change the work directory (to FTP or SFTP), refer to the page Changing the Work Directory. |
Once you click Apply, these values will be applied to the Process Mining services that are using the setting variables. The settings you updated will not be displayed as undefined anymore.
Configuring the Data Collection Services
Setting up the TrxLogsCollector
The TrxLogsCollector can be configured via the settings of the service and a user interface. For more information on how to change the settings of a service, refer to the BRIDGE Documentation > xUML Service Settings.
The TrxLogsCollector will collect logs from services deployed there. You can configure the services you want to inspect with Process Mining with the services UI.
${server_hostname}
Specify the number of days the collector should go back in time, when a collect is done.
This setting also defines the number of days that will be collected at first run.
0
(Collect today's logs only at first. Then collect all past logs.)
Any integer.
(Collect only the log files of the past number of days.)
FileSystem
, FTP
, SFTP
FileSystem
Scheduler Settings
In the Scheduler Service settings of TrxLogsCollector, you can switch the scheduler triggering the data collection on and off, and change the execution interval of the scheduler. Default execution interval is once per hour.
If you need more information on the scheduler date time patterns, refer to the BRIDGE Documentation > Date Time Patterns.
Info |
---|
For more information on how to maintain the TrxLogsCollector Service UI, refer to page Adding new xUML Services to Process Mining. |
Setting up the TrxLogsETL
The TrxLogsETL can be configured via the settings of the service. For more information on how to change the settings of a service, refer to the BRIDGE Documentation > xUML Service Settings.
Supply the upload method: Bulk Upload or Upload via Inserts.
Bulk upload is faster and recommended for large amounts of data. Please note the restrictions in the notes below and also refer to Setting up the Database for Process Mining.
Note |
---|
Never use a transaction log level deeper than Service on the TrxLogsETL service (default: none), if you use Upload via Inserts! TrxLogsETL then will create a log entry for each insert and you may reach the maximum file size doing that. |
Note |
---|
Bulk Upload does not work with MySQL. |
{{E2E_Dashboards_WorkDirectory_FileSystem_Path}}
FileSystem
, FTP
, SFTP
FileSystem
Configuring the Node.js Services
You can use the default settings of the Node.js services. Only make sure that the rdbms setting of the analytics-api-service and analytics-etl-service corresponds to the analytical database.
Further configuration of the services is not necessary, but possible. You can configure the Node.js services via the Settings tab in the detail view of each service. The configuration is provided as a JSON object.
Settings Applicable for all Services
Setting | Type | Description | Default | |
---|---|---|---|---|
service-repository | hostname | String | The host providing the service-repository. | localhost |
port | String | The port of the service-repository. | 3017 | |
protocol | String | The protocol of the service-repository. | ws | |
reconnection | Boolean | Specify, if this service shall try to reconnect the service-repository in case of connectivity loss. | true | |
requiredServices | Object | Specify the services required by the service-repository. | {} | |
<service name> | hostname | String | The host providing this service. | localhost |
port | String | The port of this service. | ||
protocol | String | The protocol of this service. | ws | |
requiredServices | String | Specify the services required by this service. | {} |
analytics-api-service
Setting | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
analytics-api-service
| requiredServices | Object | Specify the services required by the analytics-api-service. |
bpaas-cockpit-service, user-service
| |||
port | String | The port of this service. | 3041 |
rdbms | Object | Specify the connection to the analytical database. |
Details see below. | |||
deletionScheduler | Object | Enable the scheduler to delete data. Details see below. | |
intervalLoadProcesses | Number | Define the caching interval for the process list in the Scheer PAS Administration. | 60 |
3040
http
rdbms
rdbms
|
---|
localhost
|
---|
vendor | String | The RDBMS of the analytical database to connect to. Must be one of mssql, mysql or oracle. | ||
connection | Object | The connection details of the analytical database. Details see below (please note that the available options depend on the RDBMS of the analytical database). | ||
connection (Microsoft SQL Server, MySQL) | host | String | The host providing the analytical database. | |
---|---|---|---|---|
port | Number | The port of the analytical database. | 1433 (Microsoft SQL Server) 3306 (MySQL) | |
database | String | The database/scheme of the analytical database. | ||
user | String | The user giving Process Mining access to the analytical database. | ||
password | String | The password of the user accessing the analytical database. | ||
connectionLimit | Number | The maximum number of connections to the analytical database to be opened at the same time. | 10 | |
connection (Oracle) | connectString | String | The Oracle connect string to the analytical database. | |
user | String | The user giving Process Mining access to the analytical database. | ||
password | String | The password of the user accessing the analytical database. | ||
connectionLimit | Number | The maximum number of connections to the analytical database to be opened at the same time. | 10 | |
deletionScheduler | enable | Boolean | Enable or disable the scheduler. | true |
cronPattern | String | Defines the execution interval of the scheduler. | 0 1 * * 6 | |
api | Object | Contains the reference for the REST API of the TrxLogsETL. Details see below. | ||
api | protocol | String | The protocol of the REST API. | http |
hostname | String | The host name of the REST API. | localhost | |
port | String | The port of the REST API. | 3043 |
analytics-collector-
cockpitservice
Setting | Type | Description | Default |
---|
analytics-collector-service | intervalLoadServices | Number | Define the caching interval for the services list in the Scheer PAS Administration. | 60 | |
---|---|---|---|---|---|
dataTarget | Object | Specifies the work directory from which the analytics-etl-service picks the collected log files. Details see below. | |||
consoles | Array of objects | Specifies the BRIDGES to collect transaction logs from. Details see below. | |||
collectorScheduler | Object | Sets up the collection scheduler. Details see below. | |||
services | Array of objects | Specifies further Node.js services to collect transaction logs from. Details see below. | |||
dataTarget | type | String | Specifies the type of the work directory. Currently only filesystem is available. | filesystem | |
settings.path | String | Specifies the path of the work directory. | /opt/e2e_bridge_data/adb_workdir | ||
consoles | name | String | Defines the name of the BRIDGE node to collect log files from. | localhost | |
dataDirectory | String | Defines the data directory of the BRIDGE node to collect log files from. | /opt/e2e_bridge_data | ||
collectorScheduler | enable | Boolean | Turns the collection scheduler on or off. | true | |
cronPattern | String | Defines when to schedule the log collection.
| 0 * * * * | ||
services | name | String | Specifies the service name. | ||
namespace | String | Specifies the namespace of the service. Recommended is to use the host name. | |||
runtime | String | Specifies the runtime of the service. Currently available are nodejs and xuml . | |||
logsDirectory | String | Specifies the file system pointing to the transaction logs of the service. |
analytics-etl-service
Setting | Type | Description | Default | |
---|---|---|---|---|
analytics-etl-service | datasource | Object | Specifies the work directory from which the analytics-etl-service picks the collected log files. Details see below. | |
rdbms | Object | Specify the connection to the analytical database. Details see below. | ||
datasource | type | String | Specifies the type of the work directory. Currently only filesystem is available. | filesystem |
settings.path | String | Specifies the path of the work directory. | /opt/e2e_bridge_data/adb_workdir | |
rdbms | vendor | String | The RDBMS of the analytical database to connect to. Must be one of mssql, mysql or oracle. | mysql |
connection | Object | The connection details of the analytical database. Details see settings of analytics-api-service. |
bpaas-cockpit
bpaas-cockpit-service, user-service, analytics-api-service
Setting | Type | Description | Default | |
---|---|---|---|---|
bpaas-cockpit | requiredServices | Object | Specify the services required by the bpaas-cockpit. |
|
port | String | The port of this service. | 3005 |
app | Object | Define app-specific settings. Details see below. | |
app | branding | String | Set the branding of the bpaas-cockpit. |
---|
e2e
pas |
bpaas-cockpit-service
Setting | Type | Description | Default | |
---|---|---|---|---|
bpaas-cockpit-service | requiredServices | Object | Specify the services required by the bpaas-cockpit-service. |
user-service, persistence-service
| |||
port | String | The port of this service. | 3021 |
roleMapping | Object | Define the mapping of profile names (object keys) to role names (values for the object keys). | |
userExtensions | Object | Contains predefined settings for each user. | |
defaultGroup | Object | Define the default group which is added to the cockpit of each user on first login. |
Now that you have installed and set-up all components of Scheer PAS Process Mining, you can start the services.