Multi environment management - best practice
Last updated
Last updated
When building and testing your process flows before going live, a common requirement is to build process flows that connect to development/staging instances of your third-party systems - this ensures that you're not working with live data during the testing phase.
This page details our suggested procedure for managing this approach in terms of:
Our suggested practice for adding process flows when you want to work with different environments is detailed in the following sections:
Step 1 or required connectors for third-party systems to be integrated in your process flows.
Step 2 of these connectors and specify your DEV/STAGE credentials (i.e. credentials that allow you to access data in your DEV/STAGE environment for the third-party system). It's a good idea to indicate DEV/STAGE as part of the instance name. For example:
Step 3 Move down to the labels section and apply a label that indicates that this process flow is configured for your DEV/STAGE environment - for example:
Step 6 Test carefully to ensure that the right data (i.e. DEV/STAGING data) is processed as expected.
Step 2 Update the process flow name as required. You may wish to indicate PRODUCTION as part of the process flow name but this isn't essential if you follow subsequent steps to apply labels.
Step 3 Move down to the labels section. Remove the existing DEV/STAGE label and replace it with a label that clearly indicates that this process flow is configured for your PRODUCTION environment - for example:
Step 4 Save changes.
Step 6 Check all other shapes in your process flow - if instance details are present, ensure that the PRODUCTION instance is selected.
Step 7 Check other shapes in your process flow. Typically, any instance information defined for a connection shape is inherited by subsequent 'child' shapes (which require instance details) in the flow. However, it's always worth double-checking before going live.
At this point, you now have different 'environment flavours' of the same process flow - for example:
If you need to update a PRODUCTION process flow, there are two options, summarised below.
This approach requires caution! Connections in the flow are configured for your live data, so you need to be sure that you've adjusted relevant filters during the testing phase.
Remove the 'old' PRODUCTION process flow
Step 3 of these connectors again, this time using your PRODUCTION credentials (i.e. credentials that allow you to access data in your PRODUCTION environment for the third-party system). It's a good idea to indicate PRODUCTION as part of the instance name. For example:
Step 1 with the required name and description. You may wish to indicate DEV/STAGE as part of the process flow name but this isn't essential if you follow subsequent steps to apply labels.
Step 2 From the process flow canvas, access .
If required labels don't exist, you can create them 'on the fly' from here, or go to settings > labels for label management. More information is available in our section.
Step 4 Build the process flow. When configuring , ensure that you select the DEV/STAGING instance:
Step 5 as required. If you are required to select instances for other shapes in your flow, always ensure that you select the DEV/STAGING instance.
Step 1 When you're satisfied that your process flow is working correctly, .
Step 1 Edit the duplicated process flow and access .
If required labels don't exist, you can create them 'on the fly' from here, or go to settings > labels for label management. More information is available in our section.
Step 5 For every in the process flow, access settings and change the DEV/STAGING instance to the equivalent PRODUCTION instance:
Step 8 When you're ready, and the process flow.
Keep in mind that your determines the number of active (i.e. deployed and enabled) process flows that are allowed for each company profile.
Once your PRODUCTION version is in place and running, we advise that you the DEV/STAGE version but leave it in place to test any future updates.
Edit the of the existing PRODUCTION process flow and deploy changes once you're satisfied that the flow is running correctly.
Edit and test the existing DEV/STAGING version of the process flow. Once testing is complete, follow steps in , and above to duplicate the process flow and configure PRODUCTION connections. Having done this, you can either:
Retain the 'old' PRODUCTION process flow but apply an ARCHIVE and ensure it's .