Advanced Configuration

From Obsidian Scheduler
Jump to: navigation, search

Obsidian requires some initial configuration parameters for database connection information and desired authentication mechanisms. The installer takes care of configuring these as provided. For your reference should you wish to manually create/edit these, note the details below.

Configuration Details

The following sections show the available properties and sample values that can be used in the com.carfey.properties properties file. See Properties File for more details on this file.

Authentication Properties

# Comment out the native authenticator setup
#com.carfey.suite.security.Authenticator=com.carfey.suite.security.DBAuthenticator

#Set your LDAP info here
com.carfey.suite.security.Authenticator=com.carfey.suite.security.LdapAuthenticator
# As of Obsidian 2.1.1, you can specify the attribute type used in building up the distinguished name (dn). If unspecified, defaults to cn
com.carfey.suite.security.LdapAuthenticator.dn.attribute=uid
com.carfey.suite.security.LdapAuthenticator.dn.base=ou=people,o=MyOrgHere
com.carfey.suite.security.LdapAuthenticator.url=ldap://localhost:10389
# As of Obsidian 2.1.1, you can specify the SECURITY_AUTHENTICATION. Defaults to simple. 
com.carfey.suite.security.LdapAuthenticator.securityAuthentication=simple
# Any necessary additional information such as Provider, Principal and Host will need to be handled in your custom class extending LdapAuthenticator.

# As of Obsidian 3.5.1, you can login via an LDAP attribute that is not part of the dn. A matching entry is found in the LDAP Directory (using anonymous or a fixed lookup account) 
# after which the dn attribute above is retrieved to perform the user's authentication. The following 5 attributes are only used for this type of lookup and authentication.
com.carfey.suite.security.LdapAuthenticator.lookupDnAttribute=false
# As of Obsidian 3.5.1, this is the attribute name that is being searched for in the LDAP directory to build the dn for eventual authentication.
com.carfey.suite.security.LdapAuthenticator.loginAttribute=sAMAccountName
# As of Obsidian 3.5.1, this determines if these lookups will be done anonymously (without a session authenticated by user/password)
com.carfey.suite.security.LdapAuthenticator.anonymousEnabled=false
# As of Obsidian 3.5.1, if anonymous lookups are not permitted or desired, provide the dn and password to be used for lookups. Typically, a read-only account with 
# read rights to the LDAP entries and attributes in question is sufficient.
com.carfey.suite.security.LdapAuthenticator.searchUserFullDn=cn=ObsidianLDAPReadOnly,ou=people,o=MyOrgHere
com.carfey.suite.security.LdapAuthenticator.searchPassword=password

# Configure who may access the web app, based on LDAP group membership
com.carfey.suite.security.LdapAuthenticator.accessDN=cn=SchedulerAccess,ou=groups,o=MyOrgHere

# Configure the Write role used in the admin web app, based on LDAP group membership (by default, users may only read)
com.carfey.suite.security.LdapAuthenticator.role.write.dn=cn=SchedulerWrite,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.write.roleName=Write

# Configure the Admin role used in the admin web app, based on LDAP group membership (users may configure system parameters, etc).
com.carfey.suite.security.LdapAuthenticator.role.admin.dn=cn=SchedulerAdmin,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.admin.roleName=Admin

# Configure the LimitedRead role used in the admin web app, based on LDAP group membership (by default, users may only read)
com.carfey.suite.security.LdapAuthenticator.role.limitedRead.dn=cn=SchedulerLimitedRead,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.limitedRead.roleName=LimitedRead

# Configure the APIrole used by the REST API, based on LDAP group membership
com.carfey.suite.security.LdapAuthenticator.role.api.dn=cn=SchedulerAPI,ou=groups,o=MyOrgHere
# No need to alter this
com.carfey.suite.security.LdapAuthenticator.role.api.roleName=API

SMTP Mail Properties

# Email configuration for notifications, if desired
#for straight up open relay, just specify the host using
mail.smtp.host=smtp.myopenrelayhost.com
mail.smtp.port=port 
#(standard ports are 25, 465 for SSL, 587 for TLS)

#for using TLS and SSL, provide these as necessary
mail.smtp.socketFactory.port=port
mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
mail.smtp.auth=true
[email protected]
mail.smtp.password=PASSWORD


# As of Obsidian 2.5.0, we support JNDI lookups for email sessions. All other email properties can be excluded.
mail.session.jndi.path=java:comp/env/mail/session

Database Properties

# Database configuration
com.carfey.obsidian.db.url=jdbc:mysql://localhost/obsidian
com.carfey.obsidian.db.userId=user
com.carfey.obsidian.db.password=pass

# Sample JDBC URL formats for all platforms
#com.carfey.obsidian.db.url=jdbc:mysql://localhost/obsidian
#com.carfey.obsidian.db.url=jdbc:h2:C:/dev/workspace/obsidian;MVCC=TRUE
#com.carfey.obsidian.db.url=jdbc:oracle:thin:@localhost:1521:obsidian
#com.carfey.obsidian.db.url=jdbc:postgresql://localhost:5432/obsidian
#com.carfey.obsidian.db.url=jdbc:jtds:sqlserver://localhost:1433;databaseName=obsidian

# As of Obsidian 2.5.0, we support JNDI lookups for database connectivity.
com.carfey.obsidian.db.url=java:comp/env/jdbc/obsidian
com.carfey.obsidian.db.jndiType=mysql
#com.carfey.obsidian.db.jndiType=mysql is also used for MariaDB
#com.carfey.obsidian.db.jndiType=oracle
#com.carfey.obsidian.db.jndiType=postgresql
#com.carfey.obsidian.db.jndiType=h2
#com.carfey.obsidian.db.jndiType=sqlserver

# Table prefix may be used to add a prefix to tables and related database objects. It must be 6 or fewer characters and can contain letters or underscores. Available as of version 2.0.
com.carfey.obsidian.db.tablePrefix=OBSDN_

# For Oracle databases, when Obsidian's tables exist in a different schema from the user specified above, or if the user does not default to the schema matching its name, specify the target schema here. Available as of version 2.1.
# For details on the required privileges to run with an alternate user, see http://obsidianscheduler.com/wiki/Obsidian_Tables#Oracle_Privileges
# This same configuration item can be used to configure the Postgresql schema. If unspecified, the default is public. Available as of Obsidian 2.1.1. 
# If using JNDI and Oracle/Postgresql, we recommend you set this value to ensure best performance.
com.carfey.obsidian.db.schema=obsidian

#default max connections per pool if not specified is 50
com.carfey.obsidian.db.maxConnections=40

#default millis timeout to retrieve available connection from pool if not specified is 2000
com.carfey.obsidian.db.connectionTimeout=2000

# As of 3.4.0, you can disable pooling of connections, which is suggested only if using another connection pool through JNDI. When true, maxConnections is ignored. 
# When a JNDI data source is selected in the installer, this is set to true by default.
com.carfey.obsidian.db.disablePooling=true

# As of 4.3.0, Oracle database supports configured wait time.
com.carfey.obsidian.db.timedLockWaitEnabled=true (default)
com.carfey.obsidian.db.timedLockWaitSeconds=1 (default, prior to 4.3.0, indefinite wait)

Miscellaneous Properties

# If you wish to change the tokens used to reference global parameters in your job configuration, use the following two values:
global.param.start.token={{
global.param.end.token=}}

# Populated by the installer, these values can be used to initialize licence key information into the database.
com.carfey.obsidian.licence.key=licenceKey
com.carfey.obsidian.licence.name=licenceeName

# As of 2.8.0, if you have issues with classloading (e.g. in Grails), this flag enables usage of the context classloader .
com.carfey.jdk.useContextClassLoader=true

# As of 2.9.0, you can set the scheduler host designator name multiple times in the same JVM by using this parameter:
com.carfey.obsidian.schedulerDesignation=obsidian-dev

