Delete Capture OnTheGo Document

The Delete Capture OnTheGo Document deletes a document from a Capture OnTheGo Repository, which stores documents that can then be retrieved by the Capture OnTheGo mobile application. It can be used, for example, to delete a document that has its expiration date set in the distant future but needs to be deleted as soon as an app user has submitted it.

This task can be added as an Action task (see Action tasks) or as a Condition Task. When used as a Condition task, the success of the delete operation determines whether the condition returns True or False.

In the network preferences, you can enable certificate validation for this task. See Network behavior preferences.

Input

This task doesn't require an input file. It does need a Repository ID and password, and the ID of the document to delete.

Processing

This task connects to a Capture OnTheGo Repository and requests removal of a document with a given document ID.

The protocol used is TLS 1.3, or TLS 1.2 if the option Force outgoing encrypted connections to use TLS 1.2 or lower in the Preferences (Network behavior preferences) is checked.

Output

When used as a Condition task, the success of the delete operation determines whether the task returns True or False.

Task properties

General Tab

The General tab is where you enter the connection information necessary to log on to the Repository to request removal of the specified the document.

• Server URL: Select the address of the COTG Server that you want the plugin to communicate with. (This option is only available if more than one COTG Server address has been defined.)
• Repository ID: Enter a valid Capture OnTheGo Repository ID.
• Password: Enter the password that corresponds to the Repository ID entered above.
• Document ID: Enter the ID of the document to delete from the Repository.
• Invert result: When the task is used as a Condition task, the success of the delete operation determines whether the condition returns True or False. Check this option to invert the result.

On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in The Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see Colors), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.