Winshuttle Update Plug-in

The Winshuttle Update plug-in allows you to add a Winshuttle Web service to a workflow. By using this plug-in, you can dynamically perform SAP data operations within the workflow.

The Winshuttle Update plug-in also supports repeating Web services.

On this page

When a form uses web services through a button click, or through On Field Change or On Form Load, the logged in user's credentials are used for running the web service. This user must have a valid license, and the appropriate rights and SAP credentials defined in Winshuttle Central.

The Winshuttle Update plug-in uses the credentials under which SVService is running. The SVService admin must have a valid license, and the appropriate rights and SAP credentials defined in Winshuttle Central / User Governance.

Winshuttle Update plug-in usage example

The Winshuttle Update plug-in can be useful if your Master Data team prefers to dynamically (i.e. not manually) push data to SAP after an approval is completed.

How to configure the Winshuttle Update plug-in

  1. In Composer, click the Solution Tab.
  2. Add a Transaction or Query script to your solution. See Importing a Web service or script if you need assistance importing scripts into a solution.
  3. Click the Form tab.
  4. Add a Web Service Element to your form. See Adding Elements to a form if you need assistance with adding an element.
  5. Set the parameters for the plug-in that you require. See the Winshuttle Update Parameters Table (below) for a description of available settings.
    Winshuttle Update Parameters screenshot

Winshuttle Update plug-in tips and best practices

  • If there are multiple Winshuttle Update plug-ins, set the Plug-in Node property SYNC to False. If Sync it set to True, both plug-ins would run during the same 5 minute window of SVservice. If Sync is set to false, the plug-in will wait to start the second one until after the first one is completed.

Properties

Back to top

Name

Description
WebserviceName The name of the Web Service to run.
StatusField Select the field to which to log the script for the selected Web Service.
WaitDuration [Optional]. WaitDuration is the number of hours to wait for a response from the server.
Runnernode

Note: This option is available for the Winshuttle Update plug-in beginning with Composer v11.4.

The runner node can be configured in 1 of 2 ways: 

  • Select a specific node: In the Properties Pane next to RunnerNode, click the options button. On the Edit Runnernode screen, then click Node to select a specific activity or approval node in the workflow.

    The person assigned to the selected node will be used as the runner. If there are multiple users in the selected node (such as multiple approvers, for example), then the most recent user to have completed the activity (the most recent approver, for example) will be used.

  • Blank: If the Runnernode setting is left blank, the plug-in will use the user from the nearest activity (such as an Approval node) in the swimlane in which the Winshuttle Update plug-in is located. If this would result in multiple users, then the most recent user from the list of users will be used.

Winshuttle Update plug-in processing

When a Winshuttle Update plug-in is processed, the Workflow engine must use an account to connect to SAP. This account will show as the modifier or creator of any records in SAP altered by the web service.

By default, in 11.4.0 the Workflow engine will first check for an account in the following places and order:

  1. The web service system account specified in the solution deployment profile.
  2. The last user on the form.
  3. The users the swimlane resolves to that contains the Winshuttle Update plug-in.
  4. A specified account in the mapping for the web service.
  5. Finally, a fail over to the Workflow Administration (SharePoint Impersonation) account.

To work with legacy workflows, in versions after 11.4.0, the default order is:

  1. The web service system account specified in the solution deployment profile.
  2. A specified account in the mapping for the web service.
  3. The Workflow Administration (SharePoint Impersonation) account.

The priority order can be changed by using the WinshuttleUpdateLegacyOperation key.