Winshuttle AutoRun Plug-in

The Winshuttle AutoRun plug-in is used exclusively in Excel-based solutions that use a custom workflow built in Solution Designer.

It allows you to automatically run a routed data file to a specified SAP system using Evolve Worker.

Note: Each time the AutoRun plug-in runs, Total Rows and Error Rows are reset. So if you have multiple AutoRun plug-ins within one workflow, the Total Rows and Error Rows values will be rewritten multiple times.

Properties

Name

Description

Mandatory

RunOnlyErrors

If set to Yes, only those rows which have ‘Err:’ text in the log field are processed. If set to No, all rows are processed.

No

RunOnlyUnprocessed

If set to Yes, only those rows which have empty log field are processed. If set to No, all rows are processed.

Note: Rows with data in the log column are considered processed.

No

StopRunOnError

If set to Yes, the file stops processing as soon as one or more rows return an error. If set to No, all rows are processed.

No

retries

If an error occurs during AutoRun, this parameter defines the number of retries which will be executed.

If not defined or if set to 0, this parameter will respect the global configuration keys AutoRunRetries and AutoRunRetryMinutes; the default values for these keys are 3 and 30 respectively.

Example: Direct Value:4. Value from Solution Field:[RetriesColumn]

No

retryminutes

This parameter defines the number of minutes between retries. It will come into effect only if retries has been specified and if the retries parameter is more than zero.

Example: Direct Value: 345. Value from Solution Field:[MinutesColumn]

No

runnernode

The runner node can be configured in one of the following two ways:

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

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

  • Blank : If the RunnerNode setting is left blank, the plug-in uses the user from the nearest activity (such as an Approval node) in the swimlane where the plug-in is located. If this would result in multiple users, the most recent user from the list of users is used.

No

scriptname

Enter the name of the specific script you want to run with an Excel-based workflow. For example: abc.txr

No

validate

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

No

Further Information

To post data to SAP using the AutoRun plug-in, ensure the process does not complete before AutoRun is executed. If the process completes before AutoRun executes, AutoRun will be moved to a “completed” state without having posted the data to SAP – and the following message will appear in the Process History of the plug-in: “AutoRun could not be executed as the process was not running.” To ensure the process does not complete before AutoRun is executed, set the Continue without waiting property to False.

Examples

  1. If the Workflow is designed only for AutoRun (Start → AutoRun → End), set the Continue without waiting property to False. If the ‘Continue without waiting’ property is set to True, the process will be completed before the execution of AutoRun.

  2. If the Workflow is designed with some task or approval after AutoRun (Start → AutoRun → Activity → End) and the Continue without waiting property is set to True , ensure the activity does not complete before the execution of AutoRun.

On the Processes page, under Process History, the AutoRun plug-in status options are in the table below.

Status

Description

Scheduled

The job has been created in the background and is ready to be picked up. Runner <Runner Name>

InProgress

The system has picked up the job and execution has started.

Enqueued

The job is queued for posting.

Preprocessing

The job has been picked by the worker for processing. Worker: <name of worker>

Posting

The processing has started.

Post-Processing

The document is being updated after posting.

Finished

The job execution is complete.

On the Documents page, under Version History, the AutoRun plug-in status options are in the table below.

Note: Each status creates a document version applicable to both Standard Workflows and Custom Workflows.

Status Description

DataPostingRunning

The AutoRun plug-in execution has started.

DataPostingCompletedWithErrors

The AutoRun plug-in execution has completed with some errors.

DataPostingSuccess

The AutoRun plug-in has completed without errors.

DataPostingFailed

The AutoRun plug-in could not be started because of a connectivity issue such as SAP not reachable, or SAP credentials not available.

DataPostingAborted

The AutoRun plug-in execution started, but was stopped before completion.