# As of 3.0.0, Job Forking can be enabled and configured per node
com.carfey.obsidian.jvmJobForkingEnabledOnThisNode=true
# This property is the location of the fork scripts. Obsidian is bundled with obsidianForkedJob.bat and obsidianForkedJob.sh. These are the expected script names.
com.carfey.obsidian.forkedJobScriptLocation=/Obsidian-3.0.0
# Use the following optional property if you need to override the default classpath that is built using the contents of the standalone directory.
# This allows for job forking support in embedded and even webapp deployments. Use the classpath format supported by your operating system.
#com.carfey.obsidian.forkedJobscriptClasspathOverride=
# Use the following optional property if you wish to include database configuration parameters as arguments passed to the forking scripts and the target forked Obsidian class.
# For example, you may need to do this if your configuration is done via System Property overrides or programmmatically in your embedded Obsidian instance.
#com.carfey.obsidian.jvmJobForkingIncludeDbSysParms=true

# Obsolete as of 4.0.0. As of 3.4.0, the base URL used to resolve links in the Obsidian web app can be overridden. This is typically only required when a load balancer or proxy is used to access Obsidian.
com.carfey.obsidian.baseHrefUrl=http://myhost:8080/obsidian

# As of 4.3.0, description/parameter formatting is supported. Custom formatter (com.carfey.ops.job.config.formatter.Formatter) supported via this parameter.
com.carfey.obsidian.formatterClass=com.carfey.ops.job.config.formatter.MarkdownFormatter (default)

# As of 4.4.0, support for running DDL outside Obsidian and applying only the data portion of upgrades. May require incremental upgrades. Contact support for assistance. Enabled with the following:
com.carfey.obsidian.runner.skipDDL=true

Table Prefixes

As shown in full configuration reference, a table name prefix may be specified to create Obsidian tables with names beginning with a specified string.

# Table prefix may be used to add a prefix to tables and related database objects. It must be 6 or fewer characters and can contain letters or underscores. Available as of version 2.0.
com.carfey.obsidian.db.tablePrefix=OBSDN_

Properties File

The above configuration must reside in a properties file named com.carfey.properties found according to the rules of ClassLoader.getResource. Some possibilities include WEB-INF/classes/com.carfey.properties, a com.carfey.properties file in a directory which is explicitly added to the classpath, or at the root of a jar file as is done in obsidian-props.jar for standalone deployments. Prior to Obsidian 3.6, this file had to exist on the classpath, even if only using the override options below to configure Obsidian.

Instead of using a classpath resource, you can specify an external properties file using the Java system property carfey.properties.file. All expected properties must be specified in either the default com.carfey.properties file on the classpath or in the override file. Any properties found in both files will use the override file's values. Usage: -Dcarfey.properties.file=/home/obsidian/obsidian.properties.

As of Obsidian 2.1, you may also use a programmatic properties override. Simply call com.carfey.jdk.sys.Configurator.setOverride(Properties props) as early as possible in the application startup. To quote the javadoc of this method, For use as a programmatic properties override. This must be called before any classes are accessed either through invocation or class initialization that may require access to configuration done through properties. Best if done as early as possible in code, perhaps first in an entry point class that does little else and then hands-off to existing entry point.

As of Obsidian 4.4, you may specify these values as System Properties or Environment Variables. Duplicated values are resolved as follows:

  1. System Property
  2. Environment Variable - overridden by System Property
  3. Properties - overridden by Environment Variable and System Property

Notifications Configuration

Sending notifications requires SMTP configuration to be defined in the Obsidian properties file. The properties file reference at the beginning of this page includes SMTP configuration details.

In addition to the properties file, you can configure some Notifications settings to tweak how your emails are sent. These values are configurable under the Dispatch category of the scheduler settings screen. Defaults are provided, but you can update them appropriately for your needs.

NotifSettings 4.0.png

Dependent Libraries

Obsidian Scheduler requires a number of third party libraries, both for the web administration application and the scheduler itself. Below is information on these libraries and how they are used. Unless otherwise noted, they are mandatory.

