Configuring the Platform Services
Most of the settings can be used as delivered. However, it is necessary to configure some of the settings before you are able to use the platform services. The services are configured via the Settings tab in the detail view of each Node.js service. The configuration is provided as a JSON object.
Once you have configured the necessary settings, the URL for your Scheer PAS Administration is composed as follows: https://scheer-solutions.com:3443/auth/e2e/app/admin
The login credentials for the default admin user are
Login: platform.admin
Password: Sch33rBP44$
Important Note
Change the password of the default admin user during your first login in the Scheer PAS Administration. Go to the Administration Guide > Administrating Users for further information.
Mandatory Settings
You have to adapt the following settings:
file-storage
Setting | Type | Description | Default | |
---|---|---|---|---|
files | destination | String | Directory containing stored files. |
mailer-service
Setting | Type | Description | Default | |
---|---|---|---|---|
mailer-service | sender | String | The sender of sent mails. |
|
replyTo | String | The reply-To field of sent mails. |
| |
trustedDomains | String[] | Whitelist of domains the mailer-service is allowed to send mails to. |
| |
transport | Object | Connection details of the mail sending server. Details see below. |
| |
transport | Mails are sent by Nodemailers SMTP transport module. The options defined in section transport are forwarded to that module. Further options can be looked up in the Nodemailer SMTP transport documentation. | |||
port | Number | The port of the SMTP server. |
| |
host | String | The hostname or IP of the SMTP server. |
| |
secure | Boolean | Indicates if SSL is to be used. |
| |
ignoreTLS | Boolean | Ignore server support for STARTTLS. |
| |
requireTLS | Boolean | Forces the mailer-service to use STARTTLS. |
| |
name | String | The name of the SMTP client. | Hostname or IP address of machine running mailer-service. | |
lmtp | Boolean | Forces usage of LMTP. |
| |
auth | Object | Authentication credentials for mail sending server. Details see below. | ||
auth | user | String | User to authenticate. | |
pass | String | Password to authenticate. |
service-repository
Setting | Type | Description | Default | |
---|---|---|---|---|
service-repository | mongoDbUrl | String | The URL of the database caching the service configurations maintained by the service-repository. |
|
authenticator-service
The UI component of Scheer PAS Process Mining uses SSL for the client-server communication. All the client-server communication is handled by the authenticator-service. Therefore, the authenticator-service needs an SSL certificate and its private key. Using the Bridge, it is possible to manage the Bridge Certificate (for more information about the Bridge Certificate see BRIDGE Documentation > Managing the E2E Bridge Certificate). We recommend to use that certificate in the authenticator-service configuration.
Setting | Type | Description | Default | |
---|---|---|---|---|
server | port | Number | The port providing access to all configured services and apps. |
|
ssl | key | String | Path to the SSL private key. |
|
cert | String | Path to the SSL certificate. |
|
Optional Settings
You may change the settings listed below, if you wish to adapt them to your environment:
Settings Applicable for all Services
Setting | Type | Description | Default | |
---|---|---|---|---|
service-repository | hostname | String | The host providing the service-repository. |
|
port | String | The port of the service-repository. |
| |
protocol | String | The protocol of the service-repository. |
| |
reconnection | Boolean | Specify, if this service shall try to reconnect the service-repository in case of connectivity loss. |
| |
requiredServices | Object | Specify the services required by the service-repository. |
| |
<service name> | hostname | String | The host providing this service. |
|
port | String | The port of this service. | ||
protocol | String | The protocol of this service. |
| |
requiredServices | String | Specify the services required by this service. |
|
authenticator-service
Setting | Type | Description | Default | |
---|---|---|---|---|
server | publicAccess | Number |
| |
ssl | Object | Paths to the SSL files. Details see below. | ||
ssl | ca | String | Path to the certificate of the certificate authority. | |
redis | host | String | The host name of the Session Storage. | |
port | Number | The port of the Session Storage. | ||
password | String | |||
app | favicon | String | Path to the favicon for Login Page. |
|
whitelist | Object | List with paths which don't need specific permissions for access. |
| |
auth | Object | Route settings for authentication. |
| |
error | Object | Route settings for errors. |
| |
token | Object | Route settings for authentication via route. |
| |
bodyparser | Object | Settings for the JSON body parser. Details see below. | ||
pwforgotten | Object | Settings for the Reset Password feature. Details see below. | ||
bodyparser | json | Object | Bodyparser settings. |
|
pwforgotten | route | String | Route for Reset Password feature. |
|
expiresInMinutes | Number | The duration in minutes a password forgotten token is valid. |
| |
app | String | The route of the userself-app. | ||
page | String | The hash suffix to use for password reset mail links. |
| |
io | transports | String[ ] |
| |
auth | algorithm | String | Algorithm used to generate the secret key for user tokens. |
|
expiresInMinutes | Number | Session expiration time. |
| |
services | tenant | String | The tenant name. |
|
userService | Object | Details see below. | ||
userSelfService | Object | Details see below. | ||
whitelist | String[] | List with paths not needing specific permissions for access. | ||
services | Object | Defines a mapping of client routes to the corresponding services:
Details see below. | ||
userService | url | String | The URL to the user-service. |
|
userSelfService | url | String | The URL to the userself-service. |
|
services <route> | target | String | The URL to the service handling the requests from this route. | |
rewrites | Object | A key-value mapping defining the HTML tags (keys) and HTML attributes (value), where the route part of the app URL is to be set. E. g. |
file-storage
Setting | Type | Description | Default | |
---|---|---|---|---|
file-storage | requiredServices | Object | Specify the services required by the file-storage. | |
port | String | The port of this service. |
| |
files | Object | Details see below. | ||
files | route | String | Path of the file-storage upload API. |
|
mediumSize | Number | Scale factor for medium size image. |
| |
smallSize | Number | Scale factor for small size image. |
|
mailer-service
Setting | Type | Description | Default | |
---|---|---|---|---|
mailer-service | requiredServices | Object | Specify the services required by the mailer-service. | |
port | String | The port of this service. |
| |
paramPrefix | String | Prefix introducing variables in the templates. |
| |
templates | Object | Specify the e-mail templates. Details see below. | ||
templates | passwordForgottenTokenMail | Object | Define settings regarding mails sent to users allowing them to reset their password. Details see below. | |
passwordForgottenRequest | Object | Define settings regarding mails sent to the system administrator to reset an account password. Details see below. | ||
defaultTemplate | Object | Details see below. | ||
userDeactivated | Object | Define settings regarding mails sent to administrators once a user locked his account. Details see below. | ||
passwordForgottenTokenMail | subject | String | The subject of this template. | |
html | String | The HTML content of this template. | | |
passwordForgottenRequest | subject | String | The subject of this template. | |
html | String | The HTML content of this template. | | |
defaultTemplate | subject | String | The subject of this template. |
|
html | String | The HTML content of this template. |
| |
userDeactivated | subject | String | The subject of this template. |
|
html | String | The HTML content of this template. |
|
persistence-service
Setting | Type | Description | Default | |
---|---|---|---|---|
persistence-service | requiredServices | Object | Specify the services required by the persistence-service. | |
port | String | The port of this service. |
| |
maxResults | Number | Maximum number of documents returned. |
| |
mongoDB | Object | Details see below. | ||
engineMapping | Object[] | Details see below. | ||
<engines> | Details see below. | |||
mongoDB | database | String | The database storing the collections of the user database. Should not be changed. |
|
hostname | String | The host providing the MongoDB installation. |
| |
port | Number | The port of the MongoDB installation. |
| |
engine | String | The engine name of this connection. |
| |
params | String | Connection parameters to use when connecting the user database. |
| |
engineMapping | objectType | The collection name that maps to the engine entry. |
| |
engine | Key for the engine definition that holds connection details. |
| ||
collection | For BPaaS use only: The collection name without database definition. |
| ||
<engines> | Object[] | Engines with connection details to be used in the engineMapping. |
| |
hostname | String | The host providing the engine. | ||
port | Number | The port of the engine. | ||
engine | String | The key of the engine. | ||
database | String | The database storing the collections of the engine. |
service-repository
Setting | Type | Description | Default | |
---|---|---|---|---|
service-repository | requiredServices | Object | Specify the services required by the service-repository. | |
port | String | The port of this service. |
| |
jsDoc | Object | Details see below. | ||
jsDoc | route | String |
| |
destination | String |
user-service
Setting | Type | Description | Default | |
---|---|---|---|---|
user-service | requiredServices | Object | Specify the services required by the user-service. | |
port | String | The port of this service. |
| |
validation | Object | Details see below. | ||
bpaasSystem | Boolean | Specifies if the system managed by this user-service is a BPaaS installation. |
| |
exportConfig | Object | Details see below. | ||
validation | password | String | Specify a regular expression, a given user password has to match. |
|
loginId | String | Specify a regular expression, a given user name has to match. |
| |
exportConfig | template | String | The name of the file used as template for exports. |
|
namespace | String | Namespace grouping the exported files in the file-storage service. |
| |
replaceKey | String | Placeholder in the template that is replaced by the exported data. |
|
Related Pages:
Related Documentation: