Page History
Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Published by Scroll Versions from space WINSTALLATION and version 7
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. | | ||||||
| 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. |
| |||||||
rdbms
| 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. | 3306 | |||||||
| 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 (SQL Server) | host | String | The host providing the analytical database. | |||||||
| port | Number | The port of the analytical database. | 14331433 (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 | |||||||
| domain | String | Domain of the user. Remove this property if you want to use SQL authentication. | ||||||||
requestTimeout | Number | Timeout for database requests in milliseconds. Default of 0 disables the timeout. | 0 | |||||||
| 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. |
| ||||||
| cronPattern | String | Defines the execution interval of the scheduler. |
| |||||||
| api | Object | Contains the reference for the REST API of the TrxLogsETL. Details see below. | ||||||||
| api | protocol | String | The protocol of the REST API. |
| ||||||
| hostname | String | The host name of the REST API. |
| |||||||
| port | String | The port of the REST API. |
|
analytics-collector-service
| Setting | Type | Description | Default | ||
|---|---|---|---|---|---|
| analytics-collector-service | intervalLoadServices | Number | Define the caching interval for the services list in the Scheer PAS Administration. |
| |
| 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. |
| |
| settings.path | String | Specifies the path of the work directory. |
| ||
| consoles | name | String | Defines the name of the BRIDGE node to collect log files from. |
| |
| dataDirectory | String | Defines the data directory of the BRIDGE node to collect log files from. |
| ||
| collectorScheduler | enable | Boolean | Turns the collection scheduler on or off. |
| |
| cronPattern | String | Defines when to schedule the log collection.
|
| ||
| 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. |
|
| settings.path | String | Specifies the path of the work directory. |
| |
| rdbms | 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 settings of analytics-api-service. |
bpaas-cockpit
| 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. | pas |
bpaas-cockpit-service
| Setting | Type | Description | Default | |
|---|---|---|---|---|
| bpaas-cockpit-service | requiredServices | Object | Specify the services required by the bpaas-cockpit-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.
Overview
Content Tools