| Feature ↓ | Trial | Standard | Professional | Enterprise |
|---|---|---|---|---|
| Deployed connectors (i.e. connectors used in enabled & deployed process flows) | 2 | 2 | 5 | Starting at 10 |
| AI Studio Tokens | 1000000 | 2500000 | 7500000 | 20000000 |
| Concurrent running process flows | 2 | 10 | 25 | Starting at 30 |
| Operations (per month) | 100,000 | 150,000 | 400,000 | Starting at 1,000,000 |
| Patchworks API (per minute) | 240 | 240 | 240 | Starting at 240 |
| Webhooks (per minute) | 2 | 120 | 120 | Starting at 120 |
| Callbacks (per minute) | 2 | 240 | 240 | Starting at 240 |
| Email notifications (per month) | 100 | 1000 | 1000 | Starting at 1000 |
| Virtual environments | 2 | 2 | 5 | Starting at 2 |
| Cache memory (MB) | 0 | 50 | 50 | Starting at 50 |
Connectors in process flows
**Connectors** and [instances](#instance) are the key building blocks in [process flows](#process-flow). A **connector** is a generic integration of a third-party business system/application - it contains everything needed 'under the hood' (for example, endpoints, authentication methods, etc.) to sync data from/to the associated application. You must [install a connector](/product-documentation/connectors-and-instances/working-with-connectors/installing-a-connector) for any third-party application that you wish to integrate with Patchworks. As you'd expect, Patchworks has made this easy for you, with a curated library of prebuilt connectors in the [Patchworks marketplace](/product-documentation/marketplace/the-patchworks-marketplace). Having installed a connector, you can then add as many [instances](#instance) of it as you need for use in your [process flows](#process-flow). For more information please see: [Connectors & instances](/product-documentation/connectors-and-instances/connectors-and-instances-introduction).Connectors in services
A **connector** is the mechanism that Patchworks uses to configure a [system](#system) for use in [services](#services) - it's how we store your system credentials in a single, easy-to-manage place. For more information please see: [Working with services](/product-documentation/patchworks-services/working-with-services/accessing-services).
| Microservices are used to build the Patchworks platform - small, independent services that communicate with each other, allowing for flexibility, scalability, and easier maintenance. | microservices.png | ||
| API first is key for powerful integrations. Our next-generation dashboard is driven by powerful APIs which means we can integrate with any other API simply and seamlessly. | banner5 api.png | ||
| Cloud-native development facilitates our microservice architecture, Kubernetes deployments, DevOps infrastructure as code, and much more! | banner cloud.png | ||
| Headless is exactly what you'd expect for an API-first platform. The Patchworks backend is built with our own API, which is then consumed by the dashboard for general use. | headless.png |
| Kubernetes pod and node auto-scaling Ensure that integrations run consistently, even in the busiest times. See our auto-scaling page for more information. | banner1 k8s 2.png | ||
| We use AWS RDS for all critical databases. Our databases have full redundancy with one ‘read’ and one ‘write’ copy of each. | banner2 rds 2.png | ||
| Each database copy is hosted in a separate availability zone so, in the unlikely event of a failure in one zone, we can fall back to the other. | banner 3 ha.png |
| Real-time logs (via web sockets) can be viewed while a process flow runs, with visibility of request, response and payload information at every step. | banner4 logs.png | ||
| Logs are retained for one month for retrospective problem-solving. | banner retention.png | ||
| Webhooks, events, and inbound API requests can all be tracked through the Patchworks Dashboard - you don’t need to be an engineer to figure out when/where execution errors occur. | banner monitor.png |
| We manage all API updates for our library of prebuilt connectors. | banner5 api.png | ||
| We take care of all supported authentication mechanisms (OAuth, token, API key, etc.). | banner6 auth.png | ||
| We've removed all the complexity when it comes to building and maintaining new integrations. | banner build.png |
| Our multi-tenant architecture means that customers have the benefits of shared software and infrastructure, secure in the knowledge that each customer's data is isolated and invisible to other tenants. | multi-tenancy-shared 2.png | ||
| Multi-tenancy provides a much faster solution, since we only search one set of data rather than everything - all database operations and secret storage is per-tenant. | multi-tenancy-search 2.png | ||
| Multi-tenancy allows flexibility for change - if necessary we can 'lift and shift' a tenant to a new database, or to a faster region, or even to a completely different cloud provider in a different continent! | multi-tenancy-change 2.png | ||
| Infrastructure updates are made via IaC (Infrastructure as Code). | banner7 iac.png | ||
| Infrastructure updates are peer-reviewed and authorised before being merged. | banner8 review.png | ||
| All production code flows through development and staging review cycles before release to production. | banner8 review.png | ||
| Every release must pass both automated and hands-on testing by our QA team. | banner 9 test.png |
| Product penetration testing is performed annually by an external, CREST-accredited organisation. | banner secure.png | ||
| Our Kubernetes nodes live in private subnets. | banner subnet.png | ||
| All key ingresses are IP whitelisted. | banner allow list.png | ||
| We adopt a 'least privilege' model for our development team, and also for users of our AWS and Kubernetes infrastructure. | least privilege.png | ||
| All key business systems must be accessed via a VPN | vpn.png | ||
| All staff use LastPass to generate and store strong passwords - 2FA access to LastPass is mandated. | lastpass.png |
| Access is managed via role-based permissions, so only authorised users can access integrations and data for their company profile(s). | banner role.png | ||
| Audit logs provide a complete history of all user account activity, including Patchworks users. | banner log.png | ||
| Users always control their own passwords - password resets are never performed on behalf of other users. | banner password.png | ||
| Single sign-on via Google is supported. | banner google.png |
| The system continuously monitors traffic and resource usage (CPU, memory). | auto scale tile 1.png | ||
| When usage exceeds predefined thresholds, the auto-scaler triggers. | auto scale tile 2.png | ||
| Additional resources/pods are deployed to handle the increased load | auto scale tile 3.png | ||
| When demand drops, resources are reduced to optimise costs. | auto scale tile 4.png |
- 13.42.116.71
- 13.41.182.240
- 35.179.222.179
- 18.168.241.46
- 18.168.94.149
- 13.41.170.82
| Cover image | |||
|---|---|---|---|
Platform Agents Agents built and maintained by Patchworks.
| platform-agents-tile.svg | Platform Agents | |
Custom Agents Build your own agents using prompts, tools and guardrails - connected to your systems and running on Patchworks infrastructure.
| ( Coming Soon ) | custom-agents-tile.svg | |
Every agent, one place Reach any agent available to your company without switching pages. | |
Full conversation history Every exchange is kept, so you can see what was asked and what the agent did. | |
Room to work A full-screen window instead of a docked panel - useful when an agent returns a flow, a mapping or a long answer. |
# Platform Agents Agents built and maintained by Patchworks. Each agent has a specific role and a set of capabilities that help you build and operate integrations faster. ### Overview Platform Agents are the first layer of AI Studio. They sit inside the Patchworks platform, understand your integration context, and can take action on your behalf. You interact with them through natural language - describing what you want to build or change - and the agent does the work.
{% endstep %} {% endstepper %}
{% stepper %} {% step %} ### **Create a new connector** From **Manage Connectors**, select **Create new connector**.
{% endstep %} {% endstepper %} ### **Connector Builder AI via Flow Builder** You don’t have to build connectors up front. When you ask the Implementation Agent to build a flow, it can build the connectors that flow needs at the same time -calling Connector Builder AI in the background as part of the same conversation. For example, prompt the agent with *“Build a Shopify to NetSuite order flow”* and *“Map Shopify to NetSuite order fields”*, and ask it to create any connectors it’s missing. The agent builds the new connectors, creates placeholder instances and mapping steps, and assembles the full flow on the canvas - all in one pass.
From the Platform Agents page
Navigate to **AI Studio → Platform Agents** and select the Documentation Agent card, then click **Start conversation**. Ask it to document a flow by name and it locates the flow, generates the documentation, and gives you a link to view it.
From the flow directly
Open any Process Flow and select **Flow documentation** from the flow toolbar. The agent generates documentation for the flow in place, showing the overview, trigger, data flow, and per-step breakdown in a side panel. Use **Regenerate** to refresh it after changes, or **Download PDF** to export a copy to share.
From a shape's Notes
**From a shape's Notes.** Open the **Notes** panel on any step and choose **Generate note with AI**. The agent documents what that individual step does - its configuration and effect on the payload - and drops the text straight into the note, ready to edit, colour-code, and save.
**Step 3**\
Select **my account settings**:
**Step 3**\
Select **my account settings**:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{% endhint %}
**Step 4**\
Click `register`:
{% endhint %}
**Step 6**\
Save changes.
## Stage 3: Patchworks - apply Azure AD / Entra credentials & enable
In this stage, we take client credentials generated in Azure AD / Entra, apply them to our Azure AD / Entra provider setup in Patchworks, and enable this SSO implementation.
**Step 1**\
Still in the Azure AD / Entra admin portal, select `overview` from the navigation bar, then copy the `application (client) ID`:
Patchworks logos
Right-click and save the desired logo with a `.png` file extension.
{% endhint %}
**Step 3**\
Set `token endpoint authentication method` to `client secret post`:
For more detailed steps, please refer to [Switching back to your own company](/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company#switching-back-to-your-own-company).
{% endhint %}
{% endstep %}
{% step %}
**Access your managed companies list**
In the top-left corner, click the arrow associated with your current company name and select the `switch companies` option:
This is useful if you want to collaborate with other team members (who have sufficient permissions) - they can access the company directly via this link, seamlessly switching to the relevant company profile.
{% endhint %}
**Step 4**\
You can now proceed to complete any required setup for this company (for example, [add and manage users](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles), add [connectors](/product-documentation/connectors-and-instances/working-with-connectors), [process flows](/product-documentation/process-flows/about-process-flows), etc.).
{% hint style="info" %}
If required, you can copy process flows from one of your managed companies into another. For further information please see
{% endhint %}
**Step 5**\
When you've finished working with this company, you should [switch back to your own company](#switching-back-to-your-own-company) to ensure that you don't make any subsequent updates in error.
## Switching back to your own company
When you've finished working with a managed company, follow the steps below to your own (i.e. original) company.
**Step 1**\
Click the arrow associated with your current company name and select the **switch companies** option:
For more detailed steps, please refer to [Switching back to your own company](/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company#switching-back-to-your-own-company).
{% endhint %}
**Step 2**\
Click the **settings** option at the bottom of the left-hand navigation bar:
| Item | Notes |
|---|---|
| id | The internal Patchworks id for the company. |
| Name | The company profile name. |
| Plans | This is typically only relevant for Patchworks admins for non-core systems. |
| Tiers | Current core subscription tier. |
| Parent | The name of the managing company (i.e. your own company profile) |
| Created at | The date & time the company profile was created. |
| Last login | The most recent date/time that someone logged into this company profile. |
| Last flow run | The date & time of the last process flow run. |
For more detailed steps, please refer to [Switching back to your own company](/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company#switching-back-to-your-own-company).
{% endhint %}
**Step 2**\
Choose to [view your linked companies](/product-documentation/company-management/multi-company-profiles/viewing-linked-companies-for-your-multi-company-profile) for a list of all companies that you have permission to manage:
| Item | Summary |
|---|---|
| 1 | Subscription information Your Patchworks subscription is displayed as a button - click this to view your allowances, with access to more information on subscription tiers:  Allowances shown are for the current company profile. If you operate under an 'annual billing' agreement, the allowances shown here will be those available for the current company profile, multiplied by 12. |
| 2 | Monthly usage date selector Choose a time period to analyse: |
| 3 | Managed company selector. If you manage multiple company profiles, you'll see insights for your own (parent) company profile by default. You can also use this dropdown field to view aggregated insights for all your linked companies. |
| 4 | Performance snapshot panel At a glance, view your aggregated data and operations usage. These numbers are for the month, data type, and (if applicable) the managed company option currently selected. |
| 5 | Download the current summary as a CSV file. The CSV file is delimited with a single comma and includes the following fields: |
| 6 | Data selectors Choose the type of data be analysed (process flows, connectors, or shapes). |
| 7 | A visual representation of usage by day, for the month and data type currently selected. |
| 8 | A breakdown of each process flow, connector, or shape (depending which data type is selected) that's included in aggregated totals for the selected month. |
| 9 | A visual representation of tracked records (inbound or outbound) for a selected time period. |
| Metric | Summary |
|---|---|
| Data usage | The aggregated size of all payloads that leave each shape in a process flow - these are known as payloads out. |
| Operation usage | The total number of operations completed. For more information about how operations are calculated please see About operations. |
| By month Usage analysis is shown for each day within the selected month.  |
| Last 12 months Usage analysis is shown for each month within the last 12 months.  |
| Custom date (3 months or less) Usage analysis is shown for each day within the selected period.  |
| Custom date (+3 months) Usage analysis is shown for each month within the selected period.  |
| Hover your cursor over an option to bring the corresponding data into focus: |  | |
| Click an option to toggle the corresponding data on/off: |  | |
| Hover your cursor over any data point to view summary information: |  |
| Choose a time period You can use the time period selector to choose which records to view: |  | |
| Choose the data direction to view You can choose to view inbound (received) operations or outbound (sent) operations: |  | |
| View details Hover your cursor over any point to view operation details: |  |
| Mechanism | Summary |
|---|---|
| Connector shape | A request is made (successfully or otherwise) to receive data from a specified endpoint/query. |
| Connector shape | A request is made (successfully or otherwise) to send data to a specified endpoint/query. |
| Webhook trigger | A webhook is received (with or without a payload) in the first step of the process flow. |
| Event trigger | An event is received (with or without a payload) in the first step of the process flow. |
| Patchworks API call | A Patchworks API call is received (with or without a payload) in the first step of the process flow. |
In the simplest of flows you might receive 1 payload from a source endpoint which contains 350 records in a single, unpaginated payload. The flow goes on to send that payload to a destination endpoint. This results in 2 operations - 1 for the receive operation and 1 for the send operation. |  | tile 1a.png | |
In a slightly more complex flow you might receive 1 payload from a source endpoint which contains 350 records in a single, unpaginated payload. The flow continues with a flow control shape which batches this data into smaller chunks, resulting in 5 payloads, each containing 70 records. The flow goes on to send all of these payloads to a destination endpoint. This results in 6 operations - one for the receive operation and 5 for the send operations. |  | tile 2a.png | |
In this example, our incoming data is paginated as 50 records per page, so we receive 350 records as 7 payloads (50 records in each). The flow proceeds to send all of these payloads to a destination endpoint. This results 14 operations - 7 for receive operations and 7 for send operations. |  | tile 3a.png | |
In this example, our incoming data is paginated as 50 records per page, so we receive 350 records as 7 payloads (50 records in each). The flow continues with a flow control shape which batches this data into single-item payloads. The flow goes on to send all of these payloads to a destination endpoint. This results 357 operations - 7 for receive operations and 350 for send operations. |  | tile 4a.png |
| Manages multiple company profiles | Is managed by another company | Managing company is a powered-by profile | Is a powered-by profile | Can create & manage alerts | Receives alerts for own usage | Receives alerts for 'child' companies |
|---|---|---|---|---|---|---|
| no | no | n/a | no | yes | yes | n/a |
| no | yes | no | n/a | yes | yes | n/a |
| no | yes | yes | n/a | no | no | n/a |
| yes | n/a | n/a | no | yes | yes | no |
| yes | n/a | n/a | yes | yes | yes | yes |
| Field | Summary |
|---|---|
| Name | Enter your preferred name for this alert. |
| Alert type | Set to Operation UsageorToken Usage |
| Threshold | Enter a value between 1 and 100. This is the percentage of your operation allowance that must be used to trigger alert emails. For example, entering 50 will trigger the alert when 50% or more of your allowance has been used. |
| Notiication group | Use the dropdown list to select the required notification group. You can select one notification group per alert. |
| Mechanism | Summary |
|---|---|
| Patchworks API call | Data is received from or sent to an API call. |
| Connector shape | Data is received from or sent to a Patchworks connector. |
| Other shapes | Data is processed within any shape - for example, by a custom script (script shape or transform function), mapping payloads from one structure to another (map shape), or routing payloads down multiple branches (route shape). |
| File transfers | Data moves between systems - for example, CSV files or image files. |
| Database queries | Data is fetched from or inserted into a database. |
| Triggers | Data is sent/received via an event, webhook or Patchworks API call. |
| (1) Identify interactions Every time a shape in your process flow performs a manipulation, moves data or sends/receives data between systems, an interaction occurs. This could be an API call, a file upload, or any other data transfer/manipulation. | fluent--location-target-square-32-regular.svg | ||
| (2) Measure payload sizes For each interaction, the size of the payload out is measured in megabytes. | Only the actual payload is considered - metadata, headers, and other non-payload data are NOT considered when calculating the payload out size. | hugeicons--tape-measure.svg | |
| (3) Aggregate payload sizes All payload sizes are aggregated to calculate the total data usage. | ic--outline-calculate.svg |
| Shape | Change size? | Notes |
|---|---|---|
| Add to cache | No | The payload out is always the same as the incoming payload. |
| Assert | No | The payload out is always the same as the incoming payload. |
| Connector | Yes | When receiving data, the payload out will reflect the volume of data received from this connection request. When sending data, the payload out will be the same as the incoming payload UNLESS you choose to |
| De-dupe | No | If set to If set to A de-dupe shape will never increase the size of the payload out. |
| Filter | Yes | If a filter removes data from an incoming payload, the payload out will be smaller than the incoming payload. A filter will never increase the size of the payload out. |
| Flow control | No | The incoming payload is batched into multiple, smaller batches but the aggregate size of the payload out for those batches is always equal to the incoming payload size. |
| Load from cache | Yes | The payload out will reflect the volume of data loaded from the cache. |
| Map | Yes | A straightforward like-for-like mapping between two systems will not affect the size of the payload out. However, if transform functions are applied the size of the payload out may change slightly - for example, prefix, suffix, format date and script transforms.Typically, any size variations from mapping transformations are small. |
| Manual payload | No | The payload out is always the same as the incoming payload. |
| Route | Yes | When an incoming payload hits a route shape, your defined conditions are checked and a payload out is created for each defined route. If your route conditions exclude items in the incoming payload from progressing down any routes then the aggregate size of payloads out will be smaller than the incoming payload. |
| Run process flow | Yes | If you configure this shape with a manual payload then the payload out is likely to differ from any incoming payload. If no manual payload is specified then the payload out is always the same as the incoming payload. |
| Script | Yes | A custom script might increase or decrease the size of the payload out. |
| Set variables | No | The payload out is always the same as the incoming payload. |
| Split | Yes | The incoming data is split at a defined data element, so only that element progresses to the next step - i.e. the payload out is likely to be smaller than the incoming payload. |
| Track data | No | The incoming payload simply passes through for tracking - the payload out will always be the same as the incoming payload. A track data shape will never increase the size of the payload out. |
 | In the simplest of flows, a connector shape receives a 1MB payload, so the first payload out is 1MB. The map shape receives this as its incoming payload. There are no field transformations so the data doesn't change - the second payload out is 1MB. The final connector shape receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to The aggregate total for the payload out size for all three shapes is 3MB. | data use tile 1.png | |
Here, a connector shape receives a 1MB payload, so the first payload out is 1MB. The de-dupe shape receives this as its incoming payload and filters out all duplicate records, reducing the payload size. The next payload out is 0.75MB. The map shape receives this as its incoming payload. There are no field transformations so the data doesn't change - the next payload out is 0.75MB. The flow control shape receives this as its incoming payload and batches it into 10 payloads for onward processing. The next payload out is 10 x 75K. The second connector receives all 10 payloads to be sent into the associated system. We have NOT set the save response as payload option to The aggregate total for the payload out size for all shapes is 4.75MB. | data use tile 3.png | ||
Here, a connector shape receives a 1MB payload, so the first payload out is 1MB. This payload is added to a cache, and the next payload out is 1MB. This payload is passed to a route shape with conditions that send half the payload down one route and half down the other - resulting in 2 x 0.5MB payloads out. For route 1, the first 0.5MB payload passes through a track data shape and the payload out is 0.5MB. The map shape receives this as its incoming payload and there are no field transformations so the data doesn't change - the payload out is 0.5MB. The final connector receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to For route 2, the first 0.5MB payload is received by the map shape - there are no field transformations so the data doesn't change - the payload out is 0.5MB. The final connector receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to The aggregate total for the payload out size for all shapes is 5.5MB. | data use tile 1a.png | ||
Here, a connector shape receives a 1MB payload, so the first payload out is 1MB. This payload is added to a cache, and the next payload out is 1MB. Then we load cache data from an existing company cache which is 50MB, so the next payload out is 50MB. The script shape receives this as its incoming payload and runs - it doesn't do anything that affects the payload size so the next payload out is 50MB. The map shape receives this as its incoming payload. There are no field transformations so the data doesn't change - the next payload out is 50MB. The final connector receives this as its incoming payload to be sent into the associated system. We have NOT set the save response as payload option to The aggregate total for the payload out size for all shapes is 202MB. | data use tile 2.png |
.png?alt=media&token=6738a466-f433-416a-a48d-c21b93638d1e){kind=link}
.png?alt=media&token=0d5e953d-af19-44aa-b042-383bee21e6eb){kind=link}
| Standard manager 13.svg | ||
| PRO manager 4.svg |
| Task | Allowed roles |
|---|---|
| View company profile | administrator, manager, user, read-only |
| Update company profile name | administrator |
| Update company profile contact information | administrator, manager |
| Add & manage banner messages | administrator |
| Delete company profile | administrator |
| Task | Allowed roles |
|---|---|
| View/access company admin options | administrator |
| SSO setup | administrator |
| Task | Allowed roles |
|---|---|
| View company users | administrator, manager, user, read-only |
| Search company users | administrator, manager, user, read-only |
Create company user with an administrator role | patchworks support |
Create a company user with a manager role | administrator |
Create a company user with a user or read-only role | administrator, manager |
| Update details for an existing company user (all roles) | administrator, manager |
Elevate an existing read-only account to a user role | administrator, manager |
Elevate an existing user or read-only account to a manager role | administrator |
Elevate an existing user, read-only or manager account to an administrator role | patchworks support |
Demote an existing manager account to a user or read-only role | administrator, manager |
Demote another administrator account to a manager, user or read-only role | patchworks support |
| Trigger password reset password for a company user | administrator, manager |
| Update own user details | administrator, manager |
| Elevate or reduce own role | none |
| Enable/disable own MFA | administrator, manager, user, read-only |
| Delete company user | administrator, manager |
| Restore company user | administrator, manager |
| Delete own user profile | administrator, manager |
| Task | Allowed roles |
|---|---|
| View company insights | administrator, manager, user, read-only |
| Task | Allowed roles |
|---|---|
| Linked companies | |
| Adding & linking a new company to your multi-company profile | patchworks support, administrator |
| Switch in & out of linked companies | administrator, manager |
| Update subscriptions for linked companies | patchworks support, administrator |
| View linked companies for your multi-company profile | administrator, manager |
| Un-linking a company from your multi-company profile | patchworks support |
| Team members | |
| View team members for own company | administrator, manager, user, read-only |
| Create new team member to manage a linked company | administrator |
| Assign user roles for an existing team member | administrator, manager |
| View team members who manage a linked company | administrator, manager |
| Grant & revoke access for team members to manage a linked company | administrator, manager |
| Trigger a password reset for an existing team member | administrator, manager |
| Removing a team member account | administrator, manager |
| 'Native' company users | |
| View 'native' users for a linked company | administrator, manager |
| Create a new 'native' user for a linked company | administrator, manager |
| Assign user roles for an existing 'native' company user | administrator, manager |
| Trigger a password reset for an existing 'native' company user | administrator, manager |
| Remove a 'native' linked company user from their company profile | administrator, manager |
| Task | Allowed roles |
|---|---|
| Install marketplace blueprints | administrator, manager |
| Build blueprints | administrator |
| Browse & view marketplace connectors | administrator, manager, user, read-only |
| Install marketplace connectors | administrator, manager |
| Update marketplace connectors | administrator, manager |
| Browse & view marketplace process flows | administrator, manager, user, read-only |
| Install marketplace process flows | administrator, manager |
| Browse marketplace scripts | administrator, manager, user, read-only |
| Preview script from scripts list | administrator, manager, user, read-only |
| Install marketplace scripts | administrator, manager |
| Task | Allowed roles |
|---|---|
| View private marketplace | administrator, manager, user, read-only |
| Install resources (blueprints, connectors, process flows, scripts, cross-reference lookups) | administrator, manager |
| Upload resources (blueprints, connectors, process flows, scripts, cross-reference lookups) | administrator |
| Task | Allowed roles |
|---|---|
| View private blueprints | administrator, manager, user, read-only |
| Build a private blueprint | administrator, manager |
| Update a private blueprint | administrator, manager |
| Bulk update blueprint installations | administrator, manager |
| Manually accept a blueprint update | administrator, manager |
| Delete a blueprint | administrator, manager |
| Task | Allowed roles |
|---|---|
| Browse installed connectors | administrator, manager, user, read-only |
| View installed connector settings | administrator, manager |
| Update installed connector settings | administrator, manager |
| Delete installed connectors | administrator, manager |
| Task | Allowed roles |
|---|---|
| View connector instances | administrator, manager, user, read-only |
| View connector instance settings | administrator, manager, user, read-only |
| Update connector instance settings | administrator, manager |
| Delete connector instances | administrator, manager |
| Task | Allowed roles |
|---|---|
| View process flow list | administrator, manager, user, read-only |
| View canvas content for existing process flows | administrator, manager, user, read-only |
| Create process flows (add/update/remove shapes) | administrator, manager |
| Update process flows (add/update/remove shapes) | administrator, manager |
| Create cache (cache shape settings) | administrator, manager |
| Create data pool (de-dupe shape settings) | administrator, manager |
| Delete process flows | administrator, manager |
| Run process flow manually | administrator, manager |
| Enable & deploy process flows (process flow settings) | administrator, manager |
| Apply/remove labels (process flow settings) | administrator, manager |
| Create labels (process flow settings) | administrator, manager |
| Apply/remove email failure groups (process flow settings) | administrator, manager |
| Add flow variables (process flow settings) | administrator, manager |
| Update flow variables (process flow settings) | administrator, manager |
| Remove flow variables (process flow settings) | administrator, manager |
| Duplicate process flow (process flow settings) | administrator, manager |
| Task | Allowed roles |
|---|---|
| View virtual environments | administrator, manager, user, read-only |
| Create virtual environments | administrator, manager |
| Configure virtual environments | administrator, manager |
| Manage virtual environments | administrator, manager |
| View virtual environment packages | administrator, manager |
| Configure virtual environment packages | administrator, manager |
| Manage virtual environment packages | administrator, manager |
| Task | Allowed roles |
|---|---|
| View run logs list | administrator, manager, user, read-only |
| View run logs | administrator, manager, user, read-only |
| View run logs (classic) | administrator, manager, user, read-only |
| View run log details | administrator, manager, user, read-only |
| Download run logs | administrator, manager |
| View run log payloads | administrator, manager, user, read-only |
| Download run log payloads | administrator, manager |
| Stop process flow | administrator, manager |
| Task | Allowed roles |
|---|---|
| Manage own account settings | administrator, manager |
| View notification groups | administrator, manager, user, read-only |
| Add & manage notification groups | administrator, manager |
| View audit logs | administrator, manager, user, read-only |
| Search audit logs | administrator, manager, user, read-only |
| View labels | administrator, manager |
| Add & manage labels | administrator, manager |
| View data pools | administrator, manager, user, read-only |
| Add & manage data pools | administrator, manager |
| View usage alerts | administrator, manager, user, read-only |
| Add & manage usage alerts | administrator, manager |
| Task | Allowed roles |
|---|---|
| View custom scripts list | administrator, manager, user, read-only |
| View custom script details | administrator, manager, user, read-only |
| Create custom scripts | administrator, manager |
| Update custom scripts | administrator, manager |
| Delete custom scripts | administrator, manager |
| Task | Allowed roles |
|---|---|
| View installed cross-reference lookups | administrator, manager, user, read-only |
| Search installed cross-reference lookups | administrator, manager, user, read-only |
| View cross-reference lookup values | administrator, manager |
| Add & manage cross-reference values | administrator, manager |
| Delete cross-reference lookups | administrator, manager |
| Task | Allowed roles |
|---|---|
| View existing cache lists | administrator, manager, user, read-only |
| Search existing caches | administrator, manager, user, read-only |
| View existing cache details | administrator, manager, user, read-only |
| Update existing cache details | administrator, manager |
| View existing cache contents | administrator, manager, user, read-only |
| Clear existing cache contents | administrator, manager |
| Delete caches | administrator, manager |
| Task | Allowed roles |
|---|---|
| API access | administrator, manager, user, read-only |
| Generate & manage API keys | administrator, manager |
| Your role | Allowed role changes |
|---|---|
| Administrator |
|
| Manager |
|
| Your role | Allowed role changes |
|---|---|
| Administrator |
|
| Manager |
|
Alternative approach
The company user can use the 'forgot password' option from the [Patchworks login page](https://app.wearepatchworks.com/login) to trigger their own password reset email:\
\
* Your multi-company profile is [associated with linked companies](/product-documentation/company-management/multi-company-profiles/adding-and-linking-a-new-company).\ \ AND
* Your user account has a [manager or administrator role](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/assigning-user-roles-for-an-existing-team-member).\ \ AND
* You have been [granted permission to manage the linked company](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/granting-and-revoking-permission-for-an-existing-team-member-to-manage-a-linked-company) in question. ## What next? If you meet this criteria then you can [switch into a company that you manage](/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company) and: * [Work with company users](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-native-company-users) * [Work with your team members](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members) {% hint style="info" %} For information about managing company profiles for your linked companies, please see our [Linked company profiles](/product-documentation/company-management/multi-company-profiles) section. {% endhint %} ## Related information * [Managing linked company profiles](/product-documentation/company-management/multi-company-profiles) * [Duplicating a process flow between company profiles](/product-documentation/process-flows/managing-process-flows/duplicating-a-process-flow/duplicating-a-process-flow-between-linked-companies) # Working with your team members ## Introduction If your Patchworks user account is associated with a multi-company profile and you have been [granted permission to manage a linked company](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/granting-and-revoking-permission-for-an-existing-team-member-to-manage-a-linked-company), you are a **team member with access**. As such you can perform the following tasks for other team members (i.e. other users associated with your agency/partner profile): * [View team members for your own multi-company profile](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/viewing-team-members-for-your-own-multi-company-profile) * [Create a new team member to manage linked companies](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/creating-a-new-team-member-to-manage-linked-companies) * [Assign user roles for an existing team member](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/assigning-user-roles-for-an-existing-team-member) * [View team members who manage a particular linked company](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/viewing-team-members-who-manage-a-linked-company) * [Grant & revoke permission for a team member to manage a linked company](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/granting-and-revoking-permission-for-an-existing-team-member-to-manage-a-linked-company) * [Trigger a password reset for an existing team member](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/triggering-a-password-reset-for-an-existing-team-member) * [Remove a team member from your multi-company profile](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/removing-a-team-member-account-from-your-multi-company-profile) # Viewing team members for your own multi-company profile ## Introduction If you are a multi-company profile user with [permission to manage another linked company](/product-documentation/users-roles-and-permissions/managing-team-members-and-users-for-multi-company-profiles/working-with-your-team-members/granting-and-revoking-permission-for-an-existing-team-member-to-manage-a-linked-company), you can view and manage users associated with your own company profile. ## The steps **Step 1**\ Log into the Patchworks dashboard using your own Patchworks credentials and ensure that you are [switched into your own company profile](/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company). **Step 2**\ In the top, left-hand corner click the arrow associated with your company name - then select your profile:
| Your role | Allowed role changes |
|---|---|
| Administrator |
|
| Manager |
|
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
I want to grant access
If you want to grant management access for a user, click the **add company** button:
I want to revoke access
If you want to revoke existing access for a user, click the **delete** icon and then confirm this action:
Alternative approach
Your team member can use the 'forgot password' option from the [Patchworks login page](https://app.wearepatchworks.com/login) to trigger their own password reset email:\
\
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
Have you switched correctly?
Always double-check the company name after a switch to ensure that the switch was made correctly:
| Your role | Allowed role changes |
|---|---|
| Administrator |
|
| Manager |
|
| Your role | Allowed role changes |
|---|---|
| Administrator |
|
| Manager |
|
Alternative approach
The company user can use the 'forgot password' option from the [Patchworks login page](https://app.wearepatchworks.com/login) to trigger their own password reset email:\
\
| Icon | Shows |
|---|---|
 | The number of included connectors. |
 | The number of included process flows. |
 | The number of included cross-reference lookup tables. |
 | The number of included custom scripts. |
| Requirement | Summary |
|---|---|
| Compliance | The blueprint must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights. |
| Functionality | The blueprint must provide clear and useful functionality that adds value for users. It should be well-designed, intuitive to use, and free from significant bugs or issues. |
| Quality | The blueprint must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the Patchworks platform. |
| Security | The blueprint must implement appropriate security measures to protect user data and prevent unauthorised access or misuse. It should follow best practices for secure coding and data handling. |
| Marketplace compatibility | The blueprint should be compatible with the Patchworks platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies. |
| Connector compatibility | The blueprint should use existing connectors found in the Patchworks marketplace. Any modifications to existing connectors in order to support the blueprint must be submitted separately prior to the blueprint review process. |
| Documentation | You should provide clear and comprehensive documentation for your blueprint, including installation instructions, usage guidelines, and troubleshooting tips if any are required. Documentation can be provided as http links in multiple sections of the connector builder. Alternatively documentation can be submitted along with your blueprint. We will host this documentation on our public documentation platform. |
| Item | Summary |
|---|---|
| Developer name | The name and email address of your company or developer. |
| Patchworks company profile | The Patchworks dashboard company profile name under which you will create the new blueprint(s). |
| Blueprint name | The name of the blueprint to be displayed in the Patchworks marketplace. |
| Expected completion date | If known, provide the expected completion date for development. |
| Connectors | Specify the name of any connectors to be included in the new blueprint(s). If these connectors do not exist or require modifications, you must provide details about the required modifications. |
| Process flows | Provide information about any process flows that you intend to build utilising the specified connectors. This information should include the purpose of the process flow and any custom scripts that will be built. |
| Responsibility | Summary |
|---|---|
| Updates & maintenance | You should regularly update and maintain you blueprint(s) to ensure it remains compatible with the Patchworks platform and any relevant changes or updates. |
| Support | You must provide adequate support to users, including addressing enquiries, issues, and bug reports in a timely manner. |
| Compliance | You should continue to comply with all relevant laws, regulations, and policies, and promptly address any compliance issues that arise. |
| Requirement | Summary |
|---|---|
| Compliance | The connector must comply with all relevant laws, regulations, and policies, including those related to data privacy, security, and intellectual property rights. |
| Functionality | The connector must provide clear and useful functionality that adds value for users. It should be well-designed, intuitive to use, and free from significant bugs or issues. |
| Quality | The connector must meet quality standards for performance, reliability, and user experience. It should not degrade the performance or stability of the [Public Marketplace] platform. |
| Security | The connector must implement appropriate security measures to protect user data and prevent unauthorised access or misuse. It should follow best practices for secure coding and data handling. |
| Marketplace compatibility | The connector should be compatible with the [Public Marketplace] platform and any relevant operating systems or devices. It should not rely on unsupported features or dependencies. |
| Documentation (recommended) | Developers should provide clear and comprehensive documentation for their connector, including installation instructions, usage guidelines, and troubleshooting tips if any are required. |
| Item | Summary |
|---|---|
| Developer name | The name and email address of your company or developer. |
| Patchworks company profile | The Patchworks dashboard company profile name under which you will create the new connector(s). |
| Connector name | The name of the connector to be displayed in the [Public Marketplace]. |
| Expected completion date | If known, provide the expected completion date for development. |
| Responsibility | Summary |
|---|---|
| Updates & maintenance | You should regularly update and maintain you connector(s) to ensure it remains compatible with the [Public Marketplace] platform and any relevant changes or updates. |
| Support | You must provide adequate support to users, including addressing enquiries, issues, and bug reports in a timely manner. |
| Compliance | You should continue to comply with all relevant laws, regulations, and policies, and promptly address any compliance issues that arise. |
All connectors used in the process flow are installed without instances.
If you install an process flow which 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.
| | [Custom scripts](/product-documentation/developer-hub/custom-scripting) | All scripts defined in [script shapes](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/script-shape) are installed and deployed, ready for use. | | [Cross-reference lookups](/product-documentation/process-flows/cross-reference-lookups) | All cross-reference lookups defined as [map shape field transformations](/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/map-shape) are installed and ready for use. | | [De-dupe data pools](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/de-dupe-shape#data-pools) | Any data pools defined in [de-dupe shapes](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/de-dupe-shape) are added. These are 'clean' data pools (i.e. with no associated data), ready for use. | | [Caches and cache keys](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/cache) | Any caches and cache keys defined in [add to cache shapes](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/cache/add-to-cache-shape) are added. These are 'clean' caches (i.e. with no associated data), ready for use. | ## Browsing process flows Having selected the **process flows** option from the marketplace, you can browse and [install](/product-documentation/process-flows/prebuilt-process-flows/installing-a-prebuilt-process-flow) prebuilt process flows. Process flows are displayed as tiles over a series of pages, which you can step through using page numbers at the bottom of the marketplace. Each process flow includes a visual summary of its component parts:
| The number of [connectors](/product-documentation/connectors-and-instances/connectors-and-instances-introduction) included in this process flow - i.e. connectors to be installed if you choose to install this process flow. |
| 
| The number of [custom scripts](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/script-shape) included in this process flow - i.e. scripts to be installed if you choose to install this process flow. |
| 
| The number of steps in the process flow - i.e. the number of [shapes](/product-documentation/process-flows/building-process-flows/process-flow-shapes) after the initial [trigger](/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/trigger-shape). |
| 
| The number of [cross-reference lookup tables](/product-documentation/process-flows/cross-reference-lookups) included in this process flow - i.e. cross-reference lookups to be installed if you choose to install this process flow. |
| 
| Indicates whether or not the process flow includes advanced shapes. Advanced shapes are: [script](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/script-shape), [add to cache](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/cache/add-to-cache-shape), [load from cache](/product-documentation/process-flows/building-process-flows/process-flow-shapes/advanced-shapes/cache/load-from-cache-shape). Read and write access to advanced shapes is determined by your [Patchworks subscription](/product-documentation/getting-started/subscription-tier-limits). |
## Viewing a process flow
To see a read-only view of a process flow before it's installed, click the **view** button:
| Resource uploaded to... | Resource available in... |
|---|---|
| Parent marketplace | parent company private marketplace, child company private marketplaces |
| Child marketplace | own child company private marketplace, parent company private marketplace, sibling-child company private marketplaces |
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.
