Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
minLevel1
maxLevel2
absoluteUrltrue

Overview

Using this snap, you can You can use this Snap to update bulk data objects in the HubSpot portal.  For more information   Learn more about HubSpot APIs, see HubSpot Documentation.

Snap Type

The HubSpot Snap is a Write type Snap.

Prerequisites

None.

Support for Ultra Pipelines  

Works in in Ultra Pipelines. Known Issues and Limitations

Limitations

None.

Known Issues

Records only up to 100 can be updated in single run.

Support for Ultra Pipelines

 

Limitations

None.

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or Document

  • Min: 1

  • Max: 1

  • HubSpot Read

  • Mapper

  • Copy

  • ..

Requires the EDI data and internal ID as a JSON document.

Output

Document

Binary

Binary or A document containing details identifying the entity(s) to update along with the information to update.

Output

Document

  • Min: 0

  • Max:

  • ..

  • ..

The EDI transaction ID and order confirmation
  • 1

  • JSON Formatter + File Writer

  • Mapper

  • Copy

  • HubSpot Read

A document containing details of the updated entity(s).

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

...

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 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

...

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 ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

  • Remove icon ( (blue star)): Indicates that you can remove fields from the fieldset.

  • Upload icon ((blue star) ): Indicates that you can upload files.

ELT Database Account ELT RS AccountThe You can modify this to be more specific, especially if Snap in your Pipeline.

Specify advanced parameters that you want to include in the request.

<value> or None.<value>

Field Name

Field Type

Field Dependency

Description

Label*

Default Value

HubSpot Bulk Update

Example

Bulk Update Companies

String

None.

Specify a name for the Snap.

  If you have more than one of the same

Number of recordssnaps in the pipeline, you can modify this and create a unique name.

API Version*

Default Value: V3

Example: V4

String

Select the version of the API that you are using for the pipeline.

Category

Default ValueN/A

Example: CRM

String/Expression

Sampling Type is Number of records.

Enter the number of records to output.

fieldset Name

Field 1

Required. Select the application in which you are updating the data objects.

Entity

Default ValueN/A

ExampleCompanies

String

Required. Select the data object to be updated.

Action

Default ValueN/A

ExampleUpdate a batch of Companies

String

Required. Select the action to be performed by the snap. Clicking the  icon lists the supported actions. 

Required Parameters

Use this field set to enable the Snap to perform a specific action.

Parameter*

Default Value: N/A
Example: company.id

String

Specify the names of the required parameters.

Value*

Default Value

 N/A
Example

company.id

String

Debug mode check box is not selected.

Field 2Multiple

Specify the values for mentioned parameters. The data type of this field depends on the specified parameter.

Connection Timeout

Default Value<value> or None.
Example<value>

String

None30

Example30

Integer

 Required. A time period within which the snap should be run.

Number of re-tries

Default Value: 0

Example: 3

Integer

Required. The maximum number of re-connection attempts in case of a failure or timeout.

Retry Interval

Default Value: 0

Example: 15

Integer

Required. The time interval between consecutive reconnection attempts.

Snap Execution

Default Value
Example: Validate & Execute

Dropdown list

N/A

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, 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 that are downstream from it.

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 fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:

<screenshot of Pipeline/Snap and description>

...

Examples

Updating a Batch of Companies

The following example pipeline demonstrates how to update the batch of companies in the HubSpot portal.

...

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 the HubSpot.

...

On validating, the JSON input fields are mapped to the HubSpot entity's fields as shown in the Mapper snap's output below:

...

Finally, the output from the Mapper snap is passed on to the HubSpot Bulk Update snap. The HubSpot Bulk update snap is configured with the Company Entity and Update a Batch of Companies action.

...

On running the HubSpot Bulk Update Snap, it updates a batch of companies with the mentioned details as shown in the screenshot below.

...

Downloads

Info
  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts, as applicable.

  3. Provide Pipeline parameters, as applicable.

Attachments
patterns*.slp, *.zip
sortByname

Snap Pack History

Expand
titleClick here to expand...

...

Multiexcerpt-include

...

-macro
macro_uuidbc80a734-84f7-450c-b83f-2b8bf52cf771
nameHubSpot_SPH
templateDataeJyLjgUAARUAuQ==
pageHubSpot Snap Pack
addpanelfalse

...

Related Content

...