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. Further information can be found on page Administrator Login.

Mandatory Settings

You have to adapt the following settings:

file-storage

	Setting	Type	Description	Default
file-storage
files	destination	String	Directory containing stored files.

mailer-service

	Setting	Type	Description	Default
mailer-service
	sender	String	The sender of sent mails.	`Scheer PAS<pas@your-organization.com>`
	replyTo	String	The reply-To field of sent mails.	`noreply@your-organization.com`
	trustedDomains	String[]	Whitelist of domains the mailer-service is allowed to send mails to.	`["your-organization.com"]`
	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.	`25` or `465`
	host	String	The hostname or IP of the SMTP server.	`localhost`
	secure	Boolean	Indicates if SSL is to be used.	`false`
	ignoreTLS	Boolean	Ignore server support for STARTTLS.	`false`
	requireTLS	Boolean	Forces the mailer-service to use STARTTLS.	`false`
	name	String	The name of the SMTP client.	Hostname or IP address of machine running mailer-service.
	lmtp	Boolean	Forces usage of LMTP.	`false`
	auth	Object	Authentication credentials for mail sending server. Details see below.
auth	user	String	User to authenticate.
auth	pass	String	Password to authenticate.

persistence-service

	Setting	Type	Description	Default
persistence-service
mongoDB	hostname	String	The host providing the MongoDB installation.	`mongohost`
mongoDB	port	Number	The port of the MongoDB installation.	`27017`

service-repository

	Setting	Type	Description	Default
service-repository
	mongoDbUrl	String	The URL of the database caching the service configurations maintained by the service-repository.	`mongodb://localhost:27017/one-platform`

authenticator-service

