BP Metadata Info Service

The BP Metadata Information Service retrieves information about a business process. This information can be made available to the system to be used in other processes.

The following table provides an overview of the BP Metadata Info service:

System name Business Process Metadata
Graphical Process Modeler (GPM) category All Services
Description Use this service to retrieve information about a particular business process such as:
  • Business process definition ID
  • Process name
  • Description
  • State
  • Status
  • Type
  • Priority
  • Persistence level
  • Lifespan
  • Business process definition version
  • Storage type
  • Recovery level
  • Doc tracking flag
  • Deadline
  • Event level
  • Sub/parent business process information
  • Correlations
Note: This service can also be used to retrieve information about the business process that runs this service.
Business usage Enables you to retrieve information about a business process. This information can then be made available to the system to be used in other processes.
Usage Example See Business Process Example.
Preconfigured? Yes. The preconfigured copy is called BPMetaDataInfoService.
Requires third party files? No
Platform availability All supported platforms
Related services None
Application requirements None
Initiates business processes? No
Invocation Does not invoke a business process.
Business process context considerations None
Returned status values Returned status values:
  • Success
  • Error
Restrictions None
Persistence level None
Testing considerations None

Implementing the BP Metadata Info Service

To implement the BP Metadata Info service, complete the following tasks:
  1. Create a BP Metadata Info service configuration.
  2. Configure the BP Metadata Info service.
  3. Use the BP Metadata Info service in a business process.

Configuring the BP Metadata Info Service

To configure the BP Metadata Info service you must specify settings for the following fields in the GPM:

Field Description
Config Name of the service configuration.
LINKAGE Enable links between this BP and any parent/child processes. Optional. Valid values are True and False. Default is True.
DISPOSITION Print out the WFD_STATE and WFD_STATUS information to Process Data. Optional. Valid values are True and False. Default is True.
WORKFLOW_ID Specify a workflow ID from which to get MetaData. Optional; Reports on itself if no other process is specified.
TRACE Dump all the WorkFlow Context information. Optional. Valid values are True and False. Default is False.
CORRELATION Report on correlations. Optional. Valid values are True and False. Default is False.

Output from Service to Business Process

The following table contains the parameters passed from the BP Metadata Info service to the business process:

Parameter Description
WORKFLOW_ID The current Workflow ID. Required. Specify a known instance, or obtain from process data such as if using this service in an on-fault. Default is current workflow ID.
MESSAGE_FROM_SERVICE The user who send the message from service. Optional. Default is current user.
WFD_ID The current WorkFlow Definition ID. Required.
WFD_VERSION Current BP version. Required.
WFD_NAME Current BP name. Required.
WFD_DESCRIPTION Current BP description. Required.
WFD_STATE Current BP state; only show if the disposition is set. Optional.
WFD_STATUS Current BP status; only show if the disposition is set. Optional.
WFD_TYPE Current BP type. Required.
WFD_PRIORITY Current BP priority. Required.
WFD_PERSISTENCE_LEVEL Current BP persistence level. Required.
WFD_LIFE_SPAN Current BP lifespan. Required.
WFD_STORAGE_TYPE Current Storage type. Required.
WFD_RECOVERY_LEVEL Current Recovery level. Required.
WFD_DOC_TRACKING_FLAG Current Document tracking flag. Required.
WFD_DEADLINE_INTERVAL Current Deadline interval. Optional.
WFD_EVENT_LEVEL Current Event Level. Optional.

Output from Business Process to Service

The following table contains the parameters passed from the business process to the BP Metadata Info service:

Parameter Description
WORKFLOW_ID Specify a workflow ID from which to get MetaData. Optional; Reports on itself if no other process is specified.

Business Process Example

The following example business process illustrates using the BP Metadata Info service: 

<process name="BPMetaDataInfoService_01"> 
  <sequence name="simple"> 
   <operation name="1"> 
      <participant name="BPMetaDataInfoService"/> 
      <output message="Xout"> 
      <assign to="WORKFLOW_ID">9</assign> 
      <assign to="DISPOSITION">true</assign> 
      <assign to="LINKAGE">true</assign> 
      <assign to="CORRELATION">true</assign> 
      <assign to="TRACE">true</assign> 
      <assign to="." from="*"></assign> 
      </output> 
      <input message="Xin"> 
      <assign to="." from="*"></assign> 
      </input> 
   </operation> 
  </sequence> 
</process>