SnapLogic Create

Overview

You can use this Snap to create SnapLogic assets, such as accounts, tasks, pipelines, and projects.


SnapLogic create Overview

Snap views

Type Description Examples of upstream and downstream Snaps
Input This Snap has one document input view. Every input document, regardless of asset type, must include these core fields:
  • label: Unique name for the asset. Example, MyOracleAccount
  • asset_type: Type of asset to create. Example, ACCOUNT, TASK, PIPELINE
  • asset_path: Absolute path in SnapLogic org. Example, /<org>/<project_space>/<project>/<asset_name>
 Mapper
Output This Snap has, at most, one document output view. On successful execution, the Snap outputs a document with the created asset's details:
  • Asset name
  • Asset type
  • Timestamp of creation
  • Path where the asset was created
Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field/Field set Type Description

Label

String

 String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: SnapLogic Create

Example: SnapLogic Create1
Asset type String
Required. The type of Asset to operate on. Options available include:
  • TASK: Creates a scheduled or triggered task
  • ACCOUNT: Creates a new account
  • PIPELINE: Creates a new pipeline
  • PROJECT: Creates a project or project space
  • SNAPLEX: Creates a Snaplex node
  • FLOWS: Creates a flow asset

Default value: ACCOUNT

Example: TASK

Note: If the org is configured for Enhanced Account Encryption, the information you use to create an account is automatically encrypted.
Asset path String/Expression

Required. Specify the absolute path for the asset in the following format:

<org>/<project_space>/<project>/<asset>

Default value: N/A

Example: /myorg/Engineering/Status/LatestDefects
Snap execution

Dropdown list

 Dropdown list
Choose 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.

Default value: Execute only

Example: Validate & Execute
Important: The SnapLogic Create Snap is not typically used to create an asset from scratch. Instead, use the SnapLogic Read Snap to retrieve an existing, similar asset and use the returned JSON as a template. Modify the template as needed before passing it to the SnapLogic Create Snap. This approach reduces the effort required to construct the JSON input manually and helps prevent formatting errors.

Asset-specific input document formats

Asset Type Description and Format
ACCOUNT The most documented asset type. The input JSON must include the account's class definition and configuration properties specific to the account type (example, Oracle, Salesforce, JDBC, etc.): 
{
  "class_id": "<account_class_id>",
  "class_fqid": "<fully_qualified_class_id>",
  "label": "OracleAccount_2023-10-17T08:49:37.056Z",
  "username": "<db_username>",
  "password": "<db_password>",
  ...
}
Tip: If Enhanced Account Encryption is enabled on your org, credentials in the input document are automatically encrypted at rest.
TASK A Task asset input document defines a scheduled or triggered execution of a pipeline: 
{
  "label": "MyScheduledTask",
  "asset_type": "TASK",
  "asset_path": "/<org>/<project_space>/<project>/MyScheduledTask",
  "pipeline_path": "/<org>/<project_space>/<project>/MyPipeline",
  "schedule": "...",
  "runtime_parameters": { ... }
}
PIPELINE A Pipeline asset input document defines the pipeline's JSON structure: 
{
  "label": "MyPipeline",
  "asset_type": "PIPELINE",
  "asset_path": "/<org>/<project_space>/<project>/MyPipeline",
  "description": "...",
  "snap_configurations": [ ... ]
}
PROJECT Covers both Projects and Project Spaces: 
{
  "label": "MyProject",
  "asset_type": "PROJECT",
  "asset_path": "/<org>/<project_space>/MyProject"
}
SNAPLEX Defines a Snaplex (execution engine) configuration: 
{
  "label": "MySnaplex",
  "asset_type": "SNAPLEX",
  "asset_path": "/<org>/<project_space>/MySnaplex",
  "groundplex": true,
  ...
}
FLOWS SnapLogic Flow assets follow a similar pattern to pipelines but represent low-code/no-code integration flows.

Troubleshooting

None.

Examples