Create services with the Service Accelerator
Summary
The Service Accelerator displays a sequence of forms that define the service rules, property rules, activity rules and service package. The fields and forms differ, depending on the type of service that you are creating. For services of type MQ and JMS, for example, the Accelerator displays forms for creating the necessary supporting data objects and listeners.
As you progress through the Service Accelerator forms, the steps that you take to create the rules and data objects for the service appear on the left-hand side of the form, allowing you to see where you are in the process. The step that you are on currently appears in boldface text. Steps that you have completed are marked with a green check mark.
Suggested Approach
1. Verify that you have completed the appropriate tasks from Before you run the Service Accelerator.
2. Select Application > New > Service.
3. In the Select Service Purpose form, complete the fields as shown in the following table, then click Next.
Field | Value |
|---|---|
Service Purpose | Select the task that your service will accomplish: Create and manage work, Invoke existing activity rules, or Process input or output data. |
Service Type | Select the kind of service you want to create: EJB, File, Java, JMS, JSR94, MQ, SOAP, HTTP, or.Net |
MDB listener | This field appears if your Service Type is JMS. Select this check box if Process Commander is deployed as an Enterprise application and the service is to use a message-driven bean (MDB) as the listener. |
Resource Name Resolution (JMS only) | This field appears if your Service Type is JMS. If you are using resource references to identify the JMS resources, select Resource Reference. Otherwise, select Direct JNDI Lookup. See Configure a JMS service or connector to find JMS resources through resource references for information about this choice. |
4. Take one of the following steps:
- If you selected Create and manage work as your Service Purpose, go to Step 5.
- If you selected Invoke existing activity rules, go to Step 7.
- If you selected Process input or output data, go to Step 10.
5. The Select Work Properties form appears. Complete the fields as shown in the following table, then click Next.
Field | Value |
|---|---|
Work Type | Select the class rule that the flow you want to use applies to. The selection list displays all the concrete class rules that inherit from the Work- class rule. |
Flow Type | Select the name of the flow to use on the work objects created by the service. |
Create Work | Select this check box if you want the service to create a new work object and start it on the selected flow. |
Organization | If you selected the Create Work check box, specify the organization (so that the work object appears in the correct workbasket). |
6. The Select Flow Actions form appears. The Accelerator converts the flow actions that you select on this screen into service rules. The flow actions that display are from the flow that you specified in the Flow Type field of the Select Work Properties form. Select the check box next to each flow action that you want to convert to a service rule, then click Next. Continue on to Step 11.
7. The Select Activity Class form appears. Use the drop down to select the class that your activity belongs to and click Next.
8. The Select Service Activities form appears. The Accelerator generates a service rule for each activity that you choose, allowing you to invoke those activities remotely. Select the checkbox next to each activity that you want to create a service rule for and click Next.
9. The Select Service Parameters form appears. This form lets you map service data to or from values on the parameter page of the service being invoked. The Accelerator adds a data mapping field for each selected parameter to the Request and Response tabs of the generated service rules.
You can also enter default values for the selected parameters; these values are passed to the service activity when it is invoked. Select the check box next to each request or response parameter that you want to map, and, optionally, enter a value in the Default Value field. Click Next. and continue to Step 11.
10. The Select Data Class form appears. Complete the fields as shown in the following table, then click Next.
Field | Value |
|---|---|
Data Class | Use the drop down to select the class of data that your service will process. |
Service Name | Enter a name for your service. |
11. The Customize Service Data form appears. This form lets you choose property references for data that is used by the service. The property references are derived from the work, activity, or data classes that you selected on previous forms. Each property reference you select becomes part of the request or response data for the generated service rule.
Complete the fields as shown in the following table, then click Next.
Field | Value |
|---|---|
Property Reference Check Boxes | Select the check boxes next to the property references that you want the service to use. If a property is required, its check box is automatically selected and cannot be unchecked. |
Use XML for Mapping Data | Creates an XML mapping rule that maps each property in the following Input Properties or Output Properties section to or from a stream of XML tags. The XML tags have the same names as the properties that they map to. The type of mapping rule that the Accelerator creates depends upon the service type you are generating and whether the XML data is part of the request (inbound data) or the response (outbound data).
If you do not select this check box, the Accelerator adds a data mapping field for the selected property to the Request and Response tabs of the generated service rules. |
Return Process Info XML | This check box appears if you chose Create and Manage Work on the Select Service Purpose form. Select the check box to return an XML stream that contains information about the state of the work process. The information includes the state of the work object and the assignment, and the list of actions that can be performed next. For information about the process information properties, see "The Return Process Info XML Checkbox" in How the Service Accelerator Works. |
12. The Select Service Resources form appears. Complete the fields as shown in the following table, then click Next:
Field | Value |
|---|---|
Ruleset Name | Select the RuleSet to hold the rules and data objects that will be generated for the service. |
Ruleset Version | Select the version of the ruleset. |
Service Package Options | Select an option for package generation:
|
Existing Service Packages | This field appears if you selected Copy an existing service package or Use an existing service package in the Service Package Options field. If you chose Use an existing service package in the preceding field, select an existing service package to reference. If you chose Copy an existing service, select an existing service package to use as a template. |
Service Listener Resources | This field appears if your service type is JMS or MQ. Select an option for service listener generation:
|
Existing Service Listeners | This field appears if you selected Copy an existing service listener in the Service Listener Resources field. |
13. The Configure Data Records form appears. Complete the fields as shown in the following table and click Next.
New Service Package
This section appears in the Configure Data Records form if you selected Configure a new service package or Copy an existing service package on the Select Service Resources form.
Field | Value |
|---|---|
Package Name | Enter a unique name for the new service package. This name acts as the key for the service package record. The accelerator suggests a name that you can modify. Validation prevents selecting a name that matches the name of an existing service package. |
Processing Mode | Select |
Access Group | Specify the access group for the services in this service package. |
Requires Authentication | Select this option if the services must run as authenticated users. |
New Service Listener
This section appears in the Configure Data Records form if your service type requires a listener and you also selected Configure a new service listener on the Select Service Resources form. It contains the required fields for the service to be valid.
Field | Value |
|---|---|
Name | Enter a unique name for the service listener. This name acts as the key for the service listener record. The accelerator suggests a name that you can modify. Validation prevents selecting a name that matches the name of an existing service listener. |
Source Location (File Listener only) | Specify the directory where the files are located. The Process Commander system running this listener must have read and write access to the source directory. |
Source Mask (File Listener only) | Enter a string to use as the filter that identifies the files to be processed. For example, if you enter *.txt, all files with the .txt extension are processed by the file service. If you enter *.*, all files in the source location are processed by the file service. |
| Container Managed Transaction (JMS only) | If this is an MDB listener, select if you want the transaction to be container managed. If this is not an MDB listener, select only for the condition described in the article Using MQ and JMS services with Enterprise Application deployment. |
Messaging Model (JMS only) | Select the messaging model for this listener, either |
Resource Name Resolution (JMS only) | Read-only. Indicates whether you are using a JNDI server data object (direct JNDI lookup) or resource references to locate the JMS resources (connection factory and destination). |
| Connection Factory (JMS, listener not MDB) | Enter the name of the JMS connection factory to use to connect to the JMS provider. |
| Request Destination (JMS, listener not MDB) | If you selected |
| Response Destination (JMS, listener not MDB) | If you selected |
| Destination Name (JMS, with MDB listener) | If you selected |
| Response Connection Factory (JMS, with MDB listener) | If the listener sends responses, enter the name of the JMS connection factory to use for the reply connection. |
| Response Destination Name (JMS, with MDB listener) | If you selected Point to Point as the messaging model and the listener will send responses, enter the name of the JMS queue that the listener will respond to. If you selected |
| Queue Name (MQ only) | Specify the name of the WebSphere MQ queue that the listener listens to. |
| Queue Manager (MQ only) | Specify the name of the WebSphere MQ manager that maintains the queue. By leaving this field blank, you indicate that the default queue manager maintains the queue. |
New Data Source
This section appears in the Configure Data Records form in the following cases:
- Your service type is MQ and you selected Configure a new service listener on the Select Service Resources form.
- Your service type is JMS, you selected Configure a new service listener and you selected Direct JNDI Lookup in the Resource Name Resolution field on the Select Service Purpose form.
Field | Value |
|---|---|
Server Name | Enter the name of the server. |
Initial Context Factory (JMS only) | Specify the name of the Initial Context Factory class of the J2EE application server that acts as the JMS provider on the server you specified in the Server Name field. WebSphere: WebLogic: JBoss: |
Provider URL (JMS only) | Specify the URL of the JMS provider as follows: |
Security Principal (JMS only) | (Optional) The user name of a valid user for the JNDI server. |
Security Credentials (JMS only) | (Optional) The password of the user you specified in the Security Principal field. |
Host Name (MQ only) | Enter the host name of the server. |
Port Number (MQ only) | The port number the MQ server listens on. |
Channel (MQ only) | The name of the MQ channel the MQ server uses. |
Username (MQ only) | If the server requires that listeners be authenticated, enter the user ID of a valid user. |
Password (MQ only) | The password for the user ID specified in the User ID field. |
MQ bindings transport (MQ only) | Do not select this option if you plan to use an MQ channel. |
14. If your new service contains any rules where the name (key) conflicts with the name of an existing rule, the Resolve Duplicates form appears. Select one of the following options for each duplicate rule:
- Overwrite existing rule
- Rename the new rule
If you selected the Rename the new rule check box, a text box appears containing a suggested rule name that does not conflict with any existing rules.
If you do not want to overwrite or rename rules, you can use the Back button to return to the Select Service Resources form. Once you are on the Select Service Resources form, select a different RuleSet name or version to try and avoid duplicate rules.
Resolve any duplicates, then click Next.
15. The Review and Save form appears. This form displays all of the rules and data instances that will be committed to the database when you click Finish . Use the Back button to change the selections that you made in the Accelerator, or click Finish to commit the rules and data instances to the database.
16. A confirmation page appears, listing all of the items that the Accelerator created. To edit any item in the list, click the associated Open icon.
17. Do one of the following.
- If you are creating a service of type SOAP or .NET, Process Commander creates the appropriate rules and generates a WSDL file that describes the rules in the service package. To download the WSDL or .jar file, click the button on the Deployment Files section. See Building SOAP Services.
- If you are creating a service of type EJB or Java, Process Commander creates the appropriate rules but does not automatically generate the deployment file (the .jar file). You must open the service package instance and manually generate the deployment files. See Building EJB Services.
- If you are creating a service of type File, return to How to create a file service to finish.
- If you are creating a service of type MQ, the accelerator creates the appropriate rules, MQ listener, and MQ server. You may need to edit the generated items. Continue to Examine the results after running the Service Accelerator.
- If you are creating a service of type JMS, either continue to Examine the results after running the Service Accelerator or return to How to create a JMS service in v 5.4.