Client Side Properties

Client side properties are used for enabling the Infinity Process Platform client tools. The General Properties reside in a file with the name carnot.properties in the client class path. Portal Properties reside in specific properties files e.g. in the ipp-resources folder of a dynamic Web project of in the WEB-INF/classes folder of the according portal WAR.

General Properties

The general properties reside in the carnot.properties file:

AuditTrail

Parameters Property Description Default Scope Range
AuditTrail.Type String the type of the audit trail database used ORACLE local Range:
  • ORACLE - for Oracle
  • DB2 - for IBM DB2
  • MSSQL - for Microsoft SQL Server
  • MYSQL - for MySQL
  • MYSQL_SEQ - for MySQL with sequences
  • DERBY - for Apache Derby
  • POSTGRESQL - for PostgreSQL
  • SYBASE - for Sybase
AuditTrail.FixAutoCommit Boolean determines if a correction should be performed for commit behavior
false: no correction will be performed
true: set the autocommit option for a new database connection to false, in case it was true.
false local true, false
AuditTrail.UseLockTables Boolean Optionally use separate tables for pessimistic locking to improve concurrency. The default value depends on the database that is used with Infinity. It is set to blank and evaluated to TRUE for DB2, Sybase, Derby and MS-SQL databases. For other databases (Oracle, Postgres and MySQL), it is set to FALSE. local
AuditTrail.DriverClass String the name of the JDBC driver class to connect to the audit trail database local
AuditTrail.URL String the JDBC URL of the audit trail database local
AuditTrail.User String the database user to connect to the audit trail database local
AuditTrail.Password String the database password to connect to the audit trail database local
AuditTrail.XaDataSourceClass String the transaction datasource class of the database. local e.g.:
  • DB2:     com.ibm.db2.jcc.DB2XADataSource
  • Oracle:  oracle.jdbc.xa.OracleXADataSource
  • Derby:   org.apache.derby.jdbc.ClientXADataSource
  • MySQL: com.mysql.jdbc.jdbc2.optional.MysqlXADataSource
  • Sybase: com.sybase.jdbc3.jdbc.SybXADataSource
AuditTrail.DataSourceBean String the datasource bean class local Range:
  • carnotXaAuditTrailDataSourceLocal
  • carnotXaAuditTrailDataSourceLocalUrl
  • carnotXaAuditTrailDataSourceLocalSybase
AuditTrail.Instance String local
AuditTrail.Port String local
AuditTrail.Host String local
AuditTrail.Schema String If this configuration property is set to a schema name, this specified database schema is used instead of the default schema of the connecting user. Note that in that case the user needs to have all access rights to the tables and sequences in the specified schema. local
AuditTrail.InterceptJdbcCalls Boolean Determines JDBC exception handling. If set to true, an exception will directly be caught during the creation of a data value bean in the engine. It will be tried up to three times to load the instance of an already existing data value bean, which has been created meanwhile from a parallel thread. false true, false
AuditTrail.UsePreparedStatements String Optionally use prepared statements to improve performance.
  • true - use prepared statements
  • false - do not use prepared statements
  • mixed - use prepared statements additionally (deprecated)

Note
Value false should only be used for debugging purposes! In production scenarios please use true or mixed instead.

true local
  • true
  • false
  • mixed (deprecated)
AuditTrail.Logging.ProcessInstanceLogCodes String Enables logging of any changes to process data paths for auditing purpose. Data local

JNDI

Parameters Property Description Scope Range
JNDI.URL String the URL to connect to the application server remote +
JNDI.User String the user name used to get the remote initial context remote +
JNDI.Password String the password used to get the remote initial context remote +
JNDI.PackagePrefixes String a comma separated list of JNDI package prefixes remote
JNDI.InitialContextFactory String the class name of the initial context factory used to connect to the application server remote +
  • BES (for com.inprise.j2ee.jndi.CtxFactory)
  • JBOSS (for org.jnp.interfaces.NamingContextFactory)
  • NETWEAVER (for com.sap.engine.services.jndi.InitialContextFactoryImpl)
  • PRAMATI (for com.pramati.naming.client.PramatiClientContextFactory)
  • SAP (for com.sap.engine.services.jndi.InitialContextFactoryImpl)
  • SUN (for com.sun.appserv.naming.S1ASCtxFactory)
  • TRIFORK (for com.sun.jndi.cosnaming.CNCtxFactory)
  • WAS (for com.ibm.websphere.naming.WsnInitialContextFactory)
  • WEBLOGIC (for weblogic.jndi.WLInitialContextFactory)

