Parameters

In the Parameters tab of the System Administration application, you can change the following types of parameters. For each Parameter, you see the Parameter name and its value and it is also possible to restore the default value, by clicking the Restore Defaults, , button.

Please note that all of the parameters are not available and used for the Queue Agent Profiles.

General Parameters

Agent Parameters

HTTPS Parameters

Parameter	Description	Default value
Certificate and KeyStore Settings	For more information, see “Secure Communication” .
(Re)generate certificate	Enabling this check box and saving the parameter list will cause the certificate to be generated in the key store. If a certificate with the same alias already exists, it will be overwritten, so be careful!
KeyStore alias	The alias of the certificate key entry, in key store.	orchestra
Distinguished name	The distinguished name of the certificate. The first (CN) section is the host name of the server and the subsequent sections describe the organization.	CN=localhost,OU=orgUnit, O=org, L=city, S=state, C=countryCode
Subject alternate name	This field needs to be set to both IP address and host name of the server if both are going to be used for HTTPS communication. Separate each entry with a comma. Example: myhost.com, 10.0.10.0.	localhost
HTTPS server settings	For more information, see “Secure Communication” .
HTTPS enabled	Controls whether HTTPS should be enabled or not in JBoss/Wildfly. Requires an Orchestra restart to take effect.	disabled
KeyStore alias	Determines which key entry in the key store to use as a server certificate.
HTTPS port	Decides which port to use for HTTPS communication.	8443
Central WebSocket Server Settings	Settings connected to the Central Websocket server, heartbeat, etc.
WebSocket enabled	If this check box is checked, Web socket communication over unencrypted channels is allowed. WARNING! Disabling this will cause any distributed Queue Agent connected over unencrypted WebSocket to stop functioning!	Enabled
WebSocket port	The port to use for unencrypted WebSocket communication. WARNING! Changing this will cause any distributed Queue Agent connected over unencrypted WebSockets to stop functioning, until they are re-configured!	8787
Secure WebSocket enabled	Enabling this parameter will cause the WebSocket server on Central to support WebSocket secure. Make sure that the certificate setting is properly configured. WARNING! Disabling this setting will cause any Queue Agents that are currently connected using secure WebSocket to stop functioning!	Disabled
Secure WebSocket port	The port to use for secure WebSocket communication. WARNING! Changing this parameter will cause any Queueu Agents that are currently connected using secure WebSocket to stop functioning, until they are re-configured!	9150
Netty worker thread pool size	The number of worker threads available to handle web socket traffic. Minimum 5, maximum 1000.	100
Init commands thread pool size	The number of threads available to handle init commands from the Queue Agents. Minimum 1, maximum 500.	5
Non-init commands thread pool size	The number of threads available to handle all non-init commands from the Queue Agents. Minimum 1, maximum 500.	5
Event thread pool size	The number of threads available to handle events from the Queue Agents. Minimum 1, maximum 500.	5
Command pool size	The number of threads tasked with notification of results to commands. Minimum 5, maximum 1000.	20
Command timeout (milliseconds)	The time in milliseconds to wait for a response from a command sent to a Queue Agent. Minimum 500, maximum180000.	60000
Client connection timeout (milliseconds)	The time, in milliseconds, to wait before a connection to a Queue Agent is considered lost. Minimum 1000, maximum 600000.	120000
Heartbeat interval (milliseconds)	The maximum time, in milliseconds, before a heartbeat message is sent to a Queue Agent if nothing else is sent. Minimum 5000, maximum 120000.	30000
Enable IP-address filtering	This check box determines whether the web socket server should only allow connections from certain IP-addresses. If enabled, only addresses specified in the definition clause, below, will be allowed to connect.	Not enabled
Allowed IP-addresses	A comma-separated list of allowed IP-addresses. Wildcards are allowed. Localhost (127.0.0.1) is always allowed. Example: 192.168.2.2*,192.168.1.100 will allow 192.168.2.2, a range from 192.168.2.20 to 192.168.2.29, a range from 192.168.2.200 to 192.168.2.255, 192.168.1.100 as well as 127.0.0.1.
Send extended heartbeat message	If this check box is checked, timestamps are included in the heartbeat message. This is combined with trace logging both centrally and on selected Queue Agent(s) that have the agent.conf property central.websocket.heartbeat.extended set to true.	Not enabled
Delay start of web socket server (seconds)	Increasing this value will delay the start of the web socket server and prevent any Queue Agent connections, until the web socket server is started. This can, for example, be used for a central system with many distributed Queue Agents.	0

Application Parameters

