Birst Upload

Overview

You can use this Snap to write and upload data to Birst.


Birst Upload Overview

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has exactly one document input view. The format of the document is expected to be a flat map, having only scalar values as attributes. The map values will be formatted into a CSV record.
Output This Snap has at most one document output view. The view will provide the status of the upload or publish (if publish option is enabled).
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. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when 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

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (Plus Icon): Indicates that you can add fields in the field set.
  • Remove icon (Minus Icon): Indicates that you can remove fields from the field set.
Field / Field set Type Description
Label String Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.
Data source String/Expression

Specify the name of the data source where you want to upload the data.

Default value: N/A

Example: Foobar2
Space id String/Expression Required. Specify the Space ID on Birst to upload to.

Default value: N/A

Example: 3a38cbe4-31e6-49c1-a5a8-b3bfa41ed9af
Publish post upload Checkbox Required. Select this option to publish the data on Birst when the upload completes.

Default status: Deselected

Example: Selected
Contains headers Checkbox Required. Select this option to indicate that the incoming data contains a header.

Default status: Selected

Example: Deselected
Subgroups Use this field set to process groups to publish the data. The groups need to be defined in the data source first.
Subgroups column String/Expression/Suggestion Required. Specify the names of the processing groups to publish the data source. The property accepts pipeline parameters.

Default value: N/A

Example: ProductSubcategory
Note: You must predefine the processing groups in the Data Source's properties on Birst. To predefine the properties, navigate to ADMIN > Define Sources > Manage Sources > <source name> > Properties > Processing Group Name(s).
Publish timeout Integer

Specify the seconds to wait for publishing to Birst to finish. If the timeout threshold is exceeded, then the pipeline will fail.

Default value: 40

Example: 30
Snap execution Dropdown list Select one of the three modes in which the Snap executes.
Available options are:
  • 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.
Note: It is possible that you will not see the published data by the Snap in Birst. In that case, follow Your-Space > Admin > Define sources > Manage sources. The uploaded files exists, but if you select any uploaded file and select the settings button, the Ignore source option is enabled. Here you want to disable the ignore option.