Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Having added all resources that you want to include in an app (custom connectors, process flows, scripts, and cross-reference lookups) you can create an app and upload it to your private marketplace. This guide walks through the steps needed to achieve this.
Creating and uploading an app requires you to select existing resources that you want to include. As such, all required resources (custom connectors, process flows, scripts, and cross-reference lookups) must be created and ready to use within your own multi-company profile - i.e.:
Any custom connectors must be created
Any Patchworks prebuilt connectors must be installed
Any process flows must be created, enabled, and deployed
Any scripts must be saved and deployed
Any cross-reference lookups must be installed/created
If you manage multiple companies, it's important to ensure that you're switched to your own company profile before creating required apps (and associated resources). For more information please see our private marketplaces page.
Having created/installed/deployed all resources that you want to bundle as an app, follow the steps below to build and upload your app.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
Step 2 Select the marketplace option from the left-hand navigation menu, then click the build new app option:
If you don't see this option, it's likely that your user account does not have the required permissions. Please contact Patchworks support if this is the case.
...now you can use the create an app form to select all resources that you want to include in this app:
Step 3 First, enter a name for this app (this name is displayed for users to see in your private marketplace) and - if available - a link for any existing help documentation.
Step 4 Use the process flows dropdown list to select any process flows that you want to include:
Here you'll see all process flows that have been created within the current company profile, which are deployed.
Step 5 By default, any connectors found in previously selected process flows (via connector shapes) will be selected for inclusion in this app. If required, you can use the select connectors field to choose additional connectors to be be included:
The select connectors list will show all connectors that you have installed or built, which are NOT already selected.
Step 6 By default, any cross-reference lookups found in previously selected process flows (via map shape transformations) will be selected for inclusion in this app. If required, you can use the select cross-reference lookups field to choose additional lookups to be be included:
The select cross-reference lookups list will show all lookups that you have installed or created, which are NOT already selected.
Step 7 By default, any caches found in previously selected process flows (via add to cache and load from cache shapes) will be selected for inclusion in this app. If required, you can use the select caches field to choose additional caches to be be included:
The select caches list will show all caches that you have created, which are NOT already selected.
Step 8 By default, any data pools found in previously selected process flows (via the de-dupe shape) will be selected for inclusion in this app. If required, you can use the select data pools field to choose additional data pools to be be included:
Step 9 Click the upload button to upload this app to your private marketplace:
The upload is queued for processing and will be completed as soon as possible. Check your notification centre for confirmation if you miss the popup message when this is done:
If you manage multiple company profiles, it can be useful to share resources between them. With appropriate user roles & permissions, you can access a private marketplace for your company profile. Any apps, connectors, process flows, scripts, or cross-reference lookups that you build can be uploaded to your private marketplace, to be viewed/installed by:
Users associated with your own 'parent' company profile
Users associated with any 'child' companies that you manage
To upload resources to your private marketplace, your user account must be associated with an administrator role.
Any users associated with your own company profile, or with one of your 'child' company profiles can view everything in your private marketplace.
To download resources from your private marketplace, user accounts must be associated with a manager role or above.
You can bundle resources into an app and upload this app to your private marketplace. An app can include Patchworks connectors, custom connectors, process flows, scripts, cross-reference lookups, caches and data pools.
You can upload individual custom connectors, process flows, scripts, and cross-reference lookups to your private marketplace.
To upload a process flow (or bundle a process flow in an app), it must be enabled, and deployed.
To upload a script (or bundle a script in an app), it must be saved and deployed.
If you manage multiple company profiles and you have required permissions to upload resources to a private marketplace, you have two options for uploading resources:
Upload resources to the private marketplace associated with your own company profile. These resources can be installed by users associated with your own company profile, and by users in any 'child' companies that you manage.
Upload resources to the private marketplace associated with a child' company profile. These resources can only be installed for that 'child' company profile.
Whilst there may be occasions where it's useful to upload resources to the private marketplace for a 'child' company, our suggested approach is to:
Build/create resources in your 'parent' company profile.
Upload these resources to your own private marketplace so they can be shared by all of your 'child' company profiles.
It's important to think about which company profile you are switched into when building/creating resources that you want to upload to the private marketplace. Resources must exist in whichever company profile you are using to upload to the private marketplace.
Having built a custom connector (or edited a Patchworks connector to work in a different way), you can upload it to the connectors section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a custom connector to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource. If you just want to include the connector in a process flow or an app, you don't need to upload it separately - please see Uploading process flows to your private marketplace or Uploading apps to your private marketplace.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
Step 2 From the left-hand navigation menu, select process flows | connectors options - all of your installed/custom connectors are listed.
Step 3 Find the connector that you want to upload - it should be displayed with the name of your company profile (rather than Patchworks) and an upload option:
Step 4 Click the upload option.
If you don't see an upload option, it's likely that your user account does not have the required permissions. Please contact Patchworks support if this is the case.
Step 5 The upload is queued for processing and will be completed as soon as possible. Check your notification centre for confirmation if you miss the popup message when this is done:
When you upload a process flow, any configured connectors, scripts, cross-reference lookups, caches and de-dupe pools will be included.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
Step 2 From the left-hand navigation menu, select process flows | process flows options - all of your process flows are listed.
Step 4 Click the settings option from the actions bar:
Move down to the versions panel and ensure that the deployed version is displayed - check that this is the version that you want to upload.
If you don't want to use the version that's currently deployed, you should edit the draft and deploy this.
Step 5 Click the ellipses associated with the deployed version and select the upload to marketplace option:
Step 6 Click the upload button to upload this process flow to your private marketplace. The upload is queued for processing and will be completed as soon as possible. Check your notification centre for confirmation if you miss the popup message when this is done:
Having , , and a process flow, you can upload it to the process flows section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a process flow to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource. If you just want to include the process flow in an app, you don't need to upload it separately - please see .
Ensure that the process flow you want to upload is and .
Step 3 Click the name of the process flow that you want to upload - the process flow is displayed.
You'll only see this option for a deployed process flow. If you are checking a deployed version and this option isn't shown, it's likely that your user account does not have the required permissions. Please if this is the case.
Having saved and deployed a custom script, you can upload it to the scripts section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a script to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource.
If you just want to include the script in a process flow or an app, you don't need to upload it separately - please see Uploading process flows to your private marketplace or Uploading apps to your private marketplace.
Ensure that the script that you want to upload is saved and deployed.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
Step 2 From the left-hand navigation menu, select process flows | scripts options - all of your custom scripts are listed.
Step 3 Find the script that you want to upload - it should have a deployed status:
Step 4 Click the name of the script to access script details, then click the upload button:
You'll only see this option for a deployed script. If you are checking a deployed version and this option isn't shown, it's likely that your user account does not have the required permissions. Please contact Patchworks support if this is the case.
Step 5 The upload is queued for processing and will be completed as soon as possible. Check your notification centre for confirmation if you miss the popup message when this is done:
Having created and saved a cross-reference lookup, you can upload it to the cross-reference lookups section of your private marketplace. This guide walks through the steps needed to achieve this.
You only need to upload a cross-reference lookup to your private marketplace if you want to make it available for your users (and your linked company users) to download as a standalone resource.
Step 1 Login to the Patchworks dashboard - make sure that you're switched to your own 'parent' company profile (rather than a 'child' company that you manage).
Step 2 From the left-hand navigation menu, select the cross-reference lookups option - all of your cross-reference lookups are listed.
Step 3 Click the name of the lookup that you want to upload, to access details, then click the upload button:
Step 4 The upload is queued for processing and will be completed as soon as possible. Check your notification centre for confirmation if you miss the popup message when this is done:
If you just want to include the cross-reference lookup in a process flow or an app, you don't need to upload it separately - please see or .
If you don't see an upload option, it's likely that your user account does not have the required permissions. Please if this is the case.
If you need to change any component within an app that's in your private marketplace (i.e. an app that has been uploaded to your private marketplace and is available from the apps tab), you need to follow the steps below.
Step 1 Make the required changes to connectors, process flows, scripts, or cross-reference lookups.
Step 2 Delete the existing app from your private marketplace.
Step 3 Upload a new app with updated resources.
Uploading a new app does not update any existing installations. If a private marketplace app has been installed (either in your own company profile or for a linked company profile) you will need to switch to the relevant company profile and make any required changes to installed resources.
If you need to change a custom connector that's in your private marketplace (i.e. a connector that has been uploaded to your private marketplace and is available from the connectors tab), you can make required changes and then re-upload the connector - the steps for this are:
Step 1 Select process flows | connectors & instances from the left-hand navigation menu to view all of your installed/custom-built connectors.
Step 2 Find the connector that you want to update and make changes to the connector settings as needed:
Step 3 When any changes are saved for a connector that has already been uploaded to the marketplace, a re-upload button becomes available:
Step 4 If this connector is in use for any of your linked ('child') companies, you'll see an update available option when viewing connectors in that company profile - for example:
...use this to install your updates.
If you need to change a process flow, script, or cross-reference lookup that's in your private marketplace, you need to follow the steps below.
Step 1 Make the required changes to the resource.
If you change a process flow, ensure that the required version is enabled and deployed.
If you change a script, ensure that it's saved and deployed
Step 2 Delete the existing resource from your private marketplace.
Step 3 Upload the updated resource.
Uploading a new resource does not update any existing installations. If a private marketplace resource has been installed (either in your own company profile or for a linked company profile) you will need to switch to the relevant company profile and make any required changes there.
Having built resources that you want to share, they can be uploaded to your private marketplace. You can upload a package of resources as an app, or individual components (connectors, process flows, scripts, and cross-reference lookups.
Uploading a new connector
Your private marketplace can be accessed via the main Patchworks marketplace - it's simply a case of toggling between 'public' and 'private'.
Step 3 Click the private tab to the right of the tabs:
Any resources that have been uploaded by users associated with your company profile or (for linked companies) your parent company profile are displayed - for example:
Step 1 Log into the dashboard and (if you're managing multiple company profiles) ensure that you're .
Step 2 Select a tab to view: , , , , or .