...
Description | Option to specify the Character Set Encoding to be used by default, while parsing the data. |
---|---|
Default Value | ISO-8859-1 |
Possible Values | Any possible character set encoding such as UTF-8 etc. |
Selection Criteria | Specifies the default character set encoding to be used by all activities while parsing the data. However, you can also define the character set encoding at each activity level. Character set encoding defined at the activity level always takes precedence. To know more about character set encoding, refer to the Configuring Character Set Encoding section of Adeptia Suite Developer Guide. |
...
Adeptia Suite uses Log4j for logging. Log4j has three main components: loggers, appenders, and layouts. These three components work together to log messages according to message type and level, and to control at runtime how these messages are formatted and where they are reported.
The logging level controls the type of messages that are logged. Adeptia Suite supports the following logging levels:
- DEBUG: The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
- INFO: The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
- ERROR: The ERROR level designates error events that might still allow the application to continue running.
...
- jdbc: Appends logs to a database.
- console: Appends log events to system.out or system.err using layout specified by the user. The default target is system.out.
- *file:* Appends log to a file.
...
Info |
---|
For more details on Log4j refer to http://logging.apache.org/log4j |
...
Description | Option to define System and Process Flow Logging Level and Appenders |
---|---|
Default Value | INFO,console,jdbc |
Possible Values | A combination of valid log level along with the appenders. |
Selection Criteria | This property specifies the default logging level of System and Process flow log. |
...
Description | Option to define logging level for Event logs |
---|---|
Default Value | INFO |
Possible Values | ERROR/INFO/DEBUG |
Selection Criteria | This property specifies the default logging level of Event log. |
com.mchange.v2.log.MLog
Description | c3p0 Logging Library Name |
---|---|
Default Value | com.mchange.v2.log.FallbackMLog |
...
Description | c3p0's System.err Fallback Logger Level |
---|---|
Default Value | WARNING |
log4j.logger.org.springframework
Description | Spring Logging Level |
---|---|
Default Value | ERROR |
abpm.system.separateLogFile.enable
Description | Enables or disables separate log files for System and Application level |
---|---|
Default Value | false |
Possible Values | true/false |
Selection Criteria | By default both system and application logs are written together in one file. All Kernel logs are written into Kernelapplication.log and all Webrunner logs are written into WebRunnerapplication.log file. |
...
Description
...
Path where system log file is stored.
...
Default Value
...
logs/systemlogs
...
Possible Values
...
Any absolute or relative path.
...
Selection Criteria
...
Description | This is the Log4j console Appender class |
---|---|
Default Value | org.apache.log4j.consoleAppender |
Possible Values | Any implementation of console Appender |
Selection Criteria | ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. The default target is System.out. |
...
Description | This is the Log4j JDBC Appender class. |
---|---|
Default Value | comorg.apache.log4j.jdbcplus.jdbcAppender |
Possible Values | Any implementation of JDBC Appender |
Selection Criteria | The JDBC Appender writes messages into a database via JDBC. Multiple configuration options and parameters are supported. |
...
Description | Defines the JDBC URL of the log database |
---|---|
Default Value | As specified during installation |
Possible Values | Any valid JDBC URL |
Selection Criteria | Specifies the JDBC URL to connect to log database. This property is automatically populated as per the value given in the Log Database Configuration step during installation. |
...
Description | Database driver to connect to the log database. |
---|---|
Default Value | As per the log database selected during installation. |
Possible Values | JDBC Driver of the log database, which is used to store the logs. |
Selection Criteria | This value is provided by the JDBC driver used to connect to the log database. This property is automatically populated as per the log database server type selected at the time of installation. |
...
Description | Username to access the log database. |
---|---|
Default Value | As specified during installation |
Possible Values | Any user name, which has permission to create tables, and insert records in the log database. |
Comments | This property is automatically populated as per the user name specified in the Log Database Configuration step at the time of installation. |
...
Description | Password to access the log database |
---|---|
Default Value | As specified during installation |
Possible Values | NA |
Selection Criteria | This property is automatically populated using the password specified in the Log Database Configuration step at the time of installation. |
...
Description | Password of the username specified in log4j.appender.jdbc.username property |
---|---|
Default Value | As specified during installation. |
Possible Values | NA |
Selection Criteria | This property is automatically populated as per the password specified in the Log Database Configuration step at the time of installation. |
...
Description | Log4j Rolling File Appender class |
---|---|
Default Value | org.apache.log4j.RollingFileAppender |
Possible Values | Any implementation of FileAppender |
Selection Criteria | RollingFileAppender is used to backup the log files when they reach a certain size |
...
Description | Name of the file in which WebRunner logs are written |
---|---|
Default Value | WebrunnerSystem.log |
Possible Values | Any valid file name with .log extension. |
Selection Criteria | Name of the file, in which webrunner logs are written. |
...
Description | Name of the file in which Kernel logs are written |
---|---|
Default Value | KernelSystem.Log |
Possible Values | Any valid file name with .log extension. |
Selection Criteria | Name of the file, in which Kernel logs are written. |
...
Description | Defines the number of backup log files |
---|---|
Default Value | 10 |
Possible Values | Any positive integer and depends on the number of old logs to keep |
Selection Criteria | When the log file reaches up to a specified size, it is renamed for backup purpose and a new file is created to store the new logs. The property specifies how many backup files to keep, before they are deleted. |
...
Description | Maximum size of the log file |
---|---|
Default Value | 10 MB |
Possible Values | Maximum size of the Kernel and WebRunner log files individually. |
Selection Criteria | When the log file reaches this size, it is archived and a new file is created to store the logs. |
...
Description | Defines the JDBC URL of the archival log database |
---|---|
Default Value | As specified during installation |
Possible Values | Any valid JDBC URL |
Selection Criteria | Specifies the JDBC URL to connect to the archival log database. This property is automatically populated as per the value given in the Log Database Configuration step during installation. |
...
Description | Database driver to connect to the archival log database. |
---|---|
Default Value | As per the log database selected during installation |
Possible Values | JDBC Driver of the log database, where the logs are archived. |
Selection Criteria | Determines the JDBC driver used to connect to the log database. This property is automatically populated as per the log database server type selected at the time of installation. |
...
Description | Username to access the archival log database. |
---|---|
Default Value | As specified during installation |
Possible Values | Any user name, which has permission to create tables and insert records in the log database. |
Comments | This property is automatically populated from the user name specified in the Log Database Configuration step at the time of installation. |
...
Description | Password to access the archival log database. |
---|---|
Default Value | As specified during installation |
Possible Values | NA |
Selection Criteria | This property is automatically populated using the password specified in the Log Database Configuration step at the time of installation. |
...
Description | Password of the username specified in log4j.appender.jdbc.username property |
---|---|
Default Value | As specified during installation |
Possible Values | NA |
Selection Criteria | This property is automatically populated as per the password specified in the Log Database Configuration step at the time of installation. |
...
Description | Adeptia Suite Secretkeystorename |
---|---|
Default Value | SecretKeys.Keystore |
Possible Values | Any valid JCEKS Keystore |
Selection Criteria | SecretKeys.Keystore is a protected database that holds keys that are generated when user creates the Secret Key entity. These keys are used for Encryption, Decryption and Schema services. |
...
Description | Folder where secret keys and keystore are stored |
---|---|
Default Value | etc/security |
Possible Values | Any absolute or relative path from ServerKernel folder. |
Selection Criteria | Represents the folder path where security related folders are stored viz. Keystore, secret keys etc. |
...
Description | Number of days after which the password expires |
---|---|
Default Value | 0 |
Possible Values | Any positive integer. |
Selection Criteria | Represents the number of days after which the password expires. A value of 0 ensures that the password does not expire. |
...
Description | Number of days before password expiry for displaying the reminder message |
---|---|
Default Value | 5 |
Possible Values | Any positive integer. |
Selection Criteria | Represents the number of days before the Adeptia User password expiry, the expiry warning is to be displayed. This warning is displayed at login. |
...
Description | Add comments before saving or editing an activity |
---|---|
Default Value | no |
Possible Values | yes/no |
Selection Criteria | Indicates the comment that is added after the activity is either edited or an activity is added. You can enter the reason for the add action or edit action. |
Info |
---|
If you enable/disable comments when you are already working in Process Designer or Data Mapper applet, you need to restart the respective applet. |
...
Description | File where the JVM looks for security JAAS configuration |
---|---|
Default Value | etc/jaas.config |
Possible Values | Any file containing the login module configurations |
Selection Criteria | Valid login modules |
Comments | Specifies which Login Modules should be used for the Adeptia Suite application, and in what order the Login Modules should be invoked |
...
These properties are used when any mail notification generated by Adeptia Suite is sent. Adeptia Suite generates mail notifications when:
- You click on the Forgot Password link in the login page
- Any Mail Notification activity is executed
...
Description | Specifies the protocol used by an outgoing mail server |
---|---|
Default Value | smtp |
Possible Values | smtp/mapi |
Selection Criteria | Select smtp if the outgoing mail server is using the SMTP protocol. |
...
Description | IP address or host name of outgoing (SMTP) mail server |
---|---|
Default Value | Depends on the value given in the Mail Server Configuration steps during installation |
Possible Values | IP address or hostname of the SMTP Server |
Selection Criteria | Applicable only when smtp is defined as mail protocol. This property is automatically populated using the value given in the Mail Server Configuration step during installation. However, you can also manually define it, if needed. |
...
Description | Specifies the domain name |
---|---|
Default Value | Adeptia |
Possible Values | Domain Name, in which exchange server is configured. |
Selection Criteria | Applicable only when MAPI is defined as the mail protocol. This property is automatically populated from the value given in the Mail Server Configuration step during installation. However, you can also manually define it, as needed. |
...
Description | Name of the CDOHost machine |
---|---|
Default Value | CDOHOSTMachine |
Possible Values | IP Address or Host name of the machine, which is configured as CDOHOST to allow communication between Adeptia Suite and Exchange Server. |
Selection Criteria | Applicable only when MAPI is defined as mail protocol. CDOHOST allows Adeptia Suite to communicate with Exchange server. |
...
Description | Email Address of the person who is responsible for the administration of Adeptia Suite |
---|---|
Default Value | Depends on the value given in the Mail Server Configuration steps during installation. |
Possible Values | Any email address, which can be used to send the mail notifications. |
Selection Criteria | This property is automatically populated from the value given in the Mail Server Configuration step during installation. However, you can also define it, as needed. |
...
Description | User ID used to access the mailbox of the Adeptia Suite administrator |
---|---|
Default Value | Depends on the value given in the Mail Server Configuration steps during installation. |
Possible Values | User ID of the mail account, which is mentioned in systemAdminEmailID property. |
Selection Criteria | This property is automatically populated using the value given in the Mail Server Configuration step during installation. However, you can also manually define it. |
...
Description | Password used to access the mailbox of the Adeptia Suite administrator |
---|---|
Default Value | Depends on the value given in the Mail Server Configuration steps during installation. |
Possible Values | Password of the mail account, which is mentioned in systemAdminEmailID property. |
Selection Criteria | This property is automatically populated as per the value given in the Mail Server Configuration step during installation. However, you can also manually define it, as needed. |
...
Description | Subject of the mail notification to be sent when you change your mail password |
---|---|
Default Value | Password |
Possible Values | Subject string with which mail notification will be sent |
Selection Criteria | This value is used as the subject for mail notifications, which are sent by Adeptia Suite each time you change your mail password. |
...
Description | Specifies whether mail server is SSL enabled or not |
---|---|
Default Value | Depends on the value given in the Mail Server Configuration steps during installation. |
Possible Values | yes/no |
Selection Criteria | Select yes if the specified mail server requires a secure connection. Select no if the specified mail server does not require a secure connection. |
...
Description | Mail Server port |
---|---|
Default Value | Depends on the value given in the Mail Server Configuration steps during installation. |
Possible Values | SMTP port used by Mail Server |
Selection Criteria | This property is automatically populated as per the value given in the Mail Server Configuration step during installation. However, you can also manually define it, as needed. |
...
Description | Supports encoding in the mail notification activity |
---|---|
Default Value | ISO-8859-1 |
Possible Values | UTF-8,UTF-16, e.t.c. |
Comment | Character set encoding used to parse the data before sending mail |
abpm.changePasswordNotification.sendNewPassword
...
Description
...
Specifies whether you want to mail the new password, whenever a user's password is changed
...
Default Value
...
yes
...
Possible Values
...
yes/no
...
Selection Criteria
...
...
Description | Prefix that is appended to an activity name |
---|---|
Default Value | Blank |
Possible Values | Any string as per the naming convention policy of your organization. |
Selection Criteria | Prefix appended to an activity name |
LDAP AUTHENTICATION
abpm.ldap.enableLdap
Description | Enable or disable LDAP authentication in Adeptia Suite |
---|---|
Default Value | no |
abpm.ldap.provider.url
Description | Enter the URL to connect to LDAP server |
---|---|
Default Value | ldap://ldapServerName:portNumber |
abpm.ldap.enableLdapOverSSL
Description | Enable LDAP over SSL |
---|---|
Default Value | NA |
abpm.ldap.searchScopeLevel
Description | Enter the search scope level. Possible values are One, Object, Subtree |
---|---|
Default Value | Subtree |
Possible values | One, Object, or Subtree |
abpm.ldap.bindDN
Description | Enter the bindDN for LDAP server |
---|---|
Default Value | NA |
abpm.ldap.bindCredential
Description | Enter the password for the bindDN |
---|---|
Default Value | NA |
abpm.ldap.baseContextDN
Description | Enter the search baseDN for LDAP server |
---|---|
Default Value | NA |
abpm.ldap.baseFilter
Description | Enter the base search filter criteria |
---|---|
Default Value | NA |
abpm.ldap.rolesContextDN
Description | Enter the fixed DN for roles |
---|---|
Default Value | NA |
abpm.ldap.roleFilter
Description | Enter the role search filter criteria |
---|---|
Default Value | NA |
abpm.ldap.roleAttributeID
Description | Enter the role attribute ID |
---|---|
Default Value | NA |
abpm.ldap.roleAttributeIsDN
Description | Configure the flag if user's role attribute contains the fully distinguished name. |
---|---|
Default Value | no |
Possible Values | yes/no or true|false |
abpm.ldap.roleNameAttributeID
Description | Enter the name of the role attribute of user's role distinguished name |
---|---|
Default Value | NA |
...
Description | Enable or disable searching the role name attribute in user's distinguished name. |
---|---|
Default Value | yes |
Possible Value | yes or no, true or false |
abpm.ldap.administratorUsers
Description | Enter the name(s) of LDAP users (in comma separated format) that should be treated as sysadmin user in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.administratorGroups
Description | Enter the name(s) of LDAP groups (in comma separated format) that shall be treated as administrator group in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.developerUsers
Description | Enter the name(s) of LDAP users (in comma separated format) that shall be treated as developer user in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.developerGroups
Description | Enter the name(s) of LDAP groups (in comma separated format) that shall be treated as developer group in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.businessUsers
Description | Enter the name(s) of LDAP users (in comma separated format) that shall be treated as business user in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.businessGroup
Description | Enter the name(s) of LDAP groups (in comma separated format) that shall be treated as business group in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.alwaysDefaultGroupLogin
Description | Enable or disable login only with the default LDAP group in Adeptia |
---|---|
Default Value | NA |
...
Description | Enter the entity ID of group (created in Adeptia) that should be treated as default LDAP group |
---|---|
Default Value | NA |
abpm.ldap.enableDefaultGroupLogin
Description | Enable or disable login with default LDAP group in Adeptia |
---|---|
Default Value | NA |
abpm.ldap.enableSSO
Description | Enable or disable Single Sign On in Adeptia Suite |
---|---|
Default Value | no |
Possible Values | yes/no |
abpm.ldap.sso.filterClass
Description | Enter the class name that needs to be initiated for SSO authentication process |
---|---|
Default Value | yes |
Possible Values | yes/no |
abpm.ldap.enable.anonymous.login
Description | Enable or disable anonymous login through blank password in LDAP. |
---|---|
Default Value | yes |
Possible Values | yes/no |
...
abpm.multitentant.environment.enable
Description | Enable or disable a multitenant environment |
---|---|
Default Value | no |
Possible Values | yes/no |
Selection Criteria | This option is used to enable or disable a multitenant environment. |
...
Description | Maximum number of Records that will displayed in a page |
---|---|
Default Value | 20 |
...
Description | Maximum number of Records that will displayed in a manage page |
---|---|
Default Value | 20 |
abpm.pagination.page.size
Description | This is an option to set the maximum number of records to be displayed in one page |
---|---|
Default Value | 10 |
Possible Values | Positive Integer |
Selection Criteria | NA |
Comments | This option is used to set the number of records to be displayed in one page |
...
Description | Specifies the environment string. |
---|---|
Default Value | Development |
Possible Values | Any string to identify the Adeptia Suite. For Example : Development, Production etc. |
Selection Criteria | Used to identify the Adeptia Suite environment, when more than on Adeptia Suite environment is running in your organization. The value given here is displayed, when you click the About link. |
...
Description | Enables versioning in Adeptia Suite |
---|---|
Default Value | false |
Possible Values | true/false |
Selection Criteria | In case you want to version control your Adeptia Suite objects, then set this property as true. |
Comments | Sets Version Control Option as enabled or disabled |
...
Description | Protocol to access the SVN server |
---|---|
Default Value | SVN |
Possible Values | SVN/HTTP/HTTPS |
Selection Criteria | The protocol that you want to use to access the SVN server |
Comments | Version Control repository access protocol. Possible values are SVN, HTTP and HTTPS |
...
Description
...
IP address/Name of the host machine where SVN is installed
...
Default Value
...
blank
...
Possible Values
...
Selection Criteria
...
ENCODING
Property Name | Description | Default Value | Possible Value |
---|---|---|---|
abpm.characterSetEncoding | Default character set encoding to be used by all activities while parsing the data. However, you can also define the character set encoding at each activity level. Character set encoding defined at the activity level always takes precedence.
| ISO-8859-1 | Any possible character set encoding such as UTF-8 etc. |
LOGGING
Adeptia Suite uses Log4j for logging. Log4j has three main components - loggers, appenders, and layouts. These three components work together to log messages according to message type and level, and to control at runtime how these messages are formatted.
Adeptia Suite supports the following logging levels:
- DEBUG: The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
- INFO: The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
- ERROR: The ERROR level designates error events that might still allow the application to continue running.
The behavior of the logger is hierarchical. This is illustrated in the figure below.
DEBUG is the highest logging level and it logs messages of DEBUG, INFO, and ERROR level. ERROR is the lowest logging level and it only logs message of ERROR level.
Adeptia Suite supports following appenders:
- jdbc: Appends logs to a database.
- console: Appends log events to system.out or system.err using layout specified by the user. The default target is system.out.
- *file:* Appends log to a file.
All the appenders are case-sensitive and must be defined in lower case.
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
log4j.rootLogger | Specifies the default logging level of System and Process flow log. For example, INFO, console, jdbc. INFO indicates the logging level and console and jdbc indicates appender. The data can go to console, jdbc, or file. | INFO, console, jdbc | A combination of valid log level along with the appenders. |
log4j.logger.Event | Specifies the default logging level for Event logs. | INFO | ERROR/INFO/DEBUG |
com.mchange.v2.log.MLog | c3p0 Logging Library Name. | com.mchange.v2.log.FallbackMLog | |
com.mchange.v2.log.FallbackMLog.DEFAULT_CUTOFF_LEVEL | c3p0's System.err Fallback Logger Level. | WARNING | |
log4j.logger.org.springframework | Spring Logging Level. | ERROR | |
abpm.system.separateLogFile.enable | Enables or disables separate log files for System and Application level. By default, both system and application logs are written together in one file. All Kernel logs are written into Kernelapplication.log and Webrunner logs are written into WebRunnerapplication.log file. If the value of this property is set to true, only application logs (runtime logs) are written into these files. All System logs are written into Kernelsystem.log and Webrunnersystem.log files. | false | true or false |
abpm.system.logFile.location | Specifies the path where system logs files are stored. You can define an absolute path or any relative path where you want to store the file, for example, C:\Adeptia_systemLogFiles. The relative path shall be relative to ServerKernel/web folder. For example, to store the recovery files within /ServerKernel/web/logs/Adeptia_systemLogFiles, you can define the path as: | logs/systemlogs | Any absolute or relative path. |
Console Appender
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
log4j.appender.console | Log4j console Appender class. ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. The default target is System.out. | org.apache.log4j.consoleAppender | Any implementation of console Appender |
Database Appender
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
log4j.appender.jdbc | Log4j JDBC Appender class. The JDBC Appender writes messages into a database via JDBC. Multiple configuration options and parameters are supported. | comorg.apache.log4j.jdbcplus.jdbcAppender | Any implementation of JDBC Appender |
log4j.appender.jdbc.url | Specifies the JDBC URL to connect to log database. as per the value specified in the Log Database Configuration step during installation. | As specified during installation | Any valid JDBC URL |
log4j.appender.jdbc.dbclass | Database driver to connect to the log database. The value is provided by the JDBC driver used to connect to the log database. The value of this property is populated automatically as per the log database server type selected at the time of installation. | As per the log database selected during installation. | JDBC Driver of the log database, which is used to store the logs. |
log4j.appender.jdbc.username | The value of this property is populated automatically as per the username specified in the Log Database Configuration step at the time of installation. |
| Any username, which has permission to create tables, and inserts records in the log database. |
log4j.appender.jdbc.password | Password to access the log database. The value of this property is populated automatically using the password specified in the Log Database Configuration step at the time of installation. | As specified during installation | |
abpm.logs.dbType | Type of log database. | As specified during installation. |
File logging
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
log4j.appender.file | Log4j Rolling File Appender class. Rolling File Appender is used to backup the log files when they reach a certain size. | org.apache.log4j.RollingFileAppender | Any implementation of FileAppender |
log4j.appender.file.Webrunner.file | Name of the file in which WebRunner logs are written. | WebrunnerSystem.log | Any valid file name with .log extension. |
log4j.appender.file.Kernel.file | Name of the file in which Kernel logs are written. | KernelSystem.Log | Any valid file name with .log extension. |
log4j.appender.file. MaxBackupIndex | Defines the number of backup log files. When the log file reaches the specified size, it is renamed for backup purpose and a new file is created to store the new logs. This property specifies how many backup files to keep before they are deleted. | 10 | Any positive integer |
log4j.appender.file. MaxFileSize | Maximum size of the log file. When the log file reaches the specified size, it is archived and a new file is created to store the logs. | 10MB | Maximum size of the Kernel and WebRunner log files individually. |
Anchor securityproperty securityproperty
LOG ARCHIVAL DATABASE CONFIGURATION
securityproperty | |
securityproperty |
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
log4j.archival.jdbc.url | Specifies the JDBC URL to connect to the archival log database. The value of this property is populated automatically as per the value specified in the Log Database Configuration step during installation. | As specified during installation | Any valid JDBC URL |
logLog4j.archival.jdbc.dbclass | Determines the JDBC driver used to connect to the log database. The value of this property is populated automatically as per the log database server type selected at the time of installation. | As per the log database selected during installation | JDBC Driver of the log database, where the logs are archived. |
log4j.archival.jdbc.username | Username to access the archival log database. The value of this property is populated automatically from the username specified in the Log Database Configuration step at the time of installation. | As specified during installation | Any username, which has permission to create tables and insert records in the log database. |
log4j.archival.jdbc.password | Password to access the archival log database. The value of this property is populated automatically using the password specified in the Log Database Configuration step at the time of installation. | As specified during installation | |
abpm.logs.archival.dbType | Type of log database. | As specified during installation |
SECURITY
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
abpm.security.secretkeystorename | Adeptia Suite Secret keystore name. SecretKeys.Keystore is a protected database that holds keys that are generated when a user creates the Secret Key entity. These keys are used for Encryption, Decryption, and Schema services. Access to a keystore is guarded by a password defined in the abpm.security.secretkeypassword.encrypt property. You cannot change this password. In addition, each private key in a keystore can be guarded by its own password. | SecretKeys.Keystore | Any valid JCEKS Keystore |
abpm.security.passwordExpiryDays | Number of days after which the password expires. A value of 0 ensures that the password does not expire. | 0 | Any positive integer |
abpm.security.passwordExpiryMessageDisplayDays | Represents the number of days before the Adeptia User password expiry, the expiry warning is to be displayed. This warning is displayed at login. | 5 | Any positive integer |
abpm.security.activitycomments.enable | Adds a comment after an activity is either edited or added. | no | yes or no |
AUTHENTICATION AND AUTHORIZATION
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
java.security.auth.login.config | File where the JVM looks for security JAAS configuration. | etc/jaas.config | Any file containing the login module configurations |
Anchor MSP MSP
Mail Server Parameters
MSP | |
MSP |
These properties are used when an email notification generated by Adeptia Suite is sent. Adeptia Suite generates mail notifications when:
- You click on the Forgot Password link on the login page
- Any Mail Notification activity is executed
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
mailProtocol | Specifies the protocol used by an outgoing mail server. | smtp | smtp |
mailServer | IP address or hostname of the outgoing (SMTP) mail server. Applicable only when smtp is defined as mail protocol. The value of this property is populated automatically using the value given in the Mail Server Configuration step during installation. However, you can also manually define it, if needed. | Depends on the value given in the Mail Server Configuration steps during installation | IP address or hostname of the SMTP Server |
systemAdminEmailId | Email address of the person who is responsible for the administration of Adeptia Suite. The value of this property is populated automatically from the value given in the Mail Server Configuration step during installation. However, you can also define it, as needed. | Depends on the value given in the Mail Server Configuration steps during installation. | Any email address, which can be used to send the mail notifications. |
mailServerUserId | User ID to access the mailbox of the Adeptia Suite administrator. The value of this property is populated automatically using the value given in the Mail Server Configuration step during installation. However, you can also manually define it, if needed. | Depends on the value given in the Mail Server Configuration steps during installation. | User ID of the mail account, which is mentioned in systemAdminEmailID property. |
mailServerPassword | Password to access the mailbox of the Adeptia Suite administrator. The value of this property is populated automatically as per the value specified in the Mail Server Configuration step during installation. However, you can also manually define it, if needed. | Depends on the value given in the Mail Server Configuration steps during installation. | Password of the mail account, which is mentioned in systemAdminEmailID property. |
mailSubject | Subject of the email notification to be sent when you change your mail password. This value is used as the subject for mail notifications, which are sent by Adeptia Suite each time you change your email password | Password | Subject string with which mail notification will be sent |
abpm.notification.mailNotification.securityType | Mail security type. | SSL or TLS | |
abpm.mail.ssl.hostname.trust.verification | Set the value for this property to yes for enabling the Mail SMTP SSL Trust verification. To disable the Mail SMTP SSL Trust verification Set the value for this property to no. | yes | yes or no |
abpm.notification.mailNotification.port | Mail server port number. The value of this property is populated automatically as per the value specified in the Mail Server Configuration step during installation. However, you can also manually define it, if needed. | Depends on the value given in the Mail Server Configuration steps during installation. | SMTP port used by Mail Server |
abpm.notification.mailNotification.encoding | Supports encoding in the email notification activity. | ISO-8859-1 | UTF-8,UTF-16, etc. |
abpm.changePasswordNotification.sendNewPassword | Specifies whether you want to receive notification whenever a users password is changed. | yes | yes or no |
Anchor _Maintenance _Maintenance
Activity Naming Convention
_Maintenance | |
_Maintenance |
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
abpm.ActivityName.Prefix | Prefix that is appended to an activity name | Any string as per the naming convention policy of your organization. |
LDAP Authentication
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
abpm.ldap.enableLdap | Enable or disable LDAP authentication. | no | yes or no |
abpm.ldap.provider.url | Provider URL to connect to LDAP Server. | ldap://ldapServerName:portNumber | |
abpm.ldap.enableLdapOverSSL | Enable or disable LDAP connection over SSL. | ||
abpm.ldap.searchScopeLevel | Search scope level - One, Object, and Subtree. | Subtree | One, Object, or Subtree |
abpm.ldap.bindDN | The DN used to bind against the LDAP server for the user and roles queries. This is DN with read/search permissions on the baseContextDN and rolesContextDN values. It specifies DN of the admin user in LDAP server. | ||
abpm.ldap.bindCredential | Password for the bindDN. | ||
abpm.ldap.baseContextDN | Fixed DN of the context to start the user search from. | ||
abpm.ldap.baseFilter | Search filter to locate the context of the user to authenticate. The input username as obtained from the login module callback will be substituted into the filter where a "{0}" expression is seen. | ||
abpm.ldap.rolesContextDN | Fixed DN of the context to search for user roles. For Active Directory, this is the DN where the user account is. | ||
abpm.ldap.roleFilter | Search filter to locate the roles associated with an authenticated user. The login module callback will be substituted into the filter anywhere a "{0}"expression is seen. The authenticated userDN will be substitute into the filter where a "{1}" expression is seen. | ||
abpm.ldap.roleAttributeID | Name of the role attribute of the context that corresponds to the name of the role.
If the value of the roleAttributeIsDN property is set to true, this property is the DN of the context to query for the roleNameAttributeID attribute.
If the roleAttributeIsDN property is set to false, this property is the attribute name of the role name. | ||
abpm.ldap.roleAttributeIsDN | Flag indicating whether the user's role attribute contains the fully distinguished name of a role object, or the user's role attribute contains the role name. If the value of this property is false, the role name is taken from the value of the user's role attribute. If the value of this property is true, the role attribute represents the distinguished name of a role object. The role name is taken from the value of the roleNameAttributeId attribute of the corresponding object. The default value of this property is false. | no | yes/no or true|false |
abpm.ldap.roleNameAttributeID | Name of the role attribute of the context that corresponds to the name of the role. If the value of the roleAttributeIsDN property is set to true, this property is used to find the role object's name attribute. If the value of the roleAttributeIsDN property is set to false, this property is ignored. | ||
abpm.ldap.roleDN.searchRoleNameAttributeID | Enable or disable searching role name attribute in user's distinguished name. | yes | yes or no, true or false |
abpm.ldap.administratorUsers | Name(s) of LDAP user(s) (separated by comma) that will be treated as System Admin users in Adeptia Suite and Adeptia Connect. | ||
abpm.ldap.administratorGroups | Name(s) of LDAP group(s) (separated by comma) that will be treated as System Admin users in Adeptia Suite and Adeptia Connect. | ||
abpm.ldap.groupAdminUsers | Name(s) of LDAP user(s) (separated by comma) that will be treated as Group Admin users in Adeptia Suite and IT Users in Adeptia Connect. | ||
abpm.ldap.groupAdminGroups | Name(s) of LDAP group(s) (separated by comma) that will be treated as Group Admin users in Adeptia Suite and IT Users in Adeptia Connect. | ||
abpm.ldap.developerUsers | Name(s) of LDAP user(s) (separated by comma) that will be treated as Developer Users in Adeptia Suite and Business Users in Adeptia Connect. | ||
abpm.ldap.developerGroups | Name(s) of LDAP group(s) (separated by comma) that will be treated as Developer Users in Adeptia Suite and business Users in Adeptia Connect. | ||
abpm.ldap.businessUsers | Name(s) of LDAP users (separated by comma) that will be treated as Business Users in Adeptia Suite. | ||
abpm.ldap.businessGroup | Name(s) of LDAP groups (in comma separated format) that will be treated as Business Users in Adeptia Suite. | ||
abpm.ldap.group.itUsers | Name of the LDAP group that shall be treated as IT users in Adeptia Connect. | ||
abpm.ldap.alwaysDefaultGroupLogin | Enable or disable login only with default LDAP group in Adeptia. | ||
abpm.ldap.defaultLdapGroup | Entity id of the group (created in Adeptia) that shall be treated as default LDAP group. | ||
abpm.ldap.enableDefaultGroupLogin | Enable or disable login with default LDAP group in Adeptia. | ||
abpm.ldap.enableSSO | Enable or disable Single Sign-On in Adeptia Suite. | no | yes or no |
abpm.ldap.sso.filterClass | Class name that needs to be initiated for SSO authentication process. | yes | yes or no |
abpm.ldap.enable.anonymous.login | Enable or disable anonymous login through blank password in LDAP. | yes | yes or no |
abpm.ldap.referrals | Set the environment property referrals in LDAP. Possible values are ignore and follow. |
MULTITENANT ENVIRONMENT
Property Name | Description | Default Name | Possible Value |
---|---|---|---|
abpm.multitentant.environment.enable | Enable or disable a multitenant environment in SaaS mode. If the value is set to yes then while creating any activity you cannot assign any permission to others. In the Advanced Properties of any activity, the Others option gets hidden. This was needed because, in case of SaaS mode, users of different companies access the same instance of Adeptia Suite. | no | yes or no |
PAGINATION
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
abpm.pagination.taskmanager.page.size | Maximum number of records that will be displayed on a page. | 20 | Any positive integer |
abpm.pagination.managepage.page.size | Maximum number of records that will be displayed on a manage screen. | 20 | Any positive integer |
abpm.pagination.page.size | Maximum number of records that will be displayed on one page | 10 | Any positive integer |
Anchor Environment_Name Environment_Name
PERSONALIZATION
Environment_Name | |
Environment_Name |
Property Name | Description | Default Value | Possible Values |
---|---|---|---|
Home.Environment.DisplayName | Used to identify the Adeptia Suite environment when more than Adeptia Suite environment is running in your organization. | Development | Any string to identify the Adeptia Suite, for example, Development, Production, etc. |
VERSION CONTROL
Property Name | Description | Default Value | Poosible Value |
---|---|---|---|
abpm.versionControl.enable | Enables versioning in Adeptia Suite. | false | true or false |
abpm.versionControl.repository.access.protocol | Protocol to access the SVN server. | SVN | SVN/HTTP/HTTPS |
abpm.versionControl.repository.url | IP address/Name of the host machine where SVN is installed in the following syntax: svn://<hostname >:<SVN port> where, <hostname> is hostname or IP address of the host, where SVN is installed. |
...
Description | User Name of the Version Control Repository |
---|---|
Default Value | blank |
Possible Values | As per configuration of SVN Server |
Selection Criteria | The username, which is used to access SVN repository |
Comments | Version Control Repository User Name |
...
Description | Password of the Version Control Repository | ||
---|---|---|---|
Default Value | blank | ||
Possible Values svn://<hostname >:<SVN port><Absolute Path of the Repository including the Repository Name> | svn://<hostname >:<SVN port> | ||
abpm.versionControl.username | User Name of the Version Control Repository to access SVN repository. | As per configuration of SVN Server | |
abpm.versionControl.password | Password of the user specified in the abpm.versionControl.username. |
...
abpm.versionControl.projectPath | Description | This is the | password of the Version Control Repository|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Default Value | blank | ||||||||||||||||
Possible Values | Any absolute path or relative path with respect to ServerKernel folder. | ||||||||||||||||
Selection Criteria | path of a local working copy of version control project. When you Check-In the activity of Adeptia Suite for the first time, | the a local copy of SVN project is created in the path | , specified in the property abpm.versionControl.projectPath. At the same time, a project with the name specified in the above property | , is also created in the SVN. If | the Adeptia Suite is installed | of on Windows OS | , then you can define either the absolute path or relative path with respect to ServerKernel folder. For example, you can define the absolute path as | cC:/Adpetia/AdeptiaVersionControl. It means that the local SVN project is created within | cC: | \ /Adeptia | \/AdeptiaVersionControl folder. | like as . | \/AdeptiaVersionControl. In this case | the , a local SVN project is created within ServerKernel > AdeptiaVersionControl folder. The default value of the property abpm.versionControl.projectPath is . | \/AdeptiaVersionControl. You can provide the path other than the default path in the abpm.versionControl.projectPath property as per your requirement. If Adeptia Suite is installed on Linux OS then you must specify the absolute path for the Local Version Control Project | . , for example, /root/home/ADEPTIA/AdeptiaVersionControl/. |
...
Any absolute path or relative path with respect to ServerKernel folder. |
Client Authentication
Property Name | Description | Default Value | Possible Values | |
---|---|---|---|---|
abpm.versionControl.keystore.path | Description | Path of your keystore to use for client authentication | ||
Default Value | NA | |||
Possible Values | Any accessible location on local system | |||
Selection Criteria | . Applicable only when you use a an HTTPS protocol on an SVN server which is client authenticated | Comments | Version Control Client Keystore Path. |
...
Any accessible location on a local system. | ||
abpm.versionControl.keystore.password | Description | Set a password for your | keystore
---|---|---|
Default Value | Blank | |
Possible Values | NA | |
Selection Criteria | keystore. Applicable only when you use a an HTTPS protocol on an SVN server which is client authenticated. | |
Comments | Version Control Client Keystore Password | |
Anchor _Permission _Permission
_Permission | |
_Permission |
...
...
Description
...
Permission
Property Name | Description | Default Value | 750 |
---|---|---|---|
Possible Values | Combination of read, write, and execute permission that you want to give to each type of user (Owner, Other groups to which the owner belongs, and Users outside the owner's group) | ||
Possible Values | |||
abpm.activity.defaultPermission | Default permission mask while creating a new activity. The permission property contains a 3three-digit number, where:
7 = 4+2+1 (Read + Write + Execute)
| 750 | Combination of read, write, and execute permission that you want to give to each type of user (Owner, Other groups to which the owner belongs, and Users outside the owner's group) |