Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Web services

You can use the web services in the BMC Atrium Orchestrator product to remotely trigger BMC Atrium Orchestrator workflows and return a Simple Object Access Protocol (SOAP) response with the workflow output. The BMC Atrium Orchestrator product uses the ORCA web service and legacy web service.

The legacy web service was used in the earlier releases of the BMC Atrium Orchestrator product. The ORCA web service was introduced with version 7.5.00 of the product and provides many improvements over its predecessor. You can also use the ORCA web service in conjunction with the legacy web service.

The following table compares the ORCA and legacy web service features:

ORCA web service features

Legacy web service features

Available only on the configuration distribution peer (CDP)

Available on the CDP and activity peer (AP)

Has a fixed Web Service Definition Language (WSDL) for the web service

Exposes a WSDL that matches the exposed workflow

Exposes all workflows from activated modules

Is exposed as a workflow property

Allows execution by the admin or grid_admin user, or others with sufficient permissions set in the Grid Manager application

Allows execution by users who have admin or grid_admin permission

Executes workflows asynchronously or synchronously

Executes workflows synchronously

Optionally, registers with registries that are Universal Description, Discovery and Integration (UDDI) v3 compliant

No corresponding feature

ORCA web service

The ORCA web service is powerful and flexible. You can use the queries and other operations to solve programmatic use cases. For example, using the ORCA web service, you can create a query to retrieve a list and descriptions of activated modules and workflows on a grid. Using the information retrieved from the queries you can build a robust web service interface.

The ORCA web service enables you to programmatically trigger workflows from other applications. The ORCA web service uses a fixed WSDL for the web service.

The ORCA web service offers you flexibility when performing the following activities:

  • Querying for various information about installed modules or their constituent workflows
  • Executing single workflows synchronously or asynchronously
  • Terminating or canceling workflows
  • Pausing or resuming workflows
  • Executing multiple workflows asynchronously
  • Requesting the operational status of workflows

Legacy web service

The legacy web service exposes a WSDL that matches the exposed workflow. You must set the Expose as SOAP workflow property to expose workflows to the WSDL.

The legacy web service is exposed at the CDP and AP. Users who have View Grid StatusGrid Administration and Admin permission can use the legacy web service to execute workflows. For more information about assigning permissions, see Assigning grid permissions.

Was this page helpful? Yes No Submitting... Thank you

Comments