Download Attachment
Description
Service Now: Download Attachment plugin step downloads all attachments associated with a ServiceNow record.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name must be unique within a single workflow. |
| Connection | ||
| 2 | Grant Type | Select the type of grant from OAuth 2.0 or Basic Auth. Data type: String Mandatory: Yes Notes:
|
| 3 | ServiceNow Base URL | Specify the URL of the ServiceNow instance. Example: https://XXXXXX.service-now.com |
| 4 | Client ID | Specify the Client ID of the registered application on the ServiceNow instance. Data type: String Mandatory: Yes Note: This field is available if the grant type is OAuth 2.0. |
| 5 | Client Secret | Specify the Client Secret of the registered application on the ServiceNow instance. Data type: String Mandatory: Yes Note: This field is available if the grant type is OAuth 2.0. |
| 5.a | Checkbox: Accept Value as variable/static | Leave the checkbox unchecked to accept the Client Secret value from a field in previous steps using a dropdown list. Enable the checkbox to make the Client Secret field appear as a textbox. |
| 5.b | Client Secret | Enter the Client Secret using the widget. The Client Secret is encrypted and not stored in the .psw file. The widget supports both Text (static value or environment variable) and Combo (dropdown values from previous steps). Mandatory: Yes If the checkbox is enabled, this field appears as a textbox. If disabled, it appears as a dropdown. |
| 6 | Refresh Token | Specify the Refresh Token to obtain a new access token. Data type: String Mandatory: Yes Note: This field is available if the grant type is OAuth 2.0. |
| 6.a | Checkbox: Accept Value as variable/static | Leave the checkbox unchecked to accept the refresh token value from a field in previous steps using a dropdown list. Enable the checkbox to make the Refresh Token field appear as a textbox. |
| 6.b | Refresh Token | Enter the Refresh Token using the widget. The Refresh Token is encrypted and not stored in the .psw file. The widget supports both Text (static value or environment variable) and Combo (dropdown values from previous steps). Mandatory: Yes If the checkbox is enabled, this field appears as a textbox. If disabled, it appears as a dropdown. |
| 7 | Username | Username for authenticating the ServiceNow instance. Data type: String Mandatory: Yes Note: This field is available if the grant type is Basic Auth. |
| 8 | Password | Password for authenticating the ServiceNow instance. Note: This field is available if the grant type is Basic Auth. |
| 8.a | Checkbox: Accept Value as variable/static | Leave the checkbox unchecked to accept the Password value from a field in previous steps using a dropdown list. Enable the checkbox to make the Password field appear as a textbox. |
| 8.b | Password | Enter the Password using the widget. The Password is encrypted and not stored in the .psw file. The widget supports both Text (static value or environment variable) and Combo (dropdown values from previous steps). Mandatory: Yes If the checkbox is enabled, this field appears as a textbox. If disabled, it appears as a dropdown. |
| Button | ||
| 9 | Test Connection | Click Test Connection to verify if the connection is established. Mandatory Fields: ServiceNow Base URL, Username, and Password. Once the connection is established, all requisite forms and fields in the Input and Output tabs are populated. Note: This button does not work for values sourced from previous steps, as these can only be accessed during workflow execution. Static values and environment variables are allowed. Once input and output values are populated, connection fields can be replaced with previous step fields. |
Input Fields:
| No. | Field Name | Description |
|---|---|---|
| 1 | Form Name | Select a Form name from the Form Explorer window for downloading all attachments associated with a record of this form. This field is mandatory. |
| 2 | Button: Get | Click Get Forms Button to open Form Explorer window with form names. Select a form name displayed or filter form names using the filter field. |
| 3 | Table Sys ID | The Sys ID of the record for which associated attachments need to be downloaded. The following screenshot shows that sys_id can be copied by right clicking on  a particular record and clicking Copy sys_id option. |
| 4 | Output Folder Path | Specify a folder path where files are to be downloaded or browse for a folder using the Browse File… button. Alternatively, when the folder path is coming from an input stream, you may select the field containing the folder path from the drop down list |
| 5 | Button: Browse Folder | Click this button to browse for a folder to download to a Cherwell Business Object file. |
| 6 | Delete Output Folder Contents before downloading | Allowed values: ‘Yes’, ‘No’. Specify Yes to delete output folder contents before downloading else Specify No. |
| 7 | Add Date TimeStamp for Duplicate Files | Allowed values: ‘Yes’, ‘No’. Specify Yes to add Date TimeStamp for Duplicate Files. |
| 8 | Add File To Result | Allowed values: ‘Yes’, ‘No’. Specify Yes to add the downloaded files to result set and display download link on AE otherwise else select No. |