General Settings

Parameters Property Description Default Scope
Dependent.Properties String comma-separated list of additional property files local and remote
XPath.StrictEvaluation Boolean Determines if strict XPath evaluation is enabled or not in XSD schemas.
  • true:
    an error is thrown (IllegalOperationException: MDL01123 - XPath 'FullName' is not defined.)
  • false:
    a warning is logged
For details please refer to section XSD Schema Validation of chapter XPDL Representation of Structured Data Types.
true
Carnot.Compatibility.Interactions.SupportDataMappingIds Boolean Determines if data mappings targeting the full parameter are supported as well (for a transition period only). false

Repository

Parameters Property Description Default Scope
Model.RepositoryDirectoryPath String the path to the directory containing the model repository %CARNOT_WORK%/dat local and remote

Model

Parameters Property Description Default Scope
carnot.engine.xml.encoding String Determines the encoding for model elements. Set this property to UTF-8 in case you use non-ASCII characters in model elements. ISO-8859-1
  • ISO-8859-1
  • UTF-8

Logging

Parameters Property Description Default Scope Range
Logging.Directory String the path to the directory containing the log files %CARNOT_WORK%/log local and remote
Logging.LogLevel String logging level. The logging system will only log messages with a higher or equal log level. INFO local and remote ERROR, WARN, INFO, DEBUG
Logging.Format String a log4j style output format pattern %d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%t] (%x) %c{2} - %m%n local and remote
Logging.MaxFileSize String maximum log file size in bytes local and remote
Logging.Filters String a comma separated list of package names or class names to restrict logging output. Leaving this property empty will produce output from all packages. local and remote

Service

Parameters Property Description Default Scope Range
WorkflowService.JndiName String the JNDI name of the WorkflowService remote
AdministrationService.JndiName String the JNDI name of the AdministrationService remote
UserService.JndiName String the JNDI name of the UserService remote
xxxService.Guarded
(e.g. QueryService.Guarded)
String option to switch on and off the security check for the service

Note
It is not recommended to change this property. Changing the value to false introduces a high risk of executing services without having a permission and hence might cause a severe security hole in the deployment!

true true: makes the grants set in the Infinity Process Modeler active.
false: makes access to all methods possible for all users without checking.
QueryService.JndiName String The JNDI name of the QueryService remote
Client.ServiceFactory String the service factory implementation used for retrieving Infinity Process Platform services with rich clients like Swing or Java applications. SpringServiceFactory local and remote org.eclipse.stardust.engine.api.spring.SpringServiceFactory
Web.ServiceFactory String the service factory implementation used for retrieving Infinity Process Platform services in Web environments like the Infinity Process Platform Portals. SpringServiceFactory local and remote org.eclipse.stardust.engine.api.spring.SpringServiceFactory
Carnot.Spring.ApplicationContextFile String the Spring application context file carnot-spring-services-context.xml
Carnot.Spring.ApplicationContextClass String The Spring application context class to be used. org.springframework.context.support.ClassPathXmlApplicationContext E.g. for JBoss use org.jboss.spring.vfs.context.VFSClassPathXmlApplicationContext.

XML Setup

Note that if these properties are not set in carnot.properties or anywhere else, the default value is used. With the properties set to a fully qualified name of the implementation class, this class will be explicitly instantiated and tried to be used. If the properties are set to an empty value the JAXP-setup of the JRE will be applied.