The UI component of Scheer PAS Process Analytics 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 E2E 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.	`3443`
ssl	key	String	Path to the SSL private key.	`/opt/e2e_bridge_data/proxies/conf/<node instance name>_key.pem`
ssl	cert	String	Path to the SSL certificate.	`/opt/e2e_bridge_data/proxies/conf/<node instance name>_cert.pem`

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.	`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.	`{}`

authenticator-service

	Setting	Type	Description	Default
server
	publicAccess	Number		`3080`
	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.
app
	favicon	String	Path to the favicon for Login Page.	`/app/favicon.ico`
	whitelist	Object	List with paths which don't need specific permissions for access.	`{"/favicon.ico":null,` `"/manifest.json":null}`
	auth	Object	Route settings for authentication.	`{"route":"/auth",` `"static":"/app/auth"}`
	error	Object	Route settings for errors.	`{"route":""/error",` `"static":"/app/error"}`
	token	Object	Route settings for authentication via route.	`{"route":"/token"}`
	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.	`{"limit":"50mb"}`
pwforgotten
	route	String	Route for Reset Password feature.	`*pwd/`
	expiresInMinutes	Number	The duration in minutes a password forgotten token is valid.	`15`
	app	String	The route of the userself-app.
	page	String	The hash suffix to use for password reset mail links.	`/#/password-reset`
io
	transports	String[ ]		[websocket, polling]
auth
	algorithm	String	Algorithm used to generate the secret key for user tokens.	HS512
	expiresInMinutes	Number	Session expiration time.	`240`
services
<tenant>		String	The tenant name.	`e2e`
	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: The key is the client route (e.g. app/user-admin) The value is an object holding the specific settings. Details see below.
userService	url	String	The URL to the user-service.	`ws://localhost:3008`
userSelfService	url	String	The URL to the userself-service.	`ws://localhost:4002`
services <route>	target	String	The URL to the service handling the requests from this route.
services <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. `rewrites: {base: "href"}` leads to `<base href="/<tenant>/<route>">` in the HTML markup of the app.

file-storage

	Setting	Type	Description	Default
file-storage
	requiredServices	Object	Specify the services required by the file-storage.	`persistence-service`
	port	String	The port of this service.	`3004`
	files	Object	Details see below.
files	route	String	Path of the file-storage upload API.	`/upload`
	mediumSize	Number	Scale factor for medium size image.	`0.5`
	smallSize	Number	Scale factor for small size image.	`0.25`

mailer-service

	Setting	Type	Description	Default
mailer-service
	requiredServices	Object	Specify the services required by the mailer-service.	`file-storage`
	port	String	The port of this service.	`3013`
	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.
passwordForgottenTokenMail	subject	String	The subject of this template.	`Request: Forgot Password`
passwordForgottenTokenMail	html	String	The HTML content of this template.	`The password for the following account is lost: <br/> Name: #login <br/><br/><br/>Please follow the link and change your password.<br> The link expires after #expiretime minutes.<br> #link`
passwordForgottenRequest	subject	String	The subject of this template.	`Request: Forgot Password`
passwordForgottenRequest	html	String	The HTML content of this template.	`The password for the following account is lost: <br/> Name: #login <br/>System: #system <br/><br/>Please reset the password and inform the user.`
defaultTemplate	subject	String	The subject of this template.	`#subject`
defaultTemplate	html	String	The HTML content of this template.	`#content`

persistence-service

	Setting	Type	Description	Default
persistence-service
	requiredServices	Object	Specify the services required by the persistence-service.	`none`
	port	String	The port of this service.	`3001`
	maxResults	Number	Maximum number of documents returned.	`1000000`
	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.	`one-platform`
	engine	String	The engine name of this connection.	`mongoDB`
	params	String	Connection parameters to use when connecting the user database.	`?bufferMaxEntries=10&poolSize=100`
engineMapping	objectType		The collection name that maps to the engine entry.	`logType`
	engine		Key for the engine definition that holds connection details.	mongoDB_logs
	collection		For Scheer BPaaS use only: The collection name without database definition.	`bpaasLogs`
<engines>		Object[]	Engines with connection details to be used in the engineMapping.	`"mongoDB_logs": {` `"hostname": "localhost", "port": 27017, "engine": "mongoDB", "database": "logs" }`
	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.	`none`
	port	String	The port of this service.	`3017`
	jsDoc	Object	Details see below.
jsDoc	route	String		`/jsdoc`
jsDoc	destination	String

user-service

	Setting	Type	Description	Default
user-service
	requiredServices	Object	Specify the services required by the user-service.	`persistence-service, mailer-service, file-storage`
	port	String	The port of this service.	`3008`
	validation	Object	Details see below.
	bpaasSystem	Boolean	Specifies if the system managed by this user-service is a Scheer BPaaS installation.	`false`
	exportConfig	Object	Details see below.
validation	password	String	Specify a regular expression, a given user password has to match.	`^(?=[^\\d_].*?\\d)\\w(\\w\|[!@#$%]){7,42}$`
validation	loginId	String	Specify a regular expression, a given user name has to match.	^([\\w\\.\\-_!])+$\|^(?:[a-z0-9!#$%&+/=?^_`{\|}~-]+(?:\\.[a-z0-9!#$%&+\/=?^_`{\|}~-]+)\|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]\|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])\")@(?:(?:[a-z0-9](?:[a-z0-9-][a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-][a-z0-9])?\|\\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]\|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])$
exportConfig	template	String	The name of the file used as template for exports.	`adminAppExport.xlsx`
	namespace	String	Namespace grouping the exported files in the file-storage service.	`userExports`
	replaceKey	String	Placeholder in the template that is replaced by the exported data.	`StartDataHere`

/app/userself-app

On this Page:

Related Pages:

Process Analytics Guide

Related Documentation:

E2E Documentation
- Node.js Service Settings
- Managing the E2E Bridge Certificate

Space shortcuts

Page tree

Mandatory Settings

file-storage

mailer-service

persistence-service

service-repository

authenticator-service

Optional Settings

Settings Applicable for all Services

authenticator-service

file-storage

mailer-service

persistence-service

service-repository

user-service

Space shortcuts

Page tree

Configuring the Platform Services

Mandatory Settings

file-storage

mailer-service

persistence-service

service-repository

authenticator-service

Optional Settings

Settings Applicable for all Services

authenticator-service

file-storage

mailer-service

persistence-service

service-repository

user-service