×

Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

Home
Building and Configuring Workflows
Legacy Workflow Web Service
Legacy Workflow Web Service
Workflow publishes a web service, IWorkflowWebService, that allows schedule operations. You can browse all configured workflow schedules and start one or more of them, as well as get information on running workflow instances.

Workflow IPI
Get Started
Tutorials
Orientation
Configure Your Environment
Security
Resource Information and Configuration
Data Administration
Forms and User Displays
Building and Configuring Workflows
- Workflow Design Basics
- Workflow Foundations
- Task Management for Administrators
- Task Configuration
- Task Step Configuration
- Global Subprocesses
- Basic Activities
- Schedules
- Faults
- Test Workflows
- Debug Workflows
- Track Data
- Web Services Service Provider
- Legacy Workflow Web Service
  - Legacy Workflow Web Service
    Workflow publishes a web service, IWorkflowWebService, that allows schedule operations. You can browse all configured workflow schedules and start one or more of them, as well as get information on running workflow instances.
    - GetFilteredWorkflowSchedules
      Filters a set of schedules and returns only those schedules that match a regex filtering expression. It returns a collection of data contract objects from WorkflowScheduleData.
    - GetFilteredWorkflowSchedulesEx
      Returns a list of workflow schedules.
    - StartWorkflowScheduleWithResult
      Starts the named workflow schedule with specified input parameter values, and returns a workflow instance ID. The client can then make additional requests against this instance at a later time.
    - GetScheduleDetails
      Allows you to search for a workflow schedule using either the schedule's address or its display name and user version. If a schedule is found, a list of all the schedule's parameters is returned.
    - GetWorkflowInstance
    - GetWorkflowInstances
- Categories
- Completion Codes
- Actuals
- REST APIs
eSOP
ActiveX Task Controls
Service Interfaces
Operator Task List in the Workflow Client
Best Practices

Legacy Workflow Web Service

Workflow publishes a web service, IWorkflowWebService, that allows schedule operations. You can browse all configured workflow schedules and start one or more of them, as well as get information on running workflow instances.

Endpoints are published using the following address:

https://<ServerName>:8202/SOAServer/SOAProject/Workflow/Workflow/IWorkflowWebService

The service metadata (WSDL) can be accessed at the following address:

https://<ServerName>:8202/SOAServer/SOAProject/Workflow/Workflow/IBrowse?wsdl

If you are working in a multiple server environment, ensure that the web server is on the workflow server:

https://<ServerName>:8202/WorkflowServer/SOAProject/Workflow/Workflow/IBrowse?wsdl

Note: Administrators are unable to log in using the web service interface.

Methods

These operations are provided by the Workflow web service. You can also use the related data contracts to customize these methods when developing workflows.

Important: The Call Web Method that was provided in earlier versions of Workflow is still available. You can continue to use it for your legacy web services; however, it is recommended that for all new web services configurations, you should use the Web Services Service Provider to add and configure web service definitions.