AutoRun plugin properties

The AutoRun plug-in (formerly called AutoPost) is used exclusively in Microsoft Excel-based Studio solutions that use a custom workflow built in Winshuttle Composer.

This plugin allows you to automatically run a routed data file to a specified SAP system using Winshuttle SAPIS (SAP Integration Server) instead of the Runner’s desktop PC.

On this page

Configuring the AutoRun plugin

Back to top

  1. Decide when you would like to perform the AutoRun step in your workflow.
  2. Place a plugin node on the canvas. Note that placement does not necessarily have to be within a particular swim lane. See the value pair runnernode in the AutoRun plugin parameters table (below) for more information on node placement.
  3. In the Plugin Name field, select Winshuttle AutoRun, and then set the Synchronous field to False.

    4. Note: Setting Synchronous to false pauses the workflow until the Autorun job is completed.

  4. In the Properties Pane, next to Plugin Parameters, click the options button to configure the value pairs described in the AutoRun plugin parameters table (below).

AutoRun plug-in parameters table

Back to top

Value Pair

Description

retries

If an error occurs during AutoRun, this parameter will define the number of retries to be made.

retryminutes

This parameter defines the number of minutes between retries.

runnernode

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.
    Edit Winshuttle Update Runner Node screenshot
  • Blank: If the Runnernode setting is left blank, the plugin will use the user from the nearest activity (such as an Approval node) in the swimlane in which the Winshuttle Update plugin is located. If this would result in multiple users, then the most recent user from the list of users will be used.
RunOnlyErrors Only those rows in the data file that have errors in the log column are processed again.
RunOnlyUnProcessed Only those rows that were not previously run, or their log column was blank are processed again. Errored rows are not processed either.
scriptname Set this option to run a specific script (selected from the drop down) to run with an Excel-based workflow.
StopRunOnError The processing of the data file is stopped as soon as the first error is encountered.

validate

(Yes/No) Whether or not to validate prior to posting.

The AutoRun plugin will automatically use a Runner’s credentials (designated by placement in the canvas or the runnernode value) from Winshuttle User Governance.

Notes:

  • Credentials for all potential Runners must be configured prior to using this plugin. See Managing Credentials for more information.
  • If no specific node is specified in the runnernode parameter and no other activities or approvals exist in the same swimlane, the Autopost plugin will use Workflow Administrator (WFAdmin) account, which requires a Winshuttle User Governancelicense and must be assigned access in SAP.
  • The Sync plugin property should be set to false so that the workflow pauses until the AutoRun job is completed.
  • When more than one script is using the same template, their Run log fields should also be mapped to different columns.
  • If the Validate radio button is selected as ‘Yes’, then the RunOnlyErrors, RunOnlyUnProcessed, and StopRunOnError parameters will not work.
  • Attachment log/Extended log column does not work for the RunOnlyErrors, RunOnlyUnProcessed, and StopRunOnError parameters.

Checking AutoRun Job status

Back to top

You can check the status of running jobs on the Winshuttle Foundation Manage Scheduled Jobs page. The following messages can also be found in the listed metadata for the jobs:

Error returned

Metadata

SAP posting

ErrorRows and TotalRows

Winshuttle SERVER

Data Post Status

An error occurred in CENTRAL or in Winshuttle SERVER

Data Post Status

Validation Failed: Validation failed for Central policies, licenses, roles, or SAP credentials

Approval error

The metadata errors in the table above can be referenced in your workflow as well to determine if the workflow can end after the AutoRun is complete, or whether further intervention may be required.

Example (Reference the workflow images below): Place the AutoRun plugin in a loop. If the ErrorRows metadata shows 0 after the run, the loop finishes and the workflow continues. If ErrorRows is anything other than 0, the file will route to the SAP Team for correction and resubmission to AutoRun again. This would repeat until errors reach 0.