Configure the Crystal reporting task

Configuration is needed for this report task before it can be used.

Configure Red Hat OpenShift with your report user credentials

Before you configure the reporting task, the user authentication credentials to use to access your Crystal Reports server for the report must be added to Red Hat® OpenShift®. These credential values are provided in the following parameters that must be added as key and value pairs to the ftm-serviceengine-tasks-secret secret in Red Hat OpenShift.
  • Username used to log on to the Crystal Reports server. This user must have the rights to set report parameters and schedule report instances.
  • User password used to log on to the Crystal Reports server.
If these values were already added to the secret, you do not need to add them again.
To add parameters to the Red Hat OpenShift secret, do the following steps:
  1. Determine what names you want to use for the keys for the report parameters. You can use any word with alphanumeric characters for a key. For example, you might use the following key and value pairs for the report parameters.
    crystalusername=admin
crystaluserpass=pass
    If you have more than one report server that you are using to run the Services Framework report tasks, you need a unique set of user credential keys for each server. For example, you can add an identifier as part the key names, such as crystalusernameserv1 and crystalusernameserv2.
  2. Use the Red Hat OpenShift Container Platform to open the ftm-serviceengine-tasks-secret secret.
  3. Edit the secret to add your key and value pairs in the Value field for the key secret.properties. The format for the key and value pairs is key=value.
  4. The key names that you added to the secret must be specified in the configuration for report tasks that use the Crystal Reports server.

Task parameters

To configure this task, go to the task configuration page in the Services Framework user interface and select the New task configuration link. The following table shows the information that is needed to configure the task.
Table 1. Crystal reporting task configuration fields
Field Description Example
Task This field displays a list of all of the registered tasks. Select the name of the Crystal reporting task that was entered during registration. Crystal Reporting
Configuration Descriptive name for the configuration. It is used by a Transaction Server event to start the task. This field is required and can contain up to 60 characters. EndofDayReportingTask
Description A detailed description that explains what the configuration does. This field is optional. If entered, it must be 512 characters or less. Initiates a list of reports at end of day
Activate task Indicates whether the configuration is active. When it is active, the task is available to initiate reports on the Crystal Reports server. Yes
Process end of day Run the task when Services Framework is notified to run end of day. Yes
Process cleanup Set this value to no because it doesn't apply to the Crystal reporting task. No
Delete on complete Not applicable No
Allow Monitor Not applicable No
Key used for User Name in Red Hat OpenShift secret The name of the key to use to get the value from the Red Hat OpenShift secret. This field is the key for the username to use to log on to the Crystal Reports server for this task. crystalusername
Key used for User Password in Red Hat OpenShift Secret The name of the key to use to get the value from the Red Hat OpenShift secret. This field is the key for the user password to use to log on to the Crystal Reports server for this task. crystaluserpass
CMS Name Name of the Central Management Server in the format servername:port. CRSERVER1:6400
Authentication Authentication method for starting a session with the Crystal Reports server secEnterprise
Report Name(s) List of reports to be scheduled. Multiple reports must be separated by commas. It is an optional field. Crystal Reporting Task Sample Report, Test Report 1, Test Report 2
Report ID(s) List of reports to be scheduled. Multiple reports must be separated by commas. It is an optional field. 2718, 1910

When the task is saved, its configuration information is validated, which requires the Crystal Reports server to be available.