ENCODING
abpm.characterSetEncoding
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. |
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 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.
The behavior of the logger is hierarchical. This is illustrated in the figure below.
Figure 1: Logging Level Behavior
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.
For more details on Log4j refer to http://logging.apache.org/log4j
log4j.rootLogger
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. |
log4j.logger.Event
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 the Event log. |
com.mchange.v2.log.MLog
Description | c3p0 Logging Library Name |
---|---|
Default Value | com.mchange.v2.log.FallbackMLog |
com.mchange.v2.log.FallbackMLog.DEFAULT_CUTOFF_LEVEL
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. |
abpm.system.separateLogFile.locationenable
Description | Path where system log file is stored. |
---|---|
Default Value | logs/systemlogs |
Possible Values | Any absolute or relative path. |
Selection Criteria | Specifies the path where system logs files are stored. This property is applicable only when abpm.system.logFile.location is set to true. |
Console Appender
log4j.appender.console
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. |
Database Appender
log4j.appender.jdbc
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. |
log4j.appender.jdbc.url
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. |
log4j.appender.jdbc.dbclass
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. |
log4j.appender.jdbc.username
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. |
log4j.appender.jdbc.password
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. |
abpm.logs.dbType
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. |
File logging
log4j.appender.file
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 |
log4j.appender.file.Webrunner.file
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. |
log4j.appender.file.Kernel.file
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. |
log4j.appender.file. MaxBackupIndex
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. |
log4j.appender.file. MaxFileSize
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. |
LOG ARCHIVAL DATABASE CONFIGURATION
log4j.archival.jdbc.url
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. |
logLog4j.archival.jdbc.dbclass
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. |
log4j.archival.jdbc.username
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. |
log4j.archival.jdbc.password
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. |
abpm.logs.archival.dbType
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. |
SECURITY
abpm.security.secretkeystorename
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. |
abpm.security.passwordExpiryDays
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. |
abpm.security.passwordExpiryMessageDisplayDays
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. |
abpm.security.activitycomments.enable
Description | Adds a comment after the activity is either edited or an activity is added |
---|---|
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. |
If you enable/disable comments when you are already working in Process Designer or Data Mapper applet, you need to restart the respective applet.
AUTHENTICATION AND AUTHORIZATION
java.security.auth.login.config
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 |
MAIL SERVER PARAMETERS
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
MailProtocol
Description | Specifies the protocol used by an outgoing mail server |
---|---|
Default Value | smtp |
Possible Values | smtp/mapi |
Selection Criteria | Select smtp if the mail server is using the SMTP protocol. |
mailServer
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. |
Domain
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. |
CDOHostName
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. |
systemAdminEmailId
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. |
mailServerUserId
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. |
mailServerPassword
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. |
Mailsubject
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. |
abpm.notification.mailNotification.sslEnabled
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. |
abpm.notification.mailNotification.port
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. |
abpm.notification.mailNotification.encoding
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 | Select yes, if you want the new password to be sent in the notification mail, whenever a user password is changed. |
ACTIVITY NAMING CONVENTION
abpm.ActivityName.Prefix
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 |
Possible Values | yes/no |
Selection Criteria | Applicable when you want to enable or disable LDAP authentication in Adeptia Suite. |
abpm.ldap.provider.url
Description | Enter the URL to connect to LDAP server |
---|---|
Default Value | ldap://ldapServerName:portNumber |
Selection Criteria | Applicable when LDAP authentication is enable in Adeptia Suite. |
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 |
Selection Criteria | LDAP server may have different level of hierarchy. You can configure search scope by configuring this property. Use one for oneLevel scope, object for objeceLevel scope and subtree for subtreeLevelScope |
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 |
Selection Criteria | The name of the role attribute of the context which corresponds to the name of the role. If the roleAttributeIsDN property is set to true, this property is used to find the role object's name attribute. If the roleAttributeIsDN property is set to false, this property is ignored. |
abpm.ldap.roleDN.searchRoleNameAttributeID
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 |
abpm.ldap.defaultLdapGroup
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 |
MULTITENANT ENVIRONMENT
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. This property is added to allow Adeptia Suite to be configured in SaaS mode. In case this property is set to true, 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. |
PAGINATION
abpm.pagination.taskmanager.page.size
Description | Maximum number of Records that will displayed in a page |
---|---|
Default Value | 20 |
Selection Criteria | You can control to display the number of records in a task manager page. |
abpm.pagination.managepage.page.size
Description | Maximum number of Records that will displayed in a manage page |
---|---|
Default Value | 20 |
Selection Criteria | You can control to display the number of records in a manage page. |
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 for a log page (old one-JSP), which is not changed to EXTJS. |
PERSONALIZATION
Home.Environment.DisplayName
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 Adeptia Suite environment is running in your organization. The value given here is displayed, when you click the About link. |
VERSION CONTROL
abpm.versionControl.enable
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 |
abpm.versionControl.repository.access.protocol
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 |
abpm.versionControl.repository.url
Description | IP address/Name of the host machine where SVN is installed |
---|---|
Default Value | blank |
Possible Values | svn://<hostname >:<SVN port> |
Selection Criteria | Define the hostname or IP address of SVN host according to the following syntax: |
abpm.versionControl.username
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 |
abpm.versionControl.password
Description | Password of the Version Control Repository |
---|---|
Default Value | blank |
Possible Values | As per configuration of SVN Server |
Selection Criteria | Password of the user specified in the abpm.versionControl.username |
abpm.versionControl.projectPath
Description | This is the path of local working copy of version control project |
---|---|
Default Value | blank |
Possible Values | Any absolute path or relative path with respect to ServerKernel folder. |
Selection Criteria | When you Check-In the activity of Adeptia Suite for the first time, the local copy of SVN project is created in path, specified in the property abpm.versionControl.projectPath. |
Client Authentication
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 HTTPS protocol on an SVN server which is client authenticated |
Comments | Version Control Client Keystore Path |
abpm.versionControl.keystore.password
Description | Set a password for your keystore |
---|---|
Default Value | Blank |
Possible Values | NA |
Selection Criteria | Applicable only when you use a HTTPS protocol on an SVN server which is client authenticated |
Comments | Version Control Client Keystore Password |
Permission
abpm.activity.defaultPermission
Description | Default permission mask while creating new activity |
---|---|
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) |
Selection Criteria | The permission property contains a 3-digit number, where:
7 = 4+2+1 (Read + Write + Execute)
|