In this Page
Table of Contents |
---|
maxLevel | 2 |
---|
exclude | Additional Resources|Related Links|Related Information |
---|
|
This page describes common best practices for pipeline design and development, pipeline management, and administration. Table of Contents |
---|
maxLevel | 4 |
---|
minLevel | 2General
Expand |
---|
title | Know how to clear your browser cache. |
---|
|
If you experience odd behavior for no apparent reason, clear your browser cache before you log into the latest SnapLogic Elastic Integration Platform. See the appropriate documentation for your browser: |
...
Expand |
---|
title | Platform Upgrades and Accounts |
---|
|
Some accounts may have a fixed time for refresh tokens, such as Google accounts must be refreshed every hour. If that refresh needs to occur when the platform is down for an update, the refresh does not occur. To prevent these accounts from failing after a new platform deployment, it is recommended that you refresh your accounts before the designated down time. Video: SnapLogic Best Practices: Scaling Your Integrations |
Pipeline Design and Development
Expand |
---|
title | Use a naming convention. |
---|
|
Standardize on a naming convention for pipelines and maintain this convention consistently across all pipelines and resources. Adopt a standard that fits in with your organization. Pipeline names should ideally indicate execution level (Main execution pipeline or Sub helper pipeline), integration name (typically names of endpoints, if applicable), and operation (can include type of data processed, or data conversion if applicable). Considering that projects maintain alphabetical pipelines, it is usually best to name them strategically. The rule of thumb here is to name pipelines from the highest identifier to the lowest, most concrete identifier. This is especially useful in cases where pipelines are nested within one another. For example, in the case of a SalesForce integration to SQL, you could have “Main SalesForce to SQL”, “Sub SalesForce to SQL Transfer Customers”, “Sub SalesForce to SQL Transfer Leads”. Note |
---|
Unless otherwise noted, the names of any asset or project is limited to UTF-8 alphanumeric characters and these punctuation characters !"#$%&'()*+,-.:;<=>?@[\]^_`{|}~. |
Recommend Pipeline Naming Conventions - <verb><Business function>, such as getCustomerOrder
- <verb><Business function>_< optional from system>_< optional to system>, such as getCustomerOrder_SFDC_SQL
- prepend child pipelines with the same characters, such as sub_ or z_
|
...
Expand |
---|
title | If your pipeline fails, retry the validation. |
---|
|
If a pipeline fails for unknown reason, click Save after any modifications, then click Retry before running your pipeline again. This will clear the cached data and gather new preview data based on the latest pipeline configuration. For scheduled pipelines, close all open-ended Snaps (remove open output/error views). Start Ultra pipelines with listener Snaps like JMS Consumer. Select Ignore empty stream in the JSON Formatter Snap to prevent generating empty output when no input data is provided. |
Pipeline Management
Expand |
---|
title | Rename Snaps when you place them in your pipeline. |
---|
|
By giving each Snap in your pipeline a unique name, it will be easier to identify the correct log information for that Snap in the runtime logs, especially if you are using multiples of the same Snap. |
...
Expand |
---|
title | Set up notifications for pipeline events. |
---|
|
When pipelines tasks are configured to schedule pipeline runs or allow them to be triggered, you can have notifications sent when the task has started, completed, failed, or stopped. |
Tasks
Expand |
---|
title | Triggered Tasks: General Information |
---|
|
Pipelines configured as triggered tasks can expose a maximum of (x1) unconnected output views. The Task Execute Snap will timeout at the platform after 15 minutes. This is irrespective of whether the pipeline is active or idle.
|
...
Expand |
---|
title | Triggered Tasks using an On-Premises URL |
---|
|
If the Snaplex node on which the task is running is patched to mrc205 or higher, there is no platform-enforced restriction on execution time. If the Snaplex node is not patched to at least mrc205, the task may fail after 10 minutes. The 10 minute timeout for local url (pre-mrc205) happens for pipelines which are not active, if the pipeline output view is continuously streaming results, the timeout does not apply.
By default, the remote request will return asynchronously after starting the pipeline. The platform will not return a default response document.
|
Administration
Expand |
---|
title | Do not share credentials. |
---|
|
Multiple people logging in with the same credential can lead to someone unintentionally modifying your work. |
...