Parameters Property Default
Carnot.Xml.SAX.NonvalidatingParserFactory String "Aelfred"
Carnot.Xml.SAX.ValidatingParserFactory String ""
Carnot.Xml.DOM.NonvalidatingDocumentBuilderFactory String "Aelfred"
Carnot.Xml.DOM.ValidatingDocumentBuilderFactory String ""
Carnot.Xml.TrAX.TransformerFactory String ""

Security

Parameters Property Description Default Scope
Security.DefaultPartition String default value for target partition "default" local and remote
Security.DefaultDomain String default value for target domain "default" local and remote
Security.DefaultRealm String default value for user's realm "carnot" local and remote
Security.DefaultUser String default value for user's ID local and remote
Security.PromptPartition Boolean flag to provide the login screen with additional input field for partition false
Security.PromptDomain Boolean flag to provide the login screen with additional input field for domain false
Security.PromptRealm Boolean flag to provide the login screen with additional input field for realm false
Security.LoginUsersWithoutTimestamp String [* | userList ]:
  • *: no login timestamp logging for any user
  • userList: comma separated list of either user IDs or user OIDs.
Note: if a userList is parsed, any token is first tried to be parsed as user OID, and only tested against the user ID if parsing as OID fails. This has to be considered if user IDs are numeric.
Security.ResetPassword.TechnicalUser.Account String Account of the technical user. motu
Security.ResetPassword.TechnicalUser.Password String Password for the technical user. motu
Security.ResetPassword.TechnicalUser.Realm String Realm of the technical user credentials. carnot
Carnot.AuditTrail.Session.NoSessionTracking String Contains a comma separated list of user IDs (Accounts) and user OIDs, for which the session tracking is disabled for. Use * to disable session tracking for all users.
Carnot.AuditTrail.Session.ExpirationInterval Integer interval in minutes after a session is defined as expired. 60 minutes
Carnot.AuditTrail.Session.UserActivityUpdateDelay Integer delay in seconds until cached changes on user session entries are added to the database. 10 seconds
Credential.Provider String contains the name of a class extending the org.eclipse.stardust.engine.api.runtime.CredentialProvider class. local and remote
Secure.Session.Factory String determines the class implementing the org.eclipse.stardust.engine.api.ejb2.SecureSessionFactory local and remote
Security.Authentication.ConfigurationName String configuration name for authentication "carnot" local and remote
Security.Authentication.Sso.Saml.CustomSessionExpiry Integer Custom Portal SAML session expiry in minutes. Values <= 0 result in a session without expiry. null
Security.Authentication.Sso.Saml.UserAttributes String Defines a comma separated list of attribute names, which should be mapped to IPP user properties.
Security.Authentication.Sso.Saml.PartitionIdAttribute String Sets the name of the SAML attribute containing the partitionId. If the attribute value is not contained in the SAML response, the default partition is used for all incoming SAML responses. FirmName
Security.PasswordEncryption.Mode String determines, if password encryption mode is enabled or disabled. n
Security.LoginUsersWithoutTimestamp String contains a comma separated list of user OIDs or accounts. For users matching one of the entries no login timestamp is written to the audit trail.
ContentRepository.User String user JCR credential for usage in EJB scenario.
ContentRepository.Password String password JCR credential for usage in EJB scenario.

Mail Settings

Parameters Property Description
Mail.Sender String name of mail sender
Mail.Host String name of mail host

Caching Configuration for JCR Sources

Parameters Property Default Description
Carnot.Configuration.ContentStreamingThreshold Integer 500 KB Configures if a content should be downloaded via the download servlet. If the size of a document content is below this value, the content will be cached. If the content size is higher, the content download and upload is streamed using the dms-content servlet.
Carnot.Configuration.CacheTTL Integer 60000 ms The maximum caching time - if this time is exceeded, the least-recently-used JCR objects (cached in a fixed size map) will be removed.
Carnot.Configuration.MaximumCacheItems Integer 100 The maximum cache size - if this size is exceeded, the least-recently-used JCR objects (cached in a fixed size map) will be removed.

Upgrading

