Skip Headers

Agile Product Lifecycle Management Recipe Management for Pharmaceuticals Administrator Guide Release 9.3.3 E39287-01 |
| Contents

Previous | Next |

# A Configuration Files

Configuration information of the Recipe Management for Pharmaceuticals application, such as authentication type, audit trail enabling/disabling, the list of resource files and so on, is stored in a set of configuration files. These files can be used to change the initial settings in the Recipe Management for Pharmaceuticals application. The following sections briefly describe the parameters contained in some of these configuration files.

## A.1 CFMConfig.xm

The CFMConfig.xml file is the main configuration file, which acts as the controller for Recipe Management for Pharmaceuticals . This file contains:

Properties to control all the major components of the application such as Audit Service, Logger Service, Alerts Engine, Workflow Engine, Timer Engine, and so on.

Relative location and names of other configuration files used in Recipe Management for Pharmaceuticals .

The following table lists and describes the attributes maintained in the CFMConfig.xml file.

Attribute | Default Value | Description
--- | --- | ---
CFMAppServerInfo CFMApplicationServerName CFMApplicationServerVersion | No default values | This section contains information about J2EE Appserver configuration, on which the application is deployed.
CFMInitialContextFactory | weblogic.jndi. WLInitialContext Factory | This tag specifies the JNDI initial context factory used for all the lookups on the JNDI Tree of the J2EE Server by the R&M Workspace application. It is recommended not to modify this property.
CFMProviderURL | Values specified during installation. | This tag specifies the J2EE Server JNDI URL used for lookup of JNDI Objects, on the JNDI tree. The Recipe Management for Pharmaceuticals installer sets the correct host and port number. If the port number of the J2EE Server domain is modified after installation, only then this property must be modified.
CFMPrincipalUser | WebLogic | This tag specifies the user ID for logging into the J2EE Appserver.
CFMPrincipalUserPwd | VvFM5XvM5jLDvuvz0JROHxcP5WMpoC | By default, the installer inserts the application server password in this tag after encryption. If the application server password is changed for any reason after Recipe Management for Pharmaceuticals installation, this value should be changed manually, using the password encryption utility.
CFMTransactionURL | This Cell is Blank | This is an application server specific property. This denotes the transaction provider for Audit Trail in Recipe Management for Pharmaceuticals . A typical values is 'javax.transaction.TransactionManager' for Oracle Weblogic. Ideally, this property should not be modified by the end user
CFMAdminEmail | This Cell is Blank | A workflow notification is triggered to be sent to a role or a user group needs to be notified as per the Workflow Definition. While the role or the usergroup is being resolved, when R&M Workspace application detects Inactive Users in the role or the user group, the workflow engine instead of sending the email notifications to the inactive users, sends it to the email ID captured in the tag <CFMAdminEmail> A workflow notification is triggered to be sent to a role or a user group needs to be notified as per the Workflow Definition. In case of workflow delegate feature, if User A delegates his/her Workflow task to User B and User B in turn delegates his/her workflow tasks back to User A, then this situation results in a cyclic dependency. In such a situation, R&M Workspace detects such cyclic dependencies and instead assigns the workflow notification to the email ID specified in the tag <CFMAdminEmail>
CFMCacheResetAtStart | False | This property controls the starting value of Autosequence IDs which the system generates for all objects for which autosequenced IDs are applicable. If this property is set to false, then the application will use the last sequence ID in the last used autosequence ID bucket as the starting point the next time the application server is started. If this is set to True, then the application will calculate the exact value of the last used sequence ID and then use this as the starting point. This does involve a performance cost, but ensures that autosequence ranges are used optimally. By default, this is set to True.
CFMLoadCacheBeforeServerStartup | True | This denotes whether the application server must be started only after Recipe Management for Pharmaceuticals 's cache has been loaded. If this is set to False, the user will be able to access the application even before cache has been loaded. Cached data will be loaded during the first login if this was not already done during startup. This property is set to True by default.
CFMAuthenticationInfo | This Cell is Blank | This section has information about the various authentication mechanisms used in the system. There are three modes of authentication, namely, Local, LDAP, and SSO Authentication.
CFMRemoteLogin | FALSE | This tag specifies the authentication mechanism is local or a remote login. If this flag is set to True, it enables the application to connect to the external authentication modules, defined in CFMRemoteServer property. If this flag is set to False, the application uses the default local authentication mechanism (database authentication.)
CFMRemoteServer | LDAP | This tag specifies the server type for remote authentication. The possible values are LDAP and WS. If WS is selected as the authentication mode, the authentication Web service must be setup properly. Note: Typically, the Web service is used for SSO authentication mechanisms. If LDAP is selected as the authentication mode, LDAP configuration information must have the URL and other information set correctly.
AuthenticationPasswordLinks | This Cell is Blank | This section has information about managing passwords for users at the time of logging into the application. Based on the remote server supporting the password links, these flags can be used to decide if the links must be shown on the User Interface.
CFMShowPasswordResetLink | FALSE | This tag indicates if you have to show the Reset Password link on the Login page in the application. Possible values are TRUE or FALSE. This is applicable if the RemoteLogin tag is set to True.
CFMShowPasswordChangeLink | TRUE | This tag indicates if you have to show the Change Password link on the Login page in the application. Possible values are TRUE or FALSE. This is applicable if the RemoteLogin tag is set to True.
CFMLDAPAuthentication | This Cell is Blank | This section has information about the LDAP configuration and LDAP server.
CFMLDAPInitialContextFactory | com.sun.jndi.ldap.LdapCtxFactory | This tag specifies the LDAP initial context factory class implementation. This value is used by the authentication module. It is recommended not to modify this value.
CFMLDAPProviderURL | ldap://LDAP_Server_Hostname:Port | This tag specifies the LDAP server URL in the ldap://hostname:port format.
CFMLDAPSearchBase | ou=?,o=?,dc=? | This tag specifies the LDAP user search string. This is the base search string appended to the username, provided by the user for authentication, on the application UI.
CFMLDAPSecurityPrincipal | ,ou=?,o=?,dc=? | The search string must specify a valid LDAP user used for searching the LDAP directory, while importing users into the application.
CFMLDAPSecurityCredentials | This Cell is Blank | This tag specifies the security credentials (password) for the Security Principal.
CFMLDAPSecurityAuthentication | Simple | This tag specifies the authentication type used for the application login to LDAP server.
CFMLDAPViewName | PCM_VIEW_ USER_LDAP_SSO | This tag specifies the view used for LDAP user search. This view maps the LDAP user properties to the attributes in the user Category, so that the related data such as name, address, and so on can be copied from the LDAP directory to the application database. The view attribute labels must match the LDAP property for the data to be copied correctly.
CFMEmailInfo | This Cell is Blank | This section has information about the email server configured for the application. This information is used to send emails from the application.
CFMEmailHost | mailhost | This tag specifies the IP address of the email server.
CFMEmailPort | 25 | This tag specifies the Port number of the email server.
CFMEmailProtocol | SMTP | This tag specifies the protocol type used to send emails. It is recommended not to modify the type.
CFMEmailDefaultPriority | High | This tag specifies the email priority sent by the application. This priority is set on all emails sent from the application. The valid values are highest, high, normal, low, and lowest.
CFMEmailAttachmentSize | 1MB | This tag specifies the maximum attachment size allowed during email dispatch. Typically, this is limited by the email server.
CFMLoggerInfo | This Cell is Blank | This section has information about the CFMLogger configuration properties. It controls the logs that are generated in the system including their location and file names.
CFMLoggerFactoryClass | This Cell is Blank | This refers to the factory class which provides logger instances. CFMJDKLoggerFactory is the standard factory class.
CFMDefaultLogDirectory | Logs | This tag specifies the relative directory where the log files are stored. The path of the directory is relative to the CFM_HOME location.
CFMDefaultLogFile | CFMDebug | This tag specifies the default log file name where all the debug messages are stored. This file is created in the logs directory.
CFMSQLLogFile | CFMSql | This tag specifies the log file name where SQL logs are appended. This file is created in the logs directory.
CFMErrorLogFile | CFMError | This tag specifies the log file name where Error logs are appended. This file is created in the logs directory.
CFMAccessTimeLogFile | CFMAccessTime | This tag specifies the log file name where Access logs are appended. This file is created in the logs directory.
CFMLogPropertyFile | CFMLogger. properties | This tag specifies the Logger properties used by the logger service in the application. This configuration file is located in the <CFM_HOME>/config folder.
CFMMaxLogFileSize | 1048576 | This tag specifies the maximum log file size. Once the file size exceeds the maximum limit, the logs are created in new file. A backup file is created for the existing file.
CFMMaxAllowedFiles | 7 | This tag specifies the maximum number of backup files that are created, after which the log files are over-written. This value must be modified to an appropriate number.
CFMLogMessageFormatWithSession | {0} | {2} | {4} | {5} | {7}{6} | This is the format in which logs are written in the log file. The log format can be configured based on the available parameters for logging.
CFMLogMessageFormatWithoutSession | {0} | {5} | {7}{6} | This is the format in which the logs are written before the user has logged in. All session related parameters are not available during login.
CFMLogAccessTimeFormat | This Cell is Blank | The time format that is used to represent the information pertaining to application login access.
CFMLogDateTimeFormat | MM/dd/yyyy hh:mm:ss a | This tag specifies the date format used for logging the time when the log was created. This must be a valid Java date format.
CFMConfigFileInfo | This Cell is Blank | This section has information about the various configuration files used by the Persistence layer in the application
CFMSQLQueryFile | CFMSqlQuery.xml | This tag specifies the SQLQuery configuration file location that has the canned queries for loading or saving data in the metamodel tables. This file is located in the <CFM_HOME>/config directory. It is recommended not to modify this tag value.
CFMDBConfigFile | CFMDBConfig. xml | This tag specifies the Data Source connection information file name. This file is located in the <CFM_HOME>/config directory.
CFMLocaleInfo> | This Cell is Blank | This section has information about the Locale configuration properties, used to load resource files. If the values are modified in this section, then the corresponding locale files must be present.
CFMDefaultLocaleLanguage | En | This tag specifies the default locale language code.
CFMDefaultLocaleCountry | US | This tag specifies the default locale country code.
CFMLocaleRelativeDir | config/locale | This tag specifies the locale file path. This is relative to CFM_HOME.
CFMResourcesLocation | CFMResources. xml | This tag specifies the resources file name. This file is located in the <CFM_HOME>/config directory.
CFMReportInfo | This Cell is Blank | This section has information about Reports configuration Properties.
CFMReportXMLDirectory | config | This tag specifies the report configuration file repository. This is relative to <CFM_HOME> directory.
CFMReportFileDirectory | Reports | This tag specifies the output directory for reports. This is relative to CFM_HOME> directory.
CFMReportTemplate | CFMReport.jrxml | This tag specifies the Template file name used for Exporting data in HTML, Excel, or PDF formats.
CFMAlerts | This Cell is Blank | This section has information about the Alert Engine configuration properties used in the application.
AlertEngineEnabled | TRUE | This tag indicates if the Alert Engine must be enabled for processing various alerts in the application. This value must not be modified, unless all alerts are disabled from the system. If the value is set to False, Email and Dashboard Alert Notification features does not work.
AlertFromEmailAddress | This Cell is Blank | This tag specifies the From Address for emails sent for alerts configured with Email.
CFMWebInfo | This Cell is Blank | This section has information about the various configuration properties for the application.
CFMWebConfigFile | CFMWebConfig. xml | This tag specifies the name of the application presentation layer configuration file. This file is located in the <CFM_HOME>/config directory.
CFMAuditTrailInfo | This Cell is Blank | This section has information about the Audit Trail Engine configuration properties.
CFMEnableAudittrail | TRUE | This tag indicates if the audit trail feature is enabled for the application. If the tag is set to True, changes to the objects in the application is audited.
PreferredAuditTimeZone | GMT | This tag specifies the time zone in which all audit related data timestamps are stored in the database. Valid values include PST, EST, IST, and so on. This value is equal to the value returned by the Java API TimeZone.getID() method.
LogHardDeleteHistory | TRUE | When this property is set to True, the application will log information about all hard delete operations performed at any point of time.
ShowRFCPopup | FALSE | RFC is the 'Reason For Change' popup screen. This screen requires the user to enter a concise account of why a given business object is being changed from its prior state. By default, the RFC popup screen will not be displayed.
CFMApplication | This Cell is Blank | This section has information for the Integration Framework used in the application.
CFMApplicationId | Recipe Management for Pharmaceuticals | This tag specifies the application ID for the Integration Framework. This value is internal to the application. It is recommended not to modify this value.
RetryPoller | This Cell is Blank | This section contains properties related to retry polling for failed messages.
RetrySleepInterval | 10000 | This property determines the time interval based on which failed messages for Alerts will be queued and attempted again.
Timer | This Cell is Blank | This section has information about the Timer Engine configuration information for the application. It is recommended not to modify the tags.
EnableScheduler | TRUE | This tag indicates if the Timer Engine for the application must be enabled or disabled. It is recommended not to modify the value.
CreateWorkFlowTaskTimer | TRUE | This tag indicates if the Timer is disabled for the Workflow Module in the application. It is recommended not to modify this value.
CFMDaemon | This Cell is Blank | This section has information about the Daemon that runs within the application. The Daemon performs certain updates periodically based on the intervals specified within the section.
ResetDaemonTriggersAtFirstLogin | TRUE | Daemon threads monitor application state and perform background tasks. Enabling this flag will reset the state of all daemon threads during application startup.
RefreshObjectCountHourlyPeriodicity | 24 | This tag specifies the number of hours after which the Daemon refreshes the object count for every Category in the application, for the current day.
ExpireQualificationsHourlyPeriodicity | 24 | This tag specifies the number of hours after which the Daemon marks the Equipment Qualifications that has expired in the database for the current day.
ExpireLotHourlyPeriodicity | 24 | This tag specifies the number of hours after which the Daemon marks the Material Lots that has expired on the current day.
ActivateInactivateObjectHourly Periodicity | 24 | This tag specifies the number of hours after which the Daemon activates or inactivates the business objects in the database, based on the start and end effective dates for the current day.
HasEffectivityCheckEnabled | TRUE | This tag indicates if the Daemon must activate or inactivate the business objects within the application.
ExpireWorkflowHourlyPeriodicity | 24 | This tag specifies the number of hours after which the Daemon cleans up the Workflow Delegation table for the Authorized Parties, who have subscribed for the Workflow Delegation functionality. If the records in the Workflow Delegation table are no longer valid on the current day, those entries are removed from the Workflow Delegation table.
ExpireSiteQualificationHourly Periodicity | This Cell is Blank | This tag specifies the number of hours after which the Daemon marks those Site Qualifications that have expired on the current day.
InventoryReevalExpireDaemon | 24 | This tag specifies the number of hours after which the Daemon marks the status of "Lot Release Processes" to "OutOfEvaluation". It also marks the corresponding Inventory (Lots/Containers) Status "To Be Evaluated"
AgileIntegrationHourlyPeriodicity | 24 | This Cell is Blank
CFMTemplateEngine | This Cell is Blank | This section contains properties pertaining to User Interface templates based on which screens are rendered.
location | config/ templates | The location where templates for the User Interface are stored. The path is relative to the location of CFM.HOME.
encoding | ISO-8859-1 | The character encoding used in these templates.
outputEncoding | UTF-8 | Encoding format for all output rendered based on the UI templates.
templateUpdateDelay | 0 | This tag specifies the interval at which the Free Marker Template Engine looks for any changes in the templates. 0 informs the Engine not to look for any changes.
AgileDetails | This Cell is Blank | This Cell is Blank
AgileHttpUrl | This Cell is Blank | This is the HTTP URL for the Agile instance.
AgileRmiUrl | This Cell is Blank | This is the RMI URL for the Agile instance.
AgileWebServiceUrl | This Cell is Blank | This is the URL for Agile core web services.
CFMPrintableCategories | Recipe, Control Recipe, Process Step, Work Order | This property is applicable for Formatted Print. The value for this property is a set of comma-separated business object IDs. For all the business objects listed here, the History tab of all objects belonging to that business object will display an additional tab labeled 'Print'. This tab will display information about the history of all Formatted Print operations performed on the given object.

