The anatomy of a blueprint
Last updated
Last updated
A blueprint can include any number and combination of the following components:
| Resource | Notes |
|---|---|
A blueprint will always include at least one process flow. | |
All connectors used in process flows are installed. Prior to installation, you can choose to add required connector instances - or you can just install the connectors and add instances later. If the blueprint includes a connector that you have already installed from the connector marketplace, a fresh copy of that connector is added alongside the existing one. You can then decide which one to use. | |
All scripts defined in process flow script shapes and/or map shape field transformations are installed and deployed, ready for use. | |
All cross-reference lookups defined as process flow map shape field transformations are installed and ready for use. | |
Any data pools defined in process flow de-dupe shapes are added. These are 'clean' data pools (i.e. with no associated data), ready for use. | |
Any caches and cache keys defined in process flow add to cache shapes are added. These are 'clean' caches (i.e. with no associated data), ready for use. |
Each blueprint in your marketplace is displayed with a visual summary of what's included - for example:
For more information about this summary please see The Patchworks marketplace.
If you click on a blueprint tile, you can see a detailed breakdown of what's included:
From here you can:
Any connectors included with the blueprint are installed as part of the install process. To use these connectors in process flows, you must add an instance of each - this is where you provide your authentication credentials for the associated third-party system.
If you have your credentials to hand, add them now using the add instances options provided - for example:
You are prompted to choose an authentication method and then enter your credentials - for example:
When you save instance details and then install the blueprint, these instances are created as part of the installation. As a result, all connector shapes in process flows will be configured with these instances automatically.
It's not mandatory to add your instances as part of the blueprint installation. You can install the blueprint and add instances afterwards via your manage connectors page. If you do this, you must apply these instances to process flow connector shapes manually.
You cannot add instances that require OAuth 2 (Client Credentials) authentication, via the blueprint install process. If a blueprint includes connectors that require OAuth 2 (Client Credentials) authentication then you should install the blueprint and add instances afterwards via your manage connectors page. If you do this, you must apply these instances to process flow connector shapes manually.
If a blueprint includes a process flow that you're sure you don't need, you can prevent it from being installed here - clicking the install button toggles to don't install:
Typically, process flows are key to the successful implementation of blueprints. We recommend installing all included process flows unless you have a specific reason not to do so.
