Systems
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 Connect 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 Connect 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 Connect 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: log4j.rootLogger |
|---|
| Description |
| 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. You can also define the logging level at each process flow level. Logging level, defined at process flow level always takes precedence. |
| Property: log4j.logger.Event |
| Description |
| Specifies the default logging level for Event logs. |
| **Property:**com.mchange.v2.log.MLog |
| Description |
| c3p0 Logging Library Name. |
| Property: com.mchange.v2.log.FallbackMLog.DEFAULT_CUTOFF_LEVEL |
| Description |
| c3p0's System.err Fallback Logger Level. |
| Property: log4j.logger.org.springframework |
| Description |
| Spring Logging Level. |
| **Property:**abpm.system.separateLogFile.enable |
| Description |
| 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 Webrunner system.log files. |
| Property: abpm.system.logFile.location |
| Description |
| 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 Server Kernel/web folder. For example, to store the recovery files within /ServerKernel/web/logs/Adeptia_system LogFiles, you can define the path as: ./logs/ Adeptia_systemLogFiles. |
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. |
LOG ARCHIVAL DATABASE CONFIGURATION
| 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: abpm.security.secretkeystorename |
|---|
| Description |
| Adeptia Connect 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. |
| **Property:**abpm.security.passwordExpiryDays |
| Description |
| Number of days after which the password expires. A value of 0 ensures that the password does not expire. |
| **Property:**abpm.security.passwordExpiryMessageDisplayDays |
| Description |
| Represents the number of days before the Adeptia User password expiry, the expiry warning is to be displayed. This warning is displayed at login. |
| Property: abpm.security.activitycomments.enable |
| Description |
| Adds a comment after an activity is either edited or added. |
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 |
Mail Server Parameters
These properties are used when an email notification generated by Adeptia Connect is sent. Adeptia Connect 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 Connect. 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 Connect 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 Connect 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 Connect 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 |
Activity Naming Convention
| 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: abpm.ldap.enableLdap |
|---|
| Description |
| Enable or disable LDAP authentication. |
| Property: abpm.ldap.provider.url |
| Description |
| Provider URL to connect to LDAP Server. |
| **Property:**abpm.ldap.enableLdapOverSSL |
| Description |
| Enable or disable LDAP connection over SSL. |
| **Property:**abpm.ldap.searchScopeLevel |
| Description |
| Search scope level - One, Object, and Subtree. |
| Property: abpm.ldap.bindDN |
| Description |
| 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. |
| Property: abpm.ldap.bindCredential |
| Description |
| Password for the bindDN. |
| Property: abpm.ldap.baseContextDN |
| Description |
| Fixed DN of the context to start the user search from. |
| Property: abpm.ldap.baseFilter |
| Description |
| 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. |
| **Property:**abpm.ldap.rolesContextDN |
| Description |
| Fixed DN of the context to search for user roles. For Active Directory, this is the DN where the user account is. |
| Property: abpm.ldap.roleFilter |
| Description |
| 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. |
| Property: abpm.ldap.roleAttributeID |
| Description |
| 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 roleAttributeIsDNproperty is set to false, this property is the attribute name of the role name. |
| Property: abpm.ldap.roleAttributeID |
| Description |
| 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 roleAttributeIsDNproperty is set to false, this property is the attribute name of the role name. |
| Property: abpm.ldap.roleAttributeIsDN |
| Description |
| 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. |
| Property: abpm.ldap.roleNameAttributeID |
| Description |
| 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 roleAttributeIsDNproperty is set to false, this property is ignored. |
| Property: abpm.ldap.roleDN.searchRoleNameAttributeID |
| Description |
| Enable or disable searching role name attribute in user's distinguished name. |
| Property: abpm.ldap.administratorUsers |
| Description |
| Name(s) of LDAP user(s) (separated by comma) that will be treated as System Admin users in Adeptia Suite and Adeptia Connect. |
| **Property:**abpm.ldap.administratorGroups |
| Description |
| Name(s) of LDAP group(s) (separated by comma) that will be treated as System Admin users in Adeptia Suite and Adeptia Connect. |
| Property: abpm.ldap.groupAdminUsers |
| Description |
| 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. |
| Property: abpm.ldap.groupAdminGroups |
| Description |
| 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. |
| Property: abpm.ldap.developerUsers |
| Description |
| 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. |
| Property: abpm.ldap.developerGroups |
| Description |
| 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. |
| Property: abpm.ldap.businessUsers |
| Description |
| Name(s) of LDAP users (separated by comma) that will be treated as Business Users in Adeptia Connect. |
| **Property:**abpm.ldap.businessGroup |
| Description |
| Name(s) of LDAP groups (in comma separated format) that will be treated as Business Users in Adeptia Connect. |
| Property: abpm.ldap.group.itUsers |
| Description |
| Name of the LDAP group that shall be treated as IT users in Adeptia Connect. |
| Property: abpm.ldap.alwaysDefaultGroupLogin |
| Description |
| Enable or disable login only with default LDAP group in Adeptia. |
| Property: abpm.ldap.defaultLdapGroup |
| Description |
| Entity id of the group (created in Adeptia) that shall be treated as default LDAP group. |
| **Property:**abpm.ldap.enableDefaultGroupLogin |
| Description |
| Enable or disable login with default LDAP group in Adeptia. |
| **Property:**abpm.ldap.enableSSO |
| Description |
| Enable or disable Single Sign-On in Adeptia Connect. |
| Property: abpm.ldap.sso.filterClass |
| Description |
| Class name that needs to be initiated for SSO authentication process. |
| **Property:**abpm.ldap.enable.anonymous.login |
| Description |
| Enable or disable anonymous login through blank password in LDAP. |
| **Property:**abpm.ldap.referrals |
| Description |
| 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 Connect. | 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 |
PERSONALIZATION
| Property Name | Description | Default Value | Possible Values |
|---|---|---|---|
| Home.Environment.DisplayName | Used to identify the Adeptia Connect environment when more than Adeptia Connect environment is running in your organization. | Development | Any string to identify the Adeptia Connect, for example, Development, Production, etc. |
VERSION CONTROL
| Property: abpm.versionControl.enable |
|---|
| Description |
| Enables versioning in Adeptia Connect. |
| Property: abpm.versionControl.repository.access.protocol |
| Description |
| Protocol to access the SVN server. |
| Property: abpm.versionControl.repository.url |
| Description |
| 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. <port> is the port at which SVN is running. By default, SVN uses 3690. For example, if SVN Server is installed on a host with IP address 192.168.1.1 and using port 3690 then the URL will be: svn://192.168.1.1:3690/ In case SVN is installed on Linux OS, you need to provide the absolute path of the Version Control Repository in the following syntax: svn://<hostname >:<SVN port><Absolute Path of the Repository including the Repository Name> |
| **Property:**abpm.versionControl.username |
| Description |
| User Name of the Version Control Repository to access SVN repository. |
| **Property:**abpm.versionControl.password |
| Description |
| Password of the user specified in the abpm.versionControl.username. |
| **Property:**abpm.versionControl.projectPath |
| Description |
| This is the path of a local working copy of version control project. When you Check-In the activity of Adeptia Connect for the first time, 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 Adeptia Connect is installed 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 C:/Adpetia/AdeptiaVersionControl. It means that the local SVN project is created within C:/Adeptia/AdeptiaVersionControl folder. You can also define the relative path as ./AdeptiaVersionControl. In this case, 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 Connect is installed on Linux OS then you must specify the absolute path for the Local Version Control Project, for example, /root/home/ADEPTIA/AdeptiaVersionControl/. |
Client Authentication
| Property Name | Description | Default Value | Possible Values |
|---|---|---|---|
| abpm.versionControl.keystore.path | Path of your keystore to use for client authentication. Applicable only when you use an HTTPS protocol on an SVN server which is client authenticated. | Any accessible location on a local system. | |
| abpm.versionControl.keystore.password | Set a password for your keystore. Applicable only when you use an HTTPS protocol on an SVN server which is client authenticated. |
Permission
| Property Name | Description | Default Value | Possible Values |
|---|---|---|---|
| abpm.activity.defaultPermission | Default permission mask while creating a new activity. The permission property contains a three-digit number, where: • 1st digit represents the level of permission for Owner. • 2nd digit represents the level of permission for other groups to which the owner belongs. • 3rd digit represents the level of permission for users outside the owner's group. There are three levels of permissions for every level of user: • Read • Write • Execute Each level has a specific number assigned to it. • Read - 4 • Write - 2 • Execute - 1 So based on these numbers, you can assign each type of user in any of the following digits: 7 = 4+2+1 (Read + Write + Execute) • 6 = 4+2 (Read + Write) • 5 = 4+1 (Read + Execute) • 4 = 4 (Read) • 3 = 2+1 (Write + Execute) • 2 = 2 (Write) • 1 = 1 (Execute) For Example - 750 (default value) means each user has the default permissions: Administrator - 7 - Read + Write + Execute Group - 5 - Read + Execute Other - 0 - None | 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) |