## A.2 CFMDBConfig.xml

The CFMDBConfig.xml file contains a list of databases that is available for the users. For each database, this file contains:

- Logical database name.

- Data source name for the database set up in the J2EE server.

- Detailed information about the database such as vendor details.

The following table lists and describes the attributes in the CFMDBConfig.xml file.

Attribute | Default Value | Description
--- | --- | ---
CFMDatabase | No default value | This tag is used to separate successive database configuration entries in the file. Each database configuration comprises of all the tags listed below.
CFMDatabaseName | CFMPCM | This tag specifies the database configuration name that is displayed on the login window of the application. This must be a unique name.
CFMDeleteType | Soft | This tag has a boolean value, Soft or Hard. Soft indicates that any delete command only marks the object as deleted but does not physically remove it from the database. Hard indicates that, on delete, all objects will be removed from the database.
CFMJNDIName | LSPDataSource | This tag specifies the JNDI name of the data source configured in the J2EE Application server for the Recipe Management for Pharmaceuticals database.
CFMSchemaOwner | TRUE | This tag has a boolean value, TRUE or FALSE. TRUE indicates that the database user for this datasource is the Schema Owner and the owner of all the objects in the database. FALSE indicates that the database user for this data source is not the Schema Owner but is a user for a private synonym created on the database. The user also has permissions to modify, update, and delete records (to perform DML operations only and not DDL operations.) If the value provided in the tag <CFMPrivilegedUsers> is False, the value is ignored.
CFMPrivilegedUsers | CFMUSER, User 2 | This tag has a comma separated list of users having the DML operations on this database schema. Private synonyms are created for this user. This user has permissions to modify, update, and delete records (to perform DML operations only and not DDL operations.) If any new categories are created using R&M Workspace metamodel module using the Schema Owner, the application creates the appropriate private synonym for each user listed in this tag.
CFMVendorType | Oracle | This tag specifies the vendor type of the relational database server used. The valid value for this tag is Oracle only.