As of Obsidian 2.5.0, our installer supports selective conflict management.

  • activation-1.1.jar, javax.mail-1.5.5.jar (javax.mail-1.5.2.jar prior to 4.0). Used for email notifications.
  • dom4j-1.6.1.jar. XML utilities.
  • obsidian.jar. Core Obsidian lib.
  • log4j-1.2.9.jar. Obsidian logging uses log4j.
  • gson-2.7.jar (gson-2.2.2.jar before 4.0, gson-1.5.jar before 1.5). Supports REST API and web administration.
  • jstl.jar, standard.jar. Web utilities. Only required in web administration.
  • jxl-2.6.12.jar. Excel file format utilities. Only required in web administration.
  • bsh-2.0b4.jar. Support for our Bean Shell script execution. (http://www.beanshell.org). Only required for BeanShellJob usage.
  • groovy-all-2.4.7.jar (groovy-all-2.1.8.jar prior to 4.0). Support for Groovy script execution (http://groovy.codehaus.org). Only required for GroovyJob usage.
  • jython-standalone-2.7.0.jar (jython-standalone-2.5.3.jar prior to 4.0). Support for Python script execution (http://www.jython.org). Only required for PythonJob usage.
  • jmustache-1.12.jar (jmustache-1.8.jar from 2.0 to 3.x.x). Provides email templating.
  • jtds-1.3.1.jar (jtds-1.2.8.jar prior to 4.0). SQL Server JDBC driver. Only required for running SQLServer.
  • mariadb-java-client-1.4.5.jar (mariadb-java-client-1.1.5.jar prior to 4.0). MySQL JDBC driver. Only required for running against MySQL or MariaDB.
  • h2-1.4.192 (h2-1.3.154 prior to 4.0). H2 database and JDBC driver. Only required for running H2.
  • ojdbc7-12.1.0.1 (ojdbc6-11.2.0.3.jar before 4.0, ojdbc14.jar before 2.1). Oracle JDBC driver. Only required for running Oracle.
  • postgresql-9.4.1208.jre7.jar (postgresql-9.0-801.jdbc4.jar prior to 4.0). PostgreSQL JDBC driver. Only required for running PostgreSQL.
  • flexmark-0.19.6.jar (As of 4.3.0)
  • flexmark-util-0.19.6.jar (As of 4.3.0)


Prior to Obsidian 2.9.1, the following redundant library was in included in the Obsidian packaging.

  • smtp.jar. Used for email notifications.

Prior to Obsidian 2.2.0, the following older libraries were in use.

  • groovy-all-1.7.6.jar
  • jython.jar (version 2.5.2rc2)

Prior to Obsidian 2.1.1, the following libraries were also included.

  • carfey-date-1.2.jar or carfey-date-1.1.jar. Date math/manipulation.
  • jdk-gen.jar, jdk.jar, suite-gen.jar, suite.jar. Core Obsidian libs.

Required Libraries for Embedded API

To use the Embedded API, the following resources should be imported. If you have newer versions of the same JARs in your application, feel free to use the newer version. The JAR files below can generally be found in the standalone directory if your installation. The com.carfey.properties file can be extracted from the obsidian-props.jar in the standalone directory, or from an Obsidian WAR file under WEB-INF/classes.

  • com.carfey.properties (configuration file), or obsidian-props.jar, which contains the same file
  • dom4j-1.6.1.jar
  • obsidian.jar
  • log4j-1.2.9.jar
  • gson-2.7.jar
  • flexmark-0.19.6.jar (As of 4.3.0)
  • flexmark-util-0.19.6.jar (As of 4.3.0)
  • Appropriate JDBC JAR (e.g. mariadb-java-client-1.4.5.jar for MySQL or MariaDB)

In addition, the following resources should be included if you wish to have notification support enabled when using the API:

  • activation-1.1.jar
  • mail-1.4.jar
  • jmustache-1.8.jar

Finally, if you need to configure scripting jobs from the API, you will need to include any applicable JARs from the following list:

  • bsh-2.0b4.jar
  • groovy-all-2.1.8.jar
  • jython-standalone-2.5.3.jar
  • jruby-9.0.4.0.jar

Disabling Job Execution & Scheduling in the Web Application

See the instructions within the Getting Started Guide.

Disabling Automatic Database Updates

See the instructions within the Getting Started Guide.