Configure in Silent Mode Using XML
- Last UpdatedAug 05, 2024
- 21 minute read
You can configure AVEVA Work Tasks by defining values for parameters in the WWSKBPMConfig.xml configuration file.
Note: You cannot configure Secure Communication settings and perform Farm Recovery through silent mode. To configure secure communication settings, you must manually launch the Farm Configuration Wizard and make the necessary changes.
-
Browse to the "Bin" folder, which is available in the path where the product is installed.
-
Open the WWSKBPMConfig.xml file.
-
Pass the values for the parameters available in the WWSKBPMConfig.xml file as per the requirements.
You can individually configure the following settings in silent mode by specifying appropriate values for the ConfigurationType parameter, as listed in the table below.
Configuration Tasks
Value for the ConfigurationType parameter
Configuring Farm
FarmDatabase
Configuring Data Source
DataSource
Configuring Repository
Repository
Configuring Client
Client
If you want to configure all the above settings together, then pass the value for the ConfigurationType parameter as All.
All the parameters in the configuration file are listed in the following table.
-
Save the XML file.
-
Open the Command Prompt in the Administrative mode.
-
Enter the path for the "Bin" folder, which is available in the path where the product is installed, and then press Enter.
For example: CD <AVEVA Work Tasks Install Path>\Bin
-
On the Command Prompt, type AVEVAWorkTasksConfigurator.exe.
The configuration progress is displayed in the WTLogger Console.
Settings Category
Node
Description
ConfigurationType
ConfigurationType
Note: This is a mandatory parameter.
Enter the type of configuration you want to perform in silent mode.
The values available are:
-
All
-
FarmDatabase
-
DataSource
-
Repository
-
Client
FarmConfiguration > FarmDatabase
EnableLoadBalancing
Enter either True or False.
If the value is set to True, load balancing is enabled on the server.
If the the value is set to False, load balancing is disabled on the server.
Farm Configuration > FarmDatabase > ConnectionString
DatabaseType
Enter the database type. The default value is SQL Server.
FarmDatabaseName
Note: This is a mandatory parameter.
Enter the name of the Farm database.
ServerName
Note: This is a mandatory parameter.
Provide information about the database server on which the Farm database can be installed.
If SQLExpress Instance need to be used as a Database instance of Farm database, then Server Name should be <server name>\SQLExpress.
To use SQL Server AlwaysOn Availability Groups, enter the SQL AlwaysOn Group name or the IP address, and the port number (separated by comma). For example: localhost,1455
AuthenticationType
Note: This is a mandatory parameter.
Provide information on the process used to validate a user. AVEVA Work Tasks solution supports both Windows and SQL Server authentication process.
Example: Windows
UserID
Enter the SQL User ID for SQL if the authentication type is SQLServer.
Enter the Windows User ID along with the domain or host name, if the authentication type is Windows.
UserPassword
Enter the password for the specified user ID.
IsPasswordEncrypted
Enter either True or False.
If the value is set to True, then enter the password in encrypted format.
Note: To encrypt a password string,
- Use SE.BPM.Converters.dll reference in the project.
- Use Encrypt(3) to encrypt password string.
Sample code:
String password = “$kelta001”;
String encryptedPassword = password.Encrypt(3);If the value is set to False, then enter the password in plain text format.
DatabaseAdvanceSettings
Enter any additional connection information, such as connection Timeout. Example: Connection Timeout = 20.
While creating a data source for repository, use the following custom settings to set properties for connection pool. These settings are case sensitive and should be mentioned only in lower case.
encrypt=true; enableltm=true; connectionretrywaittime=30; maxconnectionretries=10; sqlcommandtimeout=300;
-
encrypt: Ensures secure communication between AVEVA Work Tasks Server and SQL Server when a certificate is installed on the SQL Server for SSL encryption.
-
enableltm: AVEVA Work Tasks internally implements light weight transaction mode by reusing the connection which is already open within the same transaction. With this implementation a connection which is used from a transaction is returned back to connection pool only when the transaction is completed. Since the same connection is used within the transaction, the transaction becoming distributed is reduced to a great extent. With this feature AVEVA Work Tasks control the transaction from escalating to a distributed transaction which is very expensive. This property can be used to turn off this feature. The default value is set as True.
-
connectionretrywaittime: While opening a new connection, if the data base server is not available, the default behavior is to retry for the connection. This setting can be used to set the wait time for retry for a new connection. The default value is set as 30 Seconds. The value should be set in seconds.
-
maxconnectionretries: While opening a new connection, if the data base server is not available, the default behavior is set to retry for a new connection. This setting can be used to set the retry count. The default value is set infinite.
-
sqlcommandtimeout: Sets the wait time before terminating the attempt to execute a SQL command and generating an error. The default value is set as 300.
GlobalSettings > Communication > EmailSettings
Host
Enter the name or IP address of the mail host.
SMTPPort
Enter the port number for sending e-mails. The default port is 25.
SSL
Define whether the e-mail has to be secured by SSL before it is sent. The default value is False.
EmailTimeout
Enter timeout for e-mails in seconds. The default timeout is 10000.
SMTPUserName
Enter the user name for logging in to the mail server.
SMTPPassword
Enter the password.
IsSMTPPasswordEncrypted
Enter either True or False.
If the value is set to True, then enter the password in encrypted format.
If the value is set to False, then enter the password in plain text.
GlobalSettings > Communication > EmailSettings > ExceptionEmailSettings
FromEmail
Enter the e-mail Id from emails detailing exceptions in workflow execution need to be sent.
ToEmail
Enter the e-mail Id to which exceptions must be sent.
Global Settings > Communication > EmailSettings > ExceptionEmailSettings > IMSettings
UserName
Enter user name in which IMs must be sent.
Password
Enter the password.
Global Settings > Communication > Service Monitor Setting
Service Monitor Port
Enter the port number. This is the default port used by the AVEVA Work Tasks Service Monitor EXE.
Global Settings > HTTP > URLEncryptionSettings
UseHTTPContext
Enter True to use HTTP context. Enter False if you do not want to include http context info while building the secure query string parameter used internally in AVEVA Work Tasks controls to pass information from one page to another.
HardcodedCorrectionFactor
This field is used to set a flag primarily used for load testing. The date correction factor used by AVEVA Work Tasks is retrieved through a cookie from client browser. This value cannot be derived when testing using ACT or any other load test tool. If this factor is set to True, AVEVA Work Tasks always uses the date correction factor for converting UTC date time stored in AVEVA Work Tasks tables to the local time. The default value is False.
Global Settings > HTTP > HTTPProxy
HTTPProxyURL
Enter the URL for HTTP Proxy.
HTTPProxyUser
Enter a user name for HTTP Proxy.
HTTPProxyPassword
Enter a password.
HTTPProxyDomain
Enter the domain name.
BypassLocalRequest
Enter True to bypass local requests.
BypassList
Enter list of URLs in the bypass list; requests from a URL in this list will be ignored.
IsHTTPProxyPasswordEncrypted
Enter either True or False.
If the value is set to True, then enter the password in encrypted format.
If the value is set to False, then enter the password in plain text.
Global Settings > LogTransaction
DebugLevel
Select from three debug levels.
-
Level 1 shows minimal information in the AVEVA Work Tasks Logger Console, giving only information on the start and end of the workflow. Error messages are also shown in this mode. This is the default mode.
-
Level 2 shows detailed information of what is happening in the background. It will show all the messages logged from the actions.
-
Level 3 shows only messages indicating whether the action is executed. All error messages logged in the logger console will be sent to receiver email specified in Exception Emails.
PersistExceptionInDatabase
Enter either True or False.
-
If the value is set to True, you will be allowed to persist the exceptions which are logged in AVEVA Work Tasks logger console to the repository database. This in turn allows you to view exceptions at the following levels:
-
Workflow level
-
Workflow Instance level
-
Activity level
-
-
The default value is False. If the value is set to False, you will not be allowed to persist the exceptions which are logged in the logger console to the repository database.
PersistWarningInDatabase
Enter either True or False.
-
If the value is set to True, you will be allowed to persist the warnings which are logged in AVEVA Work Tasks logger console to the repository database. Which in turn allows you to view warnings at the following levels:
-
Workflow level
-
Workflow Instance level
-
Activity level
-
-
The default value is False. If the value is set to False, you will not be allowed to persist the warnings which are logged in the logger console to the repository database.
GlobalSettings > FileWatcher
IterationCount
Set the iteration value for a file copy process. The default value is 200.
FirstAttempt
The value in this field indicates the wait time after a file copy command is executed for the first time. This wait time is provided for an event to be generated after the file copy process is complete. The value specified is in milliseconds. The default value is 2000.
NextAttempt
The value in this field indicates the wait time for subsequent attempts. The value specified is in milliseconds. The default value is 4000.
Example
The value 4000 indicates that the wait time for subsequent attempts is four seconds.
GlobalSettings > MachineSettings
MachineAddress
Enter the address of the machine on which AVEVA Work Tasks is installed.
WorkflowEngineSettings > EngineSettings
WEServerPort
Enter the port number used by the Workflow Engine Service. The Workflow Engine communicates with other services using this port. The default value is 8855.
WELoadBalanceServerPort
Enter the port number for the Load Balanced Server. This field is disabled if Load Balanced value is set to False.
WELoadBalanceClientPort
Enter the port number for the Load Balanced Client. This field is disabled if Load Balanced value is set to False.
WorkflowEngineSettings > AutoResumeSetting
RepositoryNames
Enter the name of the repository.
EnableLoggingAutoResumeMessage
It enables you to control the log messages in the logger console whenever the engine tries to resume the respective workflow instances.
WorkflowEngineSettings > AutoResumeSetting > FEWorkflows
NoOfRetriesToResumeFEWorkflowInstances
Enter the number of attempts that the Workflow Engine should make to resume the FE workflow instances.
For example, if this value is set to 5 then the workflow engine would make 5 attempts to resume each of the FE workflow instance.
If this value is set to 0 (zero) then, then auto resume of FE workflow instances does not occur.
RemoveResumeHistoryOnFEWorkflowInstanceCompletion
If the value is set to True, the history of resumed FE workflow instances which have completed successfully would be deleted from the SWFECOUNT table.
If the value is set to False, the history of resumed FE workflow instances which have completed successfully would be retained in the SWFECOUNT table.
NoOfFEWorkflowInstanceToFetchSpecifiedTimeInterval
Set the number of workflow instances to be fetched for auto resume in the specified time interval.
FETimeSpan
Set the time interval for resuming FE workflow instances. The value entered should be greater than 5 minutes.
WorkflowEngineSettings > AutoResumeSetting > EPWorkflows
EnableAutoResumeEPWorkflowInstance
Enable or disable auto resume of EP workflow instances.
FetchWorkflowinstanceWhichHaveBeeninEPStateFor
Set the minimum time for which the workflow instances should have been in EP state. The value should be entered in days.hr:min:sec format.
If this value is set as 5, the workflow engine tries to fetch the workflow instances which have been in EP state for at least 5 hours.
The workflow engine calculates the time for which the workflow instances have been in EP state by comparing the LastUpdatedDateTime value from SWExecute table with the current time.
The default time for which workflow instances have been in EP state is 5 hours. If the time set is less than 5 hours, then by default, the engine considers 5 hours as the minimum time.
TimeIntervaltoFetchEPWorkflowInstances
Set the time interval for resuming EP workflow instances. Minimum value should be greater than 5 minutes.
NoofEPWorkflowInstancesToBeFetchedInSpecifiedTimeInterval
Set the number of EP workflow instances to be fetched for auto resume in the specified time interval.
WorkflowEngineSettings > AutoResumeSetting > PendingWorkflows
EnableAutoResumeOfPendingWorkflowEvents
Enable or disable auto resume of pending workflow events.
MinimumTimeForWhichTheWorkflowEventsAreinPendingState
Set the minimum time for which the workflow events should be in Pending state.
If this value is set as 0.5:0:0, the workflow engine will fetch the events which are in Pending state for at least 5 hours.
The workflow engine calculates the time for which the workflow events have been pending by comparing the LastUpdatedDateTime value from SWExecute table with the current time.
The default time for which workflow events should be in pending state is 5 hours. If the time set is less than 5 hours, then by default, the engine considers 5 hours as the minimum time.
TimeIntervalToFetchWorkflowInstancesWithPendingEvents
Set the time interval for resuming workflow instances with pending events. Minimum value should be greater than 5 minutes.
NoOfWorkflowInstancesWithPendingEventsToBeFetchedIn SpecifiedTimeInterval
Set the number of workflow instances with pending events to be fetched for auto resume in the specified time.
AdvancedServerSettings
MultiCastPort
Use this port to check the connectivity between all the machines while running the Load Balanced Server. This is not used if the Enterprise Server Mode is Database.
HeartbeatInterval
Specify the heartbeat interval for the Enterprise Server. The default value is 3000 ms.
HeartBeatTimeout
Specify the heartbeat timeout value for the Enterprise Server. The default value is 10 seconds.
AverageCPUCount
Specify the average CPU count for the Enterprise Server. The default value is 10.
MultiCastIP
Displays the multicast IP address. The default values are:
-
IPv4: 225.0.0.10
-
IPv6: FF02::1
TCPPort
Communication between the Workflow Engine and the Advance Server service is established through this port. This port is used to get the status of the least used server, and also analyze server performance. The default value is 8853.
ASMode
Select the mode as Multicast or Database.
-
If you select the mode as Multicast, then it uses the configured Cluster Port, Cluster IP, and Multicast Local IP to share its server status with other servers.
-
If you select the mode as Database, the server status is stored in the database and is shared with other servers.
The default value is Multicast.
LocalIP
Displays the local server name or IP address.
IP address supports both IPv4 and IPv6 address types.
MultiCastLocalIP
Displays the multicast server name or IP address.
Local IP address supports both IPv4 and IPv6 address types.
This field is not used if you select the Enterprise Server Mode as Database.
TaskSchedulerSettings
TSServerPort
Enter the port number used by Task Scheduler service. This value must be modified if the default port value is in use. The default value is 8856.
TSLoadBalancedServerPort
Enter the port number for the Load Balanced Server. This field is disabled if Load Balanced is set to False. The default value is 8853.
TSLoadBalancedClientPort
Enter the port number for the Load Balanced Client. The default value is 8860.
TaskFetchInterval
Enter the interval in seconds at which tasks have to be retrieved. The default value is 60.
TSFileWatcher
Define a folder for File Watcher operation.
TSThreadPoolSize
Define a thread pool size for the Workflow Engine. A thread pool size determines the number of threads reserved by a server for providing service requests. For the Workflow Engine deployed in a heavy load scenario, a higher thread pool size needs to be set. The default value is 25.
CommunicationServiceSettings > CommunicationServer
ListenerIPAddress
Enter the IP address to be monitored for incoming emails. This field defaults to the name of the logged in machine.
ListenerPort
Enter the port number for the Listener IP Address. The default value is 8770.
WaitTaskHandlerPath
Enter the assembly navigation path for handling timeouts and e-mail received.
TaskHandlerClass
Enter the Class name for handling timeout tasks and incoming emails.
BlockMailAddresses
Enter the e-mail addresses that should be blocked from processing.
CommunicationServiceSettings > CommunicationServer > AdvancedServerSettings
LoadBalancedServerPort
Enter the port number used by the Enterprise Server. This value must be modified if the default port value is in use. The default value is 8853.
LoadBalancedClientPort
Enter the port number for the Client. The default value is 8864.
CommunicationServiceSettings > MailServer > Default
CommunicationServiceServerIP
Enter the IP address of the server where the Communication Service is installed.
CommunicationServiceServerPort
Enter the Port number used by the Communication Service. The default value is 25.
CommunicationServiceSettings > MailServer > POP3
POPMailHost
Enter the IP address of the POP Mail Host.
POPTimeInterval
Set the time interval to check the mail server for emails. The format for this field is day.hour.minute.seconds. The default value is 0.00:00:15.
POPMailPort
Enter the port number for receiving e-mails. The default value is 110.
IsSPAEnabled
Specify if a Secure Password Authentication is provided. The default value is False.
IsPOPProvideEncryptedPwd
Enter either True or False.
If the value is True, then enter the password in encrypted format.
If the value is set to False, then enter the password in plain text.
IsPOP3PasswordEncrypted
Enter either True or False.
If the value is True, then enter the password in encrypted format.
If the value is set to False, then enter the password in plain text.
POPUsers
Enter the User Name and password of POP3 user.
CommunicationServiceSettings > SMSReceiver
EnableSMSReceiver
This field enables the Communication Engine to check for SMS. The default value is False.
SMSTimeInterval
Enter the time interval at which the AVEVA Work Tasks Engine must check for SMS in the phone device.
Example:
0.00:01:30 = 1 minute 30 secs
The default value is 0.00:01:00.
SMSTaskPath
Enter the Assembly path for handling timeout actions and warnings.
SMSTaskClass
Enter the class name for handling timeout actions and warnings.
NotificationSMSProvider
Enter the Assembly path for handling timeout actions and warnings.
CommunicationServiceSettings > SMSReceiver > ProviderConfigurations
ProviderConfiguration
These parameters are used for configuring the SMS infrastructure (sending and receiving SMS).
-
SMSProviderDeviceSettings: 8 databits, no parity, 1 stopbit
-
SMSProviderDialString
-
SMSProviderProviderType: Standard TAP provider
You can specify 0 for UCP Provider, 2 for TAP provider, no request for LineFeed, and 3 for TAP provider, no request for EOT.
-
SMSEmailProviderAssembly
-
SMSEmailProviderClass
-
SMSEmailProviderEmailServer
Enter the details specific to your service provider. AVEVA Work Tasks currently supports only GSM protocols for receiving SMS.
-
Name: Enter the name of the service provider.
-
Assembly: Enter the path.
-
Class: Enter the class name for receiving SMS.
-
Device: Enter device details.
CommunicationServiceSettings > SMSConfig
ConnectionSequences
Enter the sequence in which the Engine must choose the connection type for sending SMS.
-
Connection Type: This column is used to list the various connection types such as GSM, SMSPatternMatch, EmailProvider, SMSServiceProvider, and Hayes.
-
Sequence Number: This column is used to list the sequence of each connection type.
CommunicationServiceSettings > SMSConfig > ResourceField
SMSResourceFieldsEmail
This field is mapped to the connection sequence table for sending SMS. The fields are mapped in the user provider for sending SMS. The three fields - Email, Mobile Phone Provider, and SMS Number are required to be mapped to the table.
Some providers allow SMS to be sent through email. Enter your email address in the email field to send SMS to these providers.
SMSResourceFieldMobilePhoneProvider
This field is mapped to the table for sending SMS. Enter the name of the Mobile Phone Provider in this field.
Example: Hutch
SMSResourceFieldSMSNumber
This field is mapped to the table for sending SMS. Enter the phone number to which the SMS has to be sent.
CommunicationServiceSettings > SMSConfigCustom > SMSPatternMatch
SMSPatternMatchAssembly
Define an assembly which handles sending and receiving SMS.
SMSMessengerAssemblyClass
Enter the class name which handles sending and receiving SMS.
CommunicationServiceSettings > SMSConfigCustom > SMSPattern
SMSProvider
-
SMS Provider: Provider name such as, Hutch or Airtel.
-
Connection Type: Connection type like EmailProvider, GSM, SMSServiceProvider or Hayes.
-
SMS Pattern: Pattern like 9845*, 98*.
CommunicationServiceSettings > SMSSendAction > CustomSMSProviders
CustomSMSProvider
-
Name: Enter the name of the SMS Provider.
-
SMSProviderSMSMessengerAssembly: Enter the path to the assembly.
-
SMSProviderSMSMessengerClass: Enter the class information.
-
SMSProviderDevice: Enter the device for the custom SMS provider.
-
SMSProviderDeviceSpeed
NELoadBalance
NELoadBalanceServerPort
Enter the port number for the Load Balanced Server. This field is disabled if Load Balanced is set to False.
NELoadBalanceClientPort
Enter the port number for the Load Balanced Client.
MobileNotificationServiceSettings
MNLoadBalanceServerPort
Enter the port number for the Load Balanced Server. This field is disabled if Load Balanced is set to False.
MNLoadBalanceClientPort
Enter the port number for the Load Balanced Client.
SchedulePeriod
If the notification is not delivered at the first attempt, you can set the interval between delivery attempts. The system tries to resend the notification at the interval defined in this field. The time entered should be in days:hr:min:sec format only. The maximum limit is 10 minutes. The default value is 30 seconds.
MessageRetryCount
If the notification is not delivered at the first attempt, you can set the number of retry attempts to deliver the notification. After the defined limit is reached, the notification expires. If the Retry Count value is set as 0, the failed notifications will not be resent. The default value is 5.
MobileNotificationServiceSettings > Register > RegistrationDetails
RegistrationRetryCount
A device needs to be registered in the Azure notification hub before it can receive notifications. If the device registration is not successful at the first attempt, you can set the number of retry attempts to register the device. If the Retry Count value is set as 0, the failed device registrations do not happen. The default value is 5.
ScheduleDeviceRegistrationPeriod
If the device registration is not done at the first attempt, you can set the interval between device registration attempts. The system tries to re-register the device at the interval defined in this field. The time entered should be in days:hr:min:sec format only. The default value is 2 minutes.
ClientId
Not applicable. The parameter is retained for backward compatibility.
MachineId
Not applicable. The parameter is retained for backward compatibility.
DataSource
DataSourceName
Note: This is a mandatory parameter.
Enter the name of the datasource to be created.
Description
Enter the description for the datasource.
ServerName
Note: This is a mandatory parameter.
Enter the database server or instance name.
To use a database on the local machine, enter "localhost", ".", or the local computer’s name for the Server Name.
For SQL Server database type, specify IPv4 and IPv6 addresses for the Server Name.
To use SQL Server AlwaysOn Availability Groups, enter the SQL AlwaysOn Group name or the IP address, and the port number (separated by comma). For example: localhost,1455
To use SQLExpress instance as a database instance of the repository database, the Server Name must be <server name>\<instance name>.
AuthenticationType
Note: This is a mandatory parameter.
Use this field to determine the process to validate a user who is trying to connect to the database.
AVEVA Work Tasks uses Windows or SQL Server authentication process. SQL Server authentication requires a user ID and a password already defined in the SQL Server database.
For Example: Windows or SQLServer
UserId
Enter the ID of the user who is trying to connect to the database.
Password
Enter the password of the user.
RepositorySettings
ResourceProvider
Enter one of the following values:
-
ActiveDirectory
-
Forms
-
ASPNETMembership
-
RepositoryUserProvider
-
ConnectUserProvider
RepositoryDataSource
Note: This is a mandatory parameter.
Select the data source that will be used to store data for the current repository.
RepositoryName
Note: This is a mandatory parameter.
Assign a name for the repository.
Ensure that you do not use special characters other than ()-=[]{}\|;,<>./!@$^`~ in the repository name.
For Example: Telematics Repository
Description
Note: This is a mandatory parameter.
Provide a description for the repository.
For example: This stores Telematics Employee Leave Details.
FromMail
Email ID used by the email channel to send emails.
We recommend to define the From mail and Exception to mail in a production environment. This will assist the process administrator to track any exception that might occur in the In this scenario, you have a Web Server and Services installed on the same machine. You can host this set up on multiple computers to form a Web Farm with clustered the Services. The Databases are installed on a machine by itself. While scaling out, ensure that the machine has both the Web Server and the Services installed.
See: Farm with Clustered Wonderware Skelta BPM Services and Database on Different Machines
In this scenario, you can maintain a Web Farm with the Web Servers and Services cluster on separate machines while the Databases are installed on a different machine. This deployment provides scalability and high availability of the Workflow Engine and the Web Servers. This is achieved by distributing the load equally among all the machines in the cluster and the Web Farm.
Multiple servers in the Web Farm or the cluster run the same services. Failure of a server does not impact other servers. You can take the affected server offline while the other servers maintain the service. This type of installation provides Failover. Thus allowing you to easily add or remove machines from the Web Farm or from the cluster without affecting the execution of workflows.
This is the optimal scenario for heavy load conditions and can be considered if you anticipate heavy load on the Workflow Engine or the Web Server.
See: Web Farm Connecting to Separate Wonderware Skelta BPM Services Cluster with Database on a Different Machine Workflow instance due to data mismatch or any configuration related issue. An email with exception details will be sent to the mail ID defined in Exception to mail.
The from address of email channel mails continue to use the previously configured email ID, even after this property is edited and the repository is saved. To avoid this, restart the Workflow Engine Service and the Communication Service.
For example: admin@domain.com
ExceptionToMail
Define an exception email ID. Exceptions generated by the Workflow Engine when an activity fails are sent to the email ID specified in Exception to mail.
For example: admin@domain.com
AlertInitiatorOfWorkflow
Determines if the status of a workflow should be sent as a notification mail to the initiator of the workflow.
For example: A process with a rule to check the pending leave available for the employee exists. If this rule fails due to a data mismatch, the employee who submitted the leave application will receive an e-mail with details related to the exception as a notification.
EnableTheme
Set the value to enable the defined theme.
ThemeName
AVEVA Work Tasks supports themes that you can use to change the look and feel of the user interface. AVEVA Work Tasks provides Default and Lite themes.
Do not use the Default folder for any style sheet customizations.
RepositoryListAdminPassword
Note: This is a mandatory parameter.
Set the password for the system administrator (username: admin) to access Enterprise Console configured with the Repository User Provider.
The repository list admin password should have at least one uppercase letter, one lowercase letter, one special character, one number, a minimum length of 8 characters, and no blank spaces.
For upgrade scenario, refer to Configure Password for Admin User in Silent Mode using XML
Note: All characters from A-Z, a-z, and 0-9 are allowed, along with all special characters except space. Foreign special characters are not permitted.
CustomApplicationFolder
Enter the names of the folders that contain the custom activities and custom resource providers. You must separate multiple folders with a semicolon.
HideRepository
Set the value to make the repository unavailable to the Farm.
SourceElements
Enter the path to the Source Elements Folder.
AttachmentDefaultPhysicalStoragePath
Enter the path for storing attachments in the file system.
Note:
- The path specified should be an absolute path.
- The default path is the Attachments folder in the installation path.
- The default path is used when no path is specified.AutoLogOffTime
Enter the time after which the logged in user must be automatically logged off after the designated period of inactivity.
Enter the time in minutes. Ensure that you enter only valid integer values between 1 to 360. 0 minutes is an invalid value. The maximum time allowed is 360 minutes.
In some cases there may be a slight time lag of few seconds which can be maximum of 10 seconds.
If you do not specify a value, then the log off time is not set for the repository, and the session does not log off automatically.
You use also define the log off time for all the providers of a particular repository. If you have administrator rights to a repository, you can also set separate log off time manually for each provider.
For more information about manually setting the auto log off time at the provider level, see Configuring the Definition XML.
For example: 1 to 360 (in minutes)
UserCredentialsTimeoutForApp
Enter the time in hours to request for user credentials for AVEVA Work Tasks Pro after the set time is elapsed.
For example: 1 to 48 (in hours)
The default value is 0, which disables this setting.
IsWorkTasksProOfflineSupportEnabled
Enter either True or False for enabling/disabling offline support in AVEVA Work Tasks Pro app.
If the value set is True, the offline support is enabled.
If the value set is False, the offline support is disabled.
The default value is True.
IsWorkTasksProRefreshOnWorkItemSubmissionEnabled
Enter either True or False to allow/disallow refreshing the Inbox in AVEVA Work Tasks Pro app.
If the value set is True, the Inbox is automatically refreshed on submitting the work item.
If the value set is False, the Inbox is not refreshed on submitting the work item.
The default value is True.
TimeoutForWorkTasksPro
Set the time out value in seconds for AVEVA Work Tasks Pro app.
The default value is 60.
FillFormLabelForWorkTasksPro
Specify the label for the Fill Form for AVEVA Work Tasks Pro.
DateConfigAlternateActors
Select the Enable Date Settings option to set the From date and To date as mandatory while creating alternate actors.
For more information about creating alternate actors, see Alternate Actors topic in the User Guide.
IsDomainNameToShowWithUser
Enter the value to determine whether the domain name must be displayed along with the user name in the Enterprise Console header.
The domain name will be displayed only if the Resource Provider is selected as Active Directory.
ActiveDirectoryDatasource
Note: This is a mandatory parameter.
Enter the name of the Active Directory datasource.
ActiveDirectorySearchBase
Note: This is a mandatory parameter.
Enter the Active Directory Search Base to search active directories for users.
DomainName
Note: This is a mandatory parameter.
Enter the domain name.
AuthenticationUser
Enter the authentication user.
AuthenticationPassword
Enter the password.
IsCrossDomainRoleProvider
Specify whether cross domain users and roles mapping is required.
UserLogonID
Enter the value if you want to use another Active Directory attributes instead of SAM-Account-Name.
It is recommended to use attributes of type string as input for User Log-on ID. After you set the User Log-on ID, you cannot change it later.
UserLogonDisplayName
Enter the User Log-on Display Name.
This is the default display name of the user account of the active directory user used. User Log-on Display Name is used in user lookups.
After you set the User Log-on Display Name, you cannot change it later.
AspnetMembershipDataSource
Enter the data source for the user table.
ApplicationName
Enter the application name for the ASP.NET Membership provider.
UserEntityProperties
Enter the XML code that identifies user properties.
UserProviderProperties
Enter the XML Schema.
There must be at least one identifier in the XML Schema.
For example: UserID
FormsProviderDatasource
If the selected repository data source is of type SQL Server, then Forms provider is of type SQL Server database.
DataTable
Enter a valid data source or specify a dll.
UserLoginProperty
Enter the name of the User Table or View in the Datasource.
This property value will be used as User ID when logging in to the Enterprise console.
ProvisionMessageQueue
Enter the value as True to provision the repository for Message Queue.
PasswordEncrypted
Enter either "True" or "False".
If the value is set to "True", then the user has to enter the password in encrypted format.
Note: To encrypt a password string,
- Use SE.BPM.Converters.dll reference in the project.
- Use Encrypt(3) to encrypt password string.
Sample code:
String password = “$kelta001”;
String encryptedPassword = password.Encrypt(3);If the value is set to "False", then the user has to enter the password in plain text.
AdvanceSettings
Provide the advanced connection settings like providing the time (in seconds) that a connection string must wait to connect to the database server before terminating the connection.
For Example: Connection Timeout = 20
DatabaseName
Note: This is a mandatory parameter.
Enter the name of the database that can be used as a datasource.
-
You need not configure the ConnectConfiguration and Https settings in the XML:
<ConnectConfiguration enabled="false">
<ConnectEnvironment></ConnectEnvironment>
<ApplicationClientId></ApplicationClientId>
<ApplicationClientSecret></ApplicationClientSecret>
<ClientCredentialsClientId></ClientCredentialsClientId>
<ClientCredentialsClientSecret></ClientCredentialsClientSecret>
<WorkTasksClientId></WorkTasksClientId>
<WorkTasksClientSecret></WorkTasksClientSecret>
<WorkTasksProClientId></WorkTasksProClientId>
<AccountId></AccountId>
<SolutionDefinitionId></SolutionDefinitionId>
<SolutionId></SolutionId>
<AssetName></AssetName>
<Quickflow enabled="false">
<AzureServiceBus>
<SubscriptionId></SubscriptionId>
<TenantId></TenantId>
<ClientId></ClientId>
<ClientSecret></ClientSecret>
<ResourceGroupName></ResourceGroupName>
<ServiceBusNamespaceName></ServiceBusNamespaceName>
<ServiceBusUserName></ServiceBusUserName>
<Location></Location>
</AzureServiceBus>
</Quickflow>
</ConnectConfiguration>
<SiteSuffix></SiteSuffix>
<Https enabled="false">
<Certificatepath></Certificatepath>
<Certificatepassword></Certificatepassword>
<Port>8001</Port>
</Https>