...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Appsplus panel macro confluence macro | ||
---|---|---|
| ||
**Delete Before Publishing**
|
In this article
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
You can use this Snap to...
Prerequisites
Valid client ID.
A valid account with the required permissions.
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Works in Ultra Pipelines if....
Does not support Ultra Pipelines.
Limitations
None.
Exact Online Delete
In this article
- Overview
- Snap Input and Output
- Snap Settings
- Troubleshooting
- Additional Information
- Examples
- Snap Pack History
Overview
Use this Snap to delete a data object in the Exact Online instance.
Prerequisites
- A valid OAuth 2.0 account that supports Exact Online instance, with the appropriate access permissions. See Exact Online OAuth 2.0 Account.
Support for Ultra Pipelines
- Works in Ultra Pipelines.
See Snap Support for Ultra Pipelines.
Limitations and Known Issues
None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
Input | Document |
Binary or Document
|
|
..
Requires the EDI data and internal ID as a JSON document.
Output
Document
Binary
Binary or
| Each input document contains data that must be updated and written into the Exact Online instance for the selected entity. | |
Output | Document |
|
..
..
|
| Each document contains the response of the update operation. |
Snap Settings
...
data | {"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
---|
**Delete Before Publishing**
Choose from the following sentences to document specific field types.
Drop-down lists/Option Buttons (radio buttons):
You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.
...
<State what the should do in this field>. The available options are: <bullet list of LoVs>
Specify the Salesforce API to be used. The available options are:...
...
Parameter Name | Data Type | Description | Default Value | Example | |||
Label | String | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | N/A | SAP S/4HANA Update | |||
Version | String | Required. The version of the Exact Online API. | v1 | v1 | |||
Division | String | Required. Unique ID of the Exact Online Division (can be retrieved with a REST call https://start.exactonline.nl/api/v1/current/Me?). | N/A | 1234567 | |||
API object | String | Required. Select the API that you want to access in the Exact Online instance. This drop-down list contains supported services available for the Exact Online instance. | N/A | CRM | |||
Endpoint | String | Required. Select an Exact Online Endpoints to be specified and connected for each of the API objects. | N/A | Accounts | |||
ID | String | Unique Exact Online identifier (Guid) of the record to be updated. | N/A | a8ecb3d6-6632-11eb-ae93-0242ac130002 | |||
Connection details | Use this section of Snap Settings to specify the connectivity parameters: timeout, retry count and retry interval. This field set comprises the following fields:
|
|
|
|
|
|
|
Connection timeout | Integer | Required. Enter, in seconds, the duration for which Snap must try to establish a connection with the Exact Online instance. If the connection cannot be established within this duration, the Snap times out writes the event to the log and waits until the specified RetryInterval before attempting to reconnect. | 300 | 120 | |||
Maximum request attempts | Integer | Required. Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout. | 0 | 5 | |||
RetryInterval | Integer | Required. Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts until the number of retries is reached. | 0 | 10 | |||
Snap Execution | String | Indicates how the Snap must be executed. Available options are:
|
...
|
...
|
...
|
...
|
...
Check boxes:
If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data.If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields
Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
Enter the name for new account.
Specify the account ID to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields
Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
Notes in field descriptions
Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:
Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.
Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.
Note |
---|
Field names marked with an asterisk ( * ) are mandatory. |
...
Field Name
...
Field Dependency
...
Description
Default Value:
Example:
...
Label*
...
None.
...
The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.
Default Value: ELT Database Account
Example: ELT RS Account
...
Field set
Specify advanced parameters that you want to include in the request.
This field set consists of the following fields:
Field 1
Field 2
Field 3
...
Field 1*
...
Debug mode check box is not selected.
...
Field 2
...
None.
Troubleshooting
...
Error
...
Reason
...
Resolution
...
Account validation failed.
...
The Pipeline ended before the batch could complete execution due to a connection error.
...
Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:
<screenshot of Pipeline/Snap and description>
Download this Pipeline.
Downloads
...
| Execute only | Validate & Execute |
Troubleshooting
Error | Reason | Resolution |
API object is not existing. | The entered API object is not found for the Exact Online API. | Please search and select an API object from the dropdown list. |
The endpoint is not existing. | The entered Endpoint is not found for the selected API object in the server. | Please search and select the Endpoint from the dropdown list. |
Additional Information
Here is some information to assist you while using the Exact Online Delete Snap.
Snap General Behavior
The Exact Online Update Snap supports the following:
- PUT operation to Delete data in the Exact Online instance.
- Dynamic loading of API metadata with a Parent-child dependency structure. This means that you can:
- Select an API object from the API Object field to view only entities that are related to the API object and support PUT queries (update operations).
Examples
Delete an account from the Exact Online instance CRM server
This Pipeline example demonstrates using Exact Online Delete Snap to delete an account in the Exact Online instance CRM service. The example assumes that you have configured and authorized a valid Exact Online Account (see Configuring Exact Online Accounts (file:////wiki/spaces/SD/pages/......)). Download this Pipeline The following settings are defined for the Exact Online Delete Snap to delete an account in the Exact Online instance CRM service it accesses.
- API object: CRM
- Endpoint: Accounts
A successful validation or execution of the Snap gives the following output preview, showing the query results.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
...
Attachments | ||||
---|---|---|---|---|
|
...
See Also
Endpoint Doc Link 1
Endpoint Doc Link 2
Endpoint Doc Link 3
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started
...
File
Modified
Labels
- No labels
- Edit Labels
View Properties Edit file Delete|File Exact_Online_Delete_CRM_Accounts_Demo.slp |Oct 14, 2021 by Rojo Publisher 2|
Drag and drop to upload or browse for files
Upload fileAnchor file_0 file_0
File descriptionAnchor comment_0 comment_0
Snap Pack History
Click here to expand...
Release | Snap Pack Version | Type | Updates |
|
|
|
...