rxworkflowproperties-reference

Workflow Properties File Reference

Configuration Properties

The Workflow Properties file is read at server startup and is used to configure Workflow Notification Emails from Percussion to remote SMTP servers for delivery.  After changing this file, the percussion instance must be restarted. 

Located in the <installDir>/rxconfig/Workflow/rxworkflow.properties

PropertyDefault ValueDescription

APP_FILE_LIST

Deprecated. 

TRIGGER_CHECK_IN

checkin

System property indicating the workflow transition trigger for Check In operations.  Should not be changed. 

DATA_TYPE_MAP_FILE

../rxwfdatatypemaps.xml

System property indicating the Table Factory data type mapping file.  Should not be changed. 

DB_SCHEMA

System property indicating the configured database schema.  Should not be changed. 

DB_BACKEND

System property indicating the configured database backend. Should not be changed. 

MSACCESS_CURRENTTIMESTAMP

NowDeprecated.  System property indicating the time stamp function to use when configured against an Microsoft Access Database backend.  Should not be changed.

ORACLE_CURRENTTIMESTAMP

SYSDATESystem property indicating the time stamp function to use when configured against an Oracle Database backend.  Should not be changed. 

DB_SERVER

System property indicating the database server. 

HTML_PARAM_USER_FULLNAME

htmlParamUserFullName

System property indicating the HTML Parameter that will contain the Full Name for the user. Should not be changed. 

HTML_PARAM_USER_ROLELIST

htmlParamRoleList

System property indicating the HTML Parameter that will contain the role list for the user. Should not be changed. 

TABLE_DEF_FILE

../rxcmsconfig.xml 

System property indicating the Table Factory file that holds the database schema.  Should not be changed. 

CUSTOM_MAIL_CLASS

com.percussion.workflow.mail.PSSecureMailProgram

The Java class that will be responsible for sending notification emails.  This class must implement the public IPSMailProgram interface and be deployed as a Java extension to the server's classpath in order for it to be picked up. 

MAIL_DOMAIN

Defaults to the hostname of the Percussion server. 

The domain that emails should be sent from.  For example "percussion.com"

SMTP_HOST

-

The SMTP server to use for sending emails. TCP v4 IP Address or hostname is allowed.

SMTP_USERNAME

-

For SMTP servers that require authentication, the user name of the user to use in authentication. Leave blank if the SMTP server does not require authentication.

SMTP_PASSWORD

-

For SMTP servers that require authenication, the password of the user to use in authentication.  The password should be entered in plan text, the system will auto encrypt the password when the server starts.  Should be left blank if the SMTP server does not require authentication. 

SMTP_PORT

25

The SMTP port to use to connect to the remote SMTP servers.  The default port for non encrypted SMTP connections is 25.  SSL connections commonly use port 465, and TLS port 587.

SMTP_TLSENABLED

false

Set to true for SMTP servers that require TLS connections.  

SMTP_BOUNCEADDR

-The email address that should receive mail delivery failure notifications.  Can be useful to troubleshoot end user reports of notifications not being delivered. 

DB_DRIVER_VERSION

*System property that indicates the database driver version. Should not be changed.

TABLE_DATA_FILE

../rxwftabledata.xml

System property that indicates the data file for the Table Factory.  Should not be changed. 

MSSQL_CURRENTTIMESTAMP

getDate()

System property that indicates the function to used to generate timestamps on Microsoft SQL Server backends.  

TRIGGER_CHECK_OUT

checkout

System property that indicates the Workflow Transition Trigger to use for checkout operations.  Should not be changed. 

DB_DRIVER_CLASS_NAME

System property that indicates the database driver classname used to connect to the database backend.  Should not be changed. 

RX_SERVER_HOST_NOTIFICATION

The public host name of the Percussion server.  This will be used when generating notification links. 

RX_SERVER_PORT_NOTIFICATION

The public port of the Percussion server.  This will be used when generating notification links. 

TRIGGER_FORCE_CHECK_IN

forcecheckin

System property that indicates the Workflow Transition Trigger to use for Force Checkin operations. 

MAIL_NOTIFY_LINK_COMPONENT_NAME

item_action_panel

System property that indicates the UI component that the notification link should target.  Should not be changed. 

RX_SERVER_IS_SSLLINK_NOTIFICATION

falseSet to true if the Percussion server is to be accessed via SSL in notification links.  Notification links will be prefixed with https if this is configured. 

Configuring Logging for Wofklow Notification Emails

When configuring Workflow Notification emails, it is often useful to temporarily enable debug logging of mail deleivery to troubleshoot connection settings. The system uses the log4j logging system to control logging. This configuration file is located at the following locations. 

Jetty

Note:  When running Jetty, changes to the log4j configuration require a service restart. 

<InstallDir>/jetty/base/resources/log4j.xml

JBOSS

<InstallDir>/AppServer/server/rx/conf/log4j.xml

The following loggers can be used to enable debug logging to the server.log file. 

<logger name="com.percussion.workflow.mail.PSSecureMailProgram">
<level value="DEBUG" />
</logger>

<logger name="com.percussion.workflow.PSExitNotifyAssignees">
<level value="DEBUG" />
</logger>

After troubleshooting your email configuration is complete,  it is recommended that these loggers be either commented out, removed, or updated to INFO instead of DEBUG.   DEBUG logging can have serious performance side effects on Production servers.