Retry Shell Properties

Retry shell property accessors are defined when an operation can be retried or rejected. Retry shell properties are available for Post-Transition, Pre-State, Post-State, Notification and Self-Registration contexts.

Shell.RedoMessage()

string (output). If the script writes a non-empty string to this property, the current operation is rejected and may be retried.

Form-based operations are rejected similarly to when required fields are missing. The user is redirected to the same form (still maintaining any data they entered) and has another chance to submit the form. The string in Shell.RedoMessage() is used as an error message, appearing at the top of the form and in the Windows Event Viewer. If the script does not write to Shell.RedoMessage(), the form is processed normally.

If an API program submits or transitions an item and a script associated with the transition fails, Shell.RedoMessage() is returned to the API and is available in the GetErrorMessage call. The message is also logged in the Windows Event Viewer as well. However, since there is no interface, the message is not displayed to the user and the user may not have an opportunity to fix the problem.

Non-form operations, such as notifications, use Shell.RedoMessage() as a failure message and may offer some other retry mechanism. For example, when a notification calls a script that writes to Shell.RedoMessage(), the message indicates a failure and causes the notification to be retried (according to optional retry settings).

Note: If a script rejects a Copy, Post Item, or Create Subtask transition by writing a non-empty string to Shell.RedoMessage(), a new item is not created by the transition process.

Retry Shell Properties

Shell.RedoMessage()

Related Topics