Appsplus panel macro confluence macro |
---|
data | {"features":["title","icon","rounded","collapsible","border"],"title":"General Guidelines. **Delete before publishing**","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** Always use title casing for Heading formats 1 and 2. Always use active voice. Do not use "Please" anywhere in the document. Screenshots Always use the New Form UI. Be optically similar. Max size corresponding gridline to 1000 px size, as in the style guide. Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here. See Image Style Guide for details.
Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.
|
In this article
Table of Contents |
---|
minLevel | 1 |
---|
maxLevel | 2 |
---|
absoluteUrl | true |
---|
|
Overview
You can use this Snap to update data objects in bulk in the HubSpot platform... Learn more: HubSpot APIs.
...
Snap Type
The <Snap name> HubSpot Snap is a Read/ Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates…
Prerequisites
Valid client ID.
A valid account with the required permissions.
.
Prerequisites
None.
Support for Ultra Pipelines
...
...
Works in
...
Ultra Pipelines.
Limitations
None.
Known Issues
NoneThe HubSpot Bulk Update Snap can update only 100 records in a single execution.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|
Input Document Binary | Binary or Document | | | Requires the EDI data and internal ID as a JSON document. | Output | Document Binary Binary or A document that contains the details to identify the entity to update along with the information to update. |
Output | Document | | | The EDI transaction ID and order confirmation | | A document with the details of the updated entity. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab: Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error. Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records. Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.
Learn more about Error handling in Pipelines. |
Snap Settings
...
{"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 option should do in this field>. The available options are: <bullet list of LoVs> Specify the Salesforce API to be used. The available options are:... Select the <category> that you want to use. Available options are... * Option 1<italicized>. <third person singular form of the verb> * Option 2<italicized>. <third person singular form of the verb> Select the API that you want to use. Available options are: Bulk API. Sends the Snap execution request details as a bulk API call. REST API. ... OR Select one of the three following modes in which the Snap executes: * Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime. * Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data. * Disabled. Disables the Snap and all Snaps downstream from it.
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.
|
Info |
---|
Asterisk ( * ): Indicates a mandatory field. Suggestion icon (): Indicates a list that is dynamically populated based on the configuration. Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic. Add icon ( ): Indicates that you can add fields in the fieldset. Remove icon ( ): Indicates that you can remove fields from the fieldset. Upload icon ( ): Indicates that you can upload files.
|
Field Name | Field TypeField Dependency | Description |
---|
Label* Default Value: | ELT Database Account HubSpot Bulk Update Example: | ELT RS AccountBulk Update Companies | String | None. | The Specify a name for the Snap. | You can modify this to be more specific, especially if If you have more than one of the same | Snap in your Pipeline.Number of recordsSnaps in the pipeline, you can modify this and create a unique name. |
API Version* Default Value: V3 Example: V4 | Dropdown list | Select the API version to use for the pipeline. |
Category* Default Value: N/A Example: CRM | String/Suggestion | Select the application in which to update the data objects. |
Entity* Default Value: N/A Example: Companies | String/Expression | Sampling Type is Number of records. | Enter the number of records to output. | fieldset Name | Specify advanced parameters that you want to include in the request.
Field 1Suggestion | Select the data object to update.
|
Action* Default Value: N/A Example: Update a batch of Companies | String/Suggestion | Specify the action to perform by the Snap. |
Required Parameters | Use this field set to enable the Snap to perform a specific action. |
Parameter* Default Value: N/A Example: company.id | String/Suggestion | Specify the names of the required parameters. |
Value* Default Value: | <value> or None. N/A Example: | <value>1884 | String | Debug mode check box is not selected. | Field 2
Default Value: <value> or None. Example: <value> | String | NoneSpecify the values for the required parameters. The data type of this field depends on the specified parameter. |
Connection timeout Default Value: 30 Example: 30 | Integer | Specify the connection timeout duration in seconds. |
Number of retries* Default Value: 0 Example: 3 | Integer | Specify the maximum number of reconnections to make if a connection failure or timeout occurs. |
Retry interval (seconds)* Default Value: 0 Example: 15 | Integer | Specify the time interval between connection attempts. |
Retry policy Default Value: Connection errors Example: Connection and API limit exceeded errors (429) | Dropdown list | Choose the retry policy for connection and error responses. The available options are: Connection errors: Select this option when the client fails to establish a secure connection to the server. Connection and API limit exceeded errors (429): Select this option when the 10-second or daily limit is exceeded.
|
Snap Execution
Default Value: Execute only Example: Validate & Execute | Dropdown list | N/A | Select one of the following three modes in which the Snap executes: | Pipeline pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during
| Pipeline |
Troubleshooting
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 fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:
<screenshot of Pipeline/Snap and description>
...
|
---|
Multiexcerpt fast include block macro |
---|
macro_uuid | 386ec55d-edb1-4bf2-80f2-ed7891a47dff |
---|
name | Troubleshooting_missing_required_parameters |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
| Multiexcerpt fast include block macro |
---|
macro_uuid | 6703ac8b-4036-40cc-b4dd-f7ce9184f2a0 |
---|
name | Troubleshooting_missing_reqd_params_reason |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
| Multiexcerpt fast include block macro |
---|
macro_uuid | 3d6c1306-48c8-4570-b4a8-fdd9518f2a63 |
---|
name | Troubleshooting_missing_reqd_params_resolution |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
|
Multiexcerpt fast include block macro |
---|
macro_uuid | 3fa9a37e-fb5e-4f9a-9a65-eede77e8cf9d |
---|
name | Troubleshooting_rolling_limit |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
| Multiexcerpt fast include block macro |
---|
macro_uuid | 53dd1190-0909-47d6-af98-438b5111cbb5 |
---|
name | Troubleshooting_rolling_limit_reason |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
| Multiexcerpt fast include block macro |
---|
macro_uuid | a1b27a7b-2df6-412d-a7c8-caff99ac65d3 |
---|
name | Troubleshooting_rolling_limit_resolution |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
|
Multiexcerpt fast include block macro |
---|
macro_uuid | cd5f1deb-f07b-494c-bcd9-a68874db4637 |
---|
name | Troubleshooting_daily_limit |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
| Multiexcerpt fast include block macro |
---|
macro_uuid | 75f8b371-a0c7-4d19-8a4c-1a7c14d9996a |
---|
name | Troubleshooting_rolling_limit_reason |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
| Multiexcerpt fast include block macro |
---|
macro_uuid | 105a0f49-a7eb-4be0-beb8-74cb415e2ba8 |
---|
name | Troubleshooting_daily_limit_resolution |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Create |
---|
addpanel | false |
---|
|
|
Examples
Update a batch of companies
The following example pipeline demonstrates how to update the batch of companies in HubSpot.
...
Configure the JSON generator Snap to provide the details to be updated for the specific companies. On validation, you can view the JSON output in the output preview.
...
Configure the Mapper Snap to map the output details from JSON generator Snap to the corresponding fields in HubSpot.
...
On validation, the JSON input fields are mapped to the HubSpot entity fields as follows:
...
Finally, configure the HubSpot Bulk update Snap with the Company Entity and Update a Batch of Companies action.
...
On validation, the HubSpot Bulk Update Snap updates a batch of companies with the specified details as follows:
...
Downloads
Info |
---|
Download and import the Pipeline into SnapLogicSnapLogic® Platform. Configure Snap accounts, as applicable. Provide Pipeline pipeline parameters, as applicable.
|
Attachments |
---|
patterns | *.slp, *.zip |
---|
sortBy | name |
---|
|
Snap Pack History
...
title | Click here to expand... |
---|
...
Related Content
...
Endpoint Doc Link 1
...
Endpoint Doc Link 2
...
Multiexcerpt include macro |
---|
macro_uuid | bc80a734-84f7-450c-b83f-2b8bf52cf771 |
---|
name | HubSpot_SPH |
---|
templateData | eJyLjgUAARUAuQ== |
---|
page | HubSpot Snap Pack |
---|
addpanel | false |
---|
|
...
Related Content