Siebel Business Process Framework: Workflow Guide > Reference Materials for Siebel Workflow > Predefined Business Services >
About the Workflow Admin Service Business Service
The Workflow Admin Service business service allows a workflow process to perform administrative tasks on multiple workflow processes specified by a searchspec. Some example administrative tasks include deploy, activate, export and import. This topic includes the following topics:
For usage instructions, see Invoking the Workflow Admin Service Business Service. Methods of the Workflow Admin Service Business Service
Methods of the Workflow Admin Service business service include:
- Export. Exports workflow processes specified by a search specification into a specified directory. Each workflow process is exported to a separate .XML file with a file name being the concatenation of process name and version number.
- Import. Imports workflow export files specified by a search specification in a specified directory.
- Deploy. Deploys workflow processes specified by a search specification.
- Activate. Activates workflow processes specified by a search specification.
- DeleteDeploy. Deletes workflow deployment records specified by a search specification.
Table 88 describes arguments for the methods on the Workflow Admin Service business service.
Table 88. Description of Arguments on the Workflow Admin Service Business Service
|
|
|
|
Export |
Input |
ExportDir |
The directory to which the export files are written to. For example, D:\workflows. |
FlowSearchSpec |
The search specification used to identify the workflow processes to be exported. For example, [Process Name] like 'User Reg*' |
Repository |
The repository from which workflow processes are exported. The default value is Siebel Repository. |
Output |
NumFlowExported |
The number of workflow processes that have been exported by the service. |
Import |
Input |
ImportDir |
The directory where the workflow export files are located. |
FileSearchSpec |
The search specification used to identify the workflow export files to be imported. For example, User*.xml |
Repository |
The repository into which workflow processes are imported. |
ProjectName |
The Tools project into which workflow processes are imported. The project needs to be locked for the workflow import to succeed. |
Output |
NumFlowImported |
The number of workflow processes that have been imported by the service. |
Deploy |
Input |
FlowSearchSpec |
The search specification used to identify the workflow processes to be deployed. Note that a default search specification, [Status] = "In Progress", is automatically added to FlowSearchSpec. It is not necessary to explicitly specify the search specification. |
Output |
NumFlowDeployed |
The number of workflow processes that have been deployed by the service. |
Activate |
Input |
FlowSearchSpec |
The search specification used to identify the workflow processes to be activated. Note that a default search specification, [Status] = "COMPLETED", is automatically added to FlowSearchSpec. It is not necessary to explicitly specify the search specification. |
Output |
NumFlowActivated |
The number of workflow processes that have been activated by the service. |
DeleteDeploy |
Input |
FlowSearchSpec |
The search specification used to identify the workflow deployment records to be deleted. |
Output |
NumFlowDeleted |
The number of workflow deployment records that have been deleted by the service. |
Invoking the Workflow Admin Service Through the Business Service Simulator
It is recommended to invoke the Workflow Admin Service business service through the Business Service Simulator when you need to activate or deploy a large number of workflows in bulk. This way you can supply the search specification for each set of workflows. It is not recommended to run the Workflow Admin Service business service from within a workflow process because you must change the input search specification inside the workflow process for each set of workflows involved, resulting in the need to revise the workflow process each time it calls the Workflow Admin Service business service.
|