Parameters Property Default Description
Infinty.RTUpgrade.7_1_0.IgnoreMissingXPath Boolean false Determines if missing XPath exception should be ignored during runtime upgrade job from versions earlier than 7.1:
  • false: an exception is thrown for structured data values that cannot be migrated/analyzed because the XSD does not contain required information
  • true: the missing XPath is ignored and no exception is thrown

Portal Properties

General Portal Properties

Parameters Default value Range Description
Carnot.DateFormatter "dd.MM.yy HH:mm" (German language pack), or "MM/dd/yy hh:mm a" (English language pack) date format the date format for Workflow Execution Perspective, Administration Perspective or Control Center.
Carnot.Client.Search.CaseSensitive true true, false Determines if the search functionality in filtering processes are case sensitive or not.
Carnot.Configuration.UseDocumentRepository true true, false If set to true, changed user preferences are stored for the next session and will not be deleted during a logout.
If set to false, user preferences are not saved and the default Infinity Process Platform Portal view preferences (like for example the page size) are used.
Please note that no user response is given while saving preferences in case this property is set to false.
Carnot.Login.Skin.StyleSheet login.css Determines the cascading style sheet to be used for the Portal login page.
Carnot.Client.Caching.ClientXPathMap.Enabled true true, false Parameter to disable or enable XPathMap caching.
Carnot.Client.Caching.ProcessInstanceContext.Enabled false true, false enables mechanism to cache process instances in the Infinity Process Platform Portal.
Carnot.Client.Caching.ProcessInstanceContext.CacheSize Integer cache size for caching the process instances.
Carnot.Client.Caching.ProcessInstanceContext.CacheTTL Integer limit on the period of time for caching
Carnot.Client.NonSingletonJsfPhaseListeners false Boolean determines the broadcasting behavior of phase listener multicasting
  • false: prevents JSF Phase event broadcasting to non-singleton Spring beans
  • true: restores old behavior with non-singleton multicasting
Carnot.Client.Ui.User.NamePattern - String This property serves to use the old behavior for displaying the user name in the Portal. By default, the new behavior, where the partition preference for user name formatting is used, is applied. To apply the old behavior instead to display the user with a custom user specific pattern, this property should be added with value "PerUser".

Note
The old behavior considerably reduces Portal responsiveness and is considered to be phased out during the next major release cycle!

Infinity Process Platform Portal

Parameters Default value Range Description
Carnot.BpmClient.Features.AssemblyLineTaskAssignment true true, false Determines, if assembly line mode is supported, in case it is defined during modeling.
Carnot.ProcessPortal.AssemblyLineActivityProvider DefaultAssemblyLineActivityProvider Assembly line activity provider class Implements the logic to decide which assembly line has to be activated next. Has to implement the interface IAssemblyLineActivityProvider. In case your act_inst_history table has a complete history available for all necessary activity instances, you can use the org.eclipse.stardust.engine.api.web.jsf.processportal.common.AiHistoryAwareAssemblyLineActivityProvider to increase the performance.
Carnot.BpmClient.Features.AssemblyLinePushService false true, false Enables option to immediately display next assembly line mode activity after completing previous activity.
Carnot.ProcessPortal.FilterProviders filters, comma-separated and equal to sign Option to set global filters for the worklist table.
Carnot.ProcessPortal.FilterProvider.filtername filter class Has to implement the interface IFilterProvider.
GUI.eagerNextActivityActivation Boolean Indicates if the Infinity Portal should automatically launch follow up activities when the current activity instance gets completed. true
GUI.nextActivityPollIterations 3 Long Number of poll attempts when no synchronous follow up activity instance is available for launching.
GUI.nextActivityPollDelay 300 milliseconds Specifies the time in milliseconds consecutive poll attempts are delayed.
Carnot.Threshold.Provider org.eclipse.stardust.ui.web.bcc.jsf.ThresholdProvider A valid class name (including package name) that implements the org.eclipse.stardust.ui.web.bcc.jsf.IThresholdProvider interface Controls the priority state displayed in the Control Center - Process Manager view (Priority Overview table)