Agent Workflow Triggers

There are several web services which provide access to trigger agent workflow for selected business objects. The capabilities include:

  • Execution of individual agent action against one or more objects of a supported type.
  • Execution of multiple agent actions against one or more objects of a supported type.

Currently the supported object types are SHIPMENT (Buy Shipment), SELL SIDE SHIPMENT, ORDER RELEASE, DRIVER and ORDER MOVEMENT.

There is a separate service for each business object type:

  • ShipmentService
  • SellSideShipmentService
  • OrderReleaseService
  • OrderMovementService
  • DriverService
  • AgentService

The type specific services handle individual agent actions for that type and have one operation: processAction. The AgentService handles processing of multiple actions essentially identical to a Transportation and Global Trade Management Cloud Agent but with some constraints (covered later) and also has one operation: processAgent.

All services are implemented with the synchronous REQUEST/RESPONSE messaging model. However, with respect to Transportation and Global Trade Management Cloud agent action processing, the response indicates that the action has been scheduled successfully. This is due to the fact that the Transportation and Global Trade Management Cloud application could have a significant amount of workflow triggered by such an action. Therefore waiting for completion may require an excessive transaction timeout value.

The input and output messages for each service are specified in the service XSDs. Namely:

  • AgentService.xsd
  • ShipmentService.xsd
  • SellSideShipmentService.xsd
  • OrderReleaseService.xsd
  • OrderMovementService.xsd

Agent specific message content is specified in the following XSDs:

  • Agent.xsd: contains agent header details
  • ShipmentAction.xsd: contains all actions related to buy shipments
  • SellSideShipmentAction.xsd: contains all actions related to sell shipments
  • OrderReleaseAction.xsd: contains all actions related to order releases
  • OrderMovementAction.xsd: contains all actions related to order movements
Note: Due to a change in V6.2 in how these services are deployed in the application server at runtime, the WSDL for each service will not directly reference the XSD files mentioned above. However, the formats defined in these XSD files will be functionally equivalent to the definitions referenced in the WSDL.