Advanced Configuration

From Obsidian Scheduler
Jump to navigationJump to 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

# 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.

# 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

# 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


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

# 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, 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.
com.carfey.obsidian.db.schema=obsidian

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

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

# 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=}}

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_

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 System tab. Defaults are provided, but you can update them appropriately for your needs.

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 with that directory explicitly added to the classpath or inside a jar as is done in obsidian-props.jar for standalone deployments.

As of Obsidian 1.5, to make use of our external property file override support, use the System property carfey.properties.file. Between the default properties and the override, all expected properties must be specified. 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.

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.

  • activation-1.1.jar, mail-1.4.jar, smtp.jar. 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.2.2.jar (gson-1.5.jar before 1.5). Supports REST API and web administration.
  • jstl.jar, standard.jar. Web 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.1.8.jar. Support for Groovy script execution (http://groovy.codehaus.org). Only required for GroovyJob usage.
  • jython-standalone-2.5.3.jar. Support for Python script execution (http://www.jython.org). Only required for PythonJob usage.
  • jmustache-1.8.jar (2.0 and later). Provides email templating.
  • jtds-1.2.jar. SQLServer jdbc driver. Only required for running SQLServer.
  • mariadb-java-client-1.1.5.jar. MySQL jdbc driver. Only required for running against MySQL.
  • h2-1.3.154. H2 database and jdbc driver. Only required for running H2.
  • ojdbc6-11.2.0.3.jar (ojdbc14.jar before 2.1). Oracle jdbc driver. Only required for running Oracle.
  • postgresql-9.0-801.jdbc4.jar. PostgreSQL jdbc driver. Only required for running PostgreSQL.

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.


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.

Retrieved from "https://wiki.obsidianscheduler.com/doc/index.php?title=Advanced_Configuration&oldid=1570"