Defining BPM service interface for an OpenEdge procedure

To use a procedure .p file in the BPM process workflow, you must add the service interface definition to it. Defining the service interface refers to defining or adding BPM annotations in the procedure file. You can then use the procedure file in the BPM process workflow.

To define the service interface for a procedure file:

  1. Right-click on the procedure file in the Project Explorer view or in the Outline tab or the Procedure Editor tab, and select Progress OpenEdge > Define Service Interface from the context menu. The Define Service Interface wizard appears.
  2. Select BPM from the Definition Mode drop-down.
  3. In the Project Explorer view, the procedure selected in Step 1 is automatically checked from the list of procedures in the workspace, and the corresponding internal functions and procedures are listed in the Internal Procedures and Functions area.
    Note: You can also select multiple procedures from the workspace and define service interfaces for them
  4. In the Backup area, select the Backup selected resources checkbox to back up the procedure files before defining the service interface.
  5. Click Browse and specify the backup location, and then click Next. The Edit Annotation page appears.
  6. In the BPM main annotation area, click Edit to edit the BPM annotation for the procedure file. The New BPM Annotation dialog appears.
  7. In the New BPM Annotation dialog, you can specify the following:
    1. Enter the type of annotation to be added in the Type field.
    2. Specify the BIZOE=File Name.
    3. Select EXECUTION MODE from the drop-down.
    4. Select USE RETURN VALUE checkbox, if the OpenEdge procedure file returns a value. A retVal parameter is added to the procedure file to store the return value.
    5. Select WRITE DATASET BEFORE IMAGE checkbox, if you want before-image data written to the OpenEdge file when ProDataSet parameters are serialized as XML.
  8. Click OK.
  9. In the BPM detail annotation area, click Edit to edit the BPM annotation for the internal procedures and functions in the main procedure file. The New BPM Annotation dialog appears, perform Step 7.
    Note: You can edit BPM detail annotation only if any internal procedure or function is selected in Step 3.
  10. Click Finish.
    Note: For more information see, Generating a BPM Invocation file
Preliminary Draft
© 2017 Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.