Parameter	Description	Default value
Appointment Management Settings	Parameters regarding Appointment management.
Delete appointments where endtime passed by (days)	Applicable to Central. Number of days that should pass, since the end time of an appointment, before that appointment is deleted.	1
Delete appointments at (hh:mm)	Applicable to Central. Time when appointments are deleted.	02:00
Cron trigger for synchronizing appointments	Cron job trigger indicating when appointments should be synchronized.	0 0 0 * * *
Cron trigger for deleting old appointments	Cron job trigger indicating when appointments should be deleted.	0 0 2 * * *
Appointment Status callbacks enabled	Enable callbacks to certain URLs when appointments are updated (HTTP PUT).	Enabled
Appointment Status update callback URLs (comma-separated).	Comma separated list of URLs to which a HTTP PUT call will be sent when appointments are updated.	/calendar-backend/public/api/v1/appointments/callback
Appointment life cycle events enabled	Enable or disable sending of events when appointments created, updated, or deleted.	Not enabled
Block early appointments (minutes)	Specify the number of minutes before the appointment start time, that it is possible to call an appointment visit. Note that it is possible to have a different number for different Agent Profiles, here.
Recycle Settings	Parameters regarding recycling of tickets.
Recycle Max no Recycles	The maximum number of times a ticket can be recycled.	3
Recycle Insert Delay	Number of seconds after which a ticket can be recycled and placed back into the queue at the first position.	60
Fault Manager Settings	Parameters regarding fault management.
Upload Level	Send faults of this severity and higher to central. Possible choices are: INFO, WARN, ERROR; FATAL).	WARN
Resend Interval (minutes)	Interval in minutes between each attempt to send faults to central.	60
Upload Schedule	JSON definition of allowed time slots for fault sending.	[{“days”:[“Mon”, “Tue”,”Wed”,”Thu”,”Fri”,”Sat”,”Sun”],”time”:”00:00-23:59”}]
Fault Manager enabled	Whether or not the Fault Manager is enabled.	Not enabled
Browser Settings	Chrome Frame is designed to expand Internet Explorer’s functionality, by adding support for open web technologies and Google Chrome’s fast rendering engine.
Allow Browser Chrome Frame	When this check box is checked, Chrome Frame is enabled.	Not enabled
Mobile API (Central)	Parameters regarding username and password for the Mobile API.
Username	Username used to access the Mobile API.	mobile
Password	Password used to access the Mobile API.
Mobile Ticket Base URL	Base URL used when generating URLs in e.g. barcodes, SMS messages and other mobile ticket implementations.	http://MobileTicket/MyVisit/CurrentStatus
Customer	Parameters regarding handling of Customer data, mainly due to GDPR regulations.
Include customers in export	If this check box is checked, customers will be included in export/import.	Disabled
Use retention policy for customer object	If this check box is checked, Customer objects will automatically be updated with a new interaction timestamp and deletion timestamp when Appointments or Visits are created or updated for that Customer.	Enabled
Delete customers, based on retention policy, at (hh:mm)	Customers will automatically be deleted, based on their retention policy, at this time (hh:mm). Delete job will only run if Use retention policy for customer object is enabled.	01:00
User Settings	Parameters regarding User settings.
Min Login Code	Lowest valid login code number.	1000
Max Login Code	Highest valid login code number. Default is set to 9999.	9999
UserName validation Pattern	Regular expression used for user name validation.	^[a-z]+[a-z,0-9]*$
Password Validation Pattern	Regular expression used for password validation.	^.*(?=.{8,}(?=.*\d)(?=.*[a-z])(?=.*[A-Z]).*$
Event Manager Settings	Parameter regarding events.
Upload Standard Events to Central	Whether or not standard events should be uploaded to Central (yes/no).	Events are uploaded.
Publish Custom Events on Central Topic	Whether or not custom events should be published on Central topic.	Events are published.
Sorting Policy Settings	Settings regarding sorting policy for visits.
Multi service visit sort policy	This setting affects how the visit is transferred to the Queue of the next Service in a multi-service Visit. From the drop-down list, select the wanted sorting policy; SORTED, FIRST, or LAST.	SORTED
Queue Agent Media Settings	Parameters regarding handling of media on Queue Agents.
Cron trigger for deleting old media	Cron job trigger indicating when old media will be deleted.	0 0 23 * * *
Allowed Download Interval	Time period when download is allowed.	00:00-23:59
Download media in advance (days)	Number of days in advance that media is downloaded.	5
Cron trigger for downloading media.	Cron job trigger indicating when media will be downloaded.	0 0 3 * * *
Statistics Settings	Parameters regarding the handling of statistics.
Enable Stat Messages	Whether or not sending of Stat messages should be enabled. Changing this value requires a restart of both central and all Queue Agents.	Enabled.
Stat Server Address	IP v4 address to the stat resource server. Note that when creating a Queue Agent Profile, this parameter needs to be changed to the IP address where Stat.war is located.	http://127.0.0.1
Stat Server Port	Port number where the stat resource is configured.	8080
Stat Server Resource	Application name for the stat resource.	/stat/message/
Queue Agent Resend Interval (minutes)	Resend interval (minutes).	10
Queue Agent Upload schedule.	JSON definition of allowed time slots for stat sending, leave empty to always allow stat upload. Example for upload during the night: [{“days”:[“Mon”, “Tue”,”Wed”,”Thu”,”Fri”,”Sat”,”Sun”],”time”:”20:00-04:00”}]	[{“days”:[“Mon”, “Tue”,”Wed”,”Thu”,”Fri”,”Sat”,”Sun”],”time”:”00:00-23:59”}]
SSO Settings	For more information about the SSO Settings, see “SSO setup” .
Enabled	Mark this check box to enable SSO. By default it is not enabled.	Not enabled
Allow basic authentication	Indicates if basic authentication is allowed.	Not allowed
Allow localhost	Indicates if authentication is skipped when the request comes from localhost.	Allowed
Allow unsecure basic	Only relevant if basic authentication is allowed. Specifies if HTTPS is required when using basic authentication.	Not allowed
Client module	Client module class name.	spnego-client
Pre-authentication user name	User name used for pre-authentication, tied to an LDAP account.	preauthuser
Pre-authentication password	Password used with user name for pre-authentication.
Login server module	Login server module class name.	spnego-server
Prompt ntlm	NTLM is not supported. Set this value to true if clients who wish to authenticate via NTLM should be offered Basic Authentication (assuming basic authentication is allowed).	Not enabled.
Allow delegation	Indicates whether the filter for delegation is enabled.	Enabled
Logger level	Valid values are 1 (finest) through 7 (severe), set to 1 for debugging/verbose logging.	1
LDAP Settings	LDAP configuration in Orchestra consists of two tasks: • Server configuration • System parameters - found in this table. • Certificate handling - see “LDAP Certificate Handling” . • LDAP/AD Group Mappings, e.g how LDAP objects, groups are mapped to Orchestra entities (Roles, Branches/Branch Groups). For more information, see the Administrator’s Guide. Each Orchestra attribute has a corresponding LDAP field attribute. For more LDAP information, see “LDAP Hosts/Urls” . The user superadmin will always log in locally. It is also possible to create users that are not authenticated towards the Active Directory.
Enabled	When the check box is checked, all users are authenticated towards the configured LDAP server, that is the Active Directory. This parameter needs to be set to true, in order to be able to perform LDAP mappings in the User Management application.	Not enabled.
Validate settings	Validate settings against LDAP server, when enabling LDAP. Disabling allows settings to be saved, even if LDAP server is not available.	Enabled
Server URL(s)	Space separated list of full LDAP URL:s, e.g. ldap://somehost:somePort See “LDAP Hosts/Urls” .	ldap://localhost:389
Bind user Dn	Bind user name, either accountName@domain.foo or full DN.	addEntryUser@domainName.se
Bind user password	Bind user password.
Base search context DN	Defines the root context, from which searches will origin.	CN=Users,DC=your_domain,DC=com
Account search filter	Defines how a user account DN should be searched for.	(&(objectClass=user)(sAMAccountName={0}))
Search timeout (millis)	Defines the timeout for an LDAP query in milliseconds.	1000
User groups attribute name	User attribute that defines the groups of the user.	memberOf
Mapped user attributes	Defines what user attributes that should be returned when searching for a user. The values from the fields below should be used in this string.	accountName,firstName,lastName,locale,rtl,loginCode
Account name mapped attribute	Defines the user attribute mapped to the account name.	sAMAccount Name
First name mapped attribute	Defines the user attribute mapped to the first name of the user.	givenName
Last name mapped attribute	Defines the user attribute mapped to the last name of the user.	sn
Locale mapped attribute	Defines the user attribute mapped to the locale of the user.	msExchUserCulture
RTL mapped attribute	Defines the user attribute mapped to the right-to-left setting of the user. Should be evaluated to true/false.	rtl
Login code mapped attribute	Defines the user attribute mapped to the login code of the user.	loginCode

LDAP Hosts/Urls

Authentication will only be performed once, using the first available connection.

Note that the server url is different in this case, ldaps://server:636. The default secure port is 636.

LDAP Certificate Handling

You must export the CA certificate from the Active Directory server to enable Secure Sockets Layer (SSL) security.

Procedure

You can save the CA certificate in either DER Encoded Binary X-509 format or Based-64 Encoded X-509 format.

Adding AD/LDAP server certificate to Orchestra Central

Preparation:

SSL Certificate import:

Make sure that the password entered above matches the following parameter value:

Example:

If either of the SSL parameters in the configuration file was changed, for example trust store file name or trust store password, the Orchestra must be restarted in order to commit the changes.

Adding AD/LDAP server certificate to Distributed Queue Agent