## A.3 Alert Message Generation Files

Alert notifications and dashboard messages can be configured to display content to suit your requirements. These configurations must be carried out in the related XSL files detailed below.

You must have basic knowledge of XSL, HTML syntax, and tags to configure message properties.

### A.3.1 EmailNotification.xsl

This XSL file generates HTML content for email alert messages. The following table describes the various sections in an alert notification message and tells you what you can customize within each section.

Section | Description | What can be customized?
Header | Displays a general salutation such as Dear <user name>. | Recipient user name.
Alert Header | Displays the alert name, business object, and category. | Style attributes such as background color and font.
General information | Displays general information such as name, subscription name, subject, message, and so on. | Labels.
Alert criteria | Displays criteria and monitoring actions configured for this alert. Alert criteria is displayed only for alerts which have alert conditions specified. Alerts based on user actions do not have any criteria and are not displayed. | Label and content style.
Result table | Displays records that have met the alert criteria. | Table properties, table caption, and "Trigger Value" column color.
Footer | Displays customized text, disclaimers etc. | Can be completely removed or customized.

### A.3.2 DashboardNotification.xsl

This XSL file generates HTML content for dashboard alert messages.

Section | Description | What can be customized?
Header | Displays configured alert details such as date, type of subscription, subject, priority etc. | Labels can be customized by editing the Dashboard Alert Details sub view.
Message Body | Displays the results table. | Number of records to display, table style properties, and "trigger value" style. You can also add more header columns.

## A.4 Integration-related Files

Integration-related files are located at the following path: <CFMHome>\config\integration

File Name | Description
cfmxml.xsd | Schema file for the cfmXML. cfmXML is a standard xml format used by Recipe Management for Pharmaceuticals . The integration framework processes all the requests in cfmXML format and converts them to an appropriate response by applying the outbound XSL file if required.
inboundPCMApp.xslt | This is a sample XSLT file. This folder contains all the XSLT files, which are used as inbound XSL files for different applications communicating with Recipe Management for Pharmaceuticals .
outboundPCMApp.xslt | This is a sample XSLT file. This folder contains all the XSLT files, which are used as outbound XSL files for different applications communicating with Recipe Management for Pharmaceuticals .
wsdlProcessor.xslt | This is an XSLT file used to parse the given WSDL, extract the information in the Recipe Management for Pharmaceuticals database using the integration Callable Web service with WSDL UI screen.

### A.4.1 AgilePharmaMapping.xml

AgilePharmaMapping.xml is a mapping configuration file that allows you to map Agile and Recipe Management for Pharmaceuticals object attributes.