Table of Contents

Search

  1. Preface
  2. Web Service Concepts
  3. Understanding the Web Services Provider
  4. Using the Web Services Hub Console
  5. Batch Web Service Operations
  6. Writing Client Applications
  7. Working with Web Service Sources and Targets
  8. Editing Web Service Sources and Targets
  9. Working with Web Service Mappings
  10. Working with Web Service Workflows
  11. Appendix A: Web Service Sample Client Applications
  12. Appendix B: Configure the Web Browser

Web Services Provider Guide

Web Services Provider Guide

stopWorkflow

stopWorkflow

Use this operation to stop a running workflow. When you stop a workflow, the Integration Service tries to stop all the tasks that are currently running in the workflow. If the workflow contains a worklet, the Integration Service also tries to stop all the tasks that are currently running in the worklet.
In addition to stopping a workflow, you can abort a running workflow by setting the isAbort parameter to true. Normally, you abort workflows only if the Integration Service fails to stop the workflow.
You must log in to the repository before you call this operation.
The following table describes the parameters for this operation:
Parameter Name
Required/ Optional
Description
SessionID
Required
Session ID generated after log in.
FolderName
Required
Name of the folder containing the workflow.
WorkflowName
Required
Name of the workflow to stop.
ServiceName
Required
Name of the Integration Service that runs the workflow.
WorkflowRunId
Optional
ID of the workflow run instance to stop.
WorkflowRunInstanceName
Optional
Name of the workflow run instance to stop.
Reason
Optional
Describes the reason to start a workflow or task.
ParameterFileName
Optional
Name of the parameter file to use when running the workflow.
RequestMode
Optional
Indicates the recovery strategy for the session task:
  • NORMAL. Restarts a session without recovery.
  • RECOVERY. Recovers a session.
TaskInstancePath
Optional
Path specifying the location of the task. If the task is within a workflow, enter the task name alone. If the task is within a worklet, enter <
WorkletName
>.<
TaskName
>. Enter the taskInstancePath as a fully qualified string.
IsAbort
Optional
Indicates whether to abort the workflow. Set this parameter to True to abort the workflow.
OSUser
Optional
Specifies the operating system profile assigned to the workflow.
DomainName
Optional
Domain name for the Integration Service.
AttributeName
Optional
Name of the attribute in the attribute name and value pair used to start or schedule a workflow or task.
AttributeValue
Optional
Value of the attribute in the attribute name and value pair used to start or schedule a workflow or task.
Key
Optional
Key to use to start a workflow or task.
MustUse
Optional
Indicates whether the key must be used to start the workflow or task.
ParameterScope
Optional
Scope of the parameter in a parameter array definition.
ParameterName
Optional
Name of the parameter in a parameter array definition.
ParameterValue
Optional
Value of the parameter in a parameter array definition.

0 COMMENTS

We’d like to hear from you!