Managing Application Deployment Profiles
A deployment profile is a configuration blueprint for one environment. It holds the variables, workflows, logging behavior, and access rules an application uses when it runs there, so the same application deploys consistently to development and production without reconfiguring it each time.
Before you begin
- You need the create deployment profile permission. Setting a profile as the default for its environment requires a separate permission.
- Profiles are only available in private workspaces. In a public workspace the Profiles button is disabled, with the tooltip
Profiles are not supported for public workspaces. - Deploy the application at least once. Profiles load their variables and workflows from the latest deployment, so profile creation is blocked until one exists.
Create a profile
- Open the application in a private workspace.
- Select Profiles in the application toolbar at the top of the page. The Profiles panel opens.
- Select Create a new Profile.
- Enter a Profile Name, such as
DevorProd. - Select the Environment the profile applies to, such as Development.
- Optionally, enter a Description.
- Optionally, set the profile as the Default for its environment.
- Select Create profile.
Variables and workflows load automatically from the latest deployment.
How you know it worked
The profile appears in the Profiles panel under its name. Use Search Profiles to find it once the list grows.
When it does not work
| Message | Cause | What to do |
|---|---|---|
| Profile name is required. | The Profile Name field is empty. | Enter a name. |
| Profile name should not contain special characters | The name contains characters that are not allowed. | Use letters, numbers, and spaces. |
| Profile with that name already exists. | Another profile in the application uses this name. | Choose a different name. |
| You don't have permission for this action | You lack the create-profile permission. | Ask your workspace administrator. |
| Profiles is disabled | The workspace is public, or no application is open. | Open an application in a private workspace. |
Configure variables
Go to the Variables tab and select Add Variable. Each variable takes:
| Field | Notes |
|---|---|
| Name | The variable's name. |
| Scope | Application, Deployment, or Client. |
| Value | Editable for Deployment and Client scopes only. |
| Description | Optional. |
Secret variables are masked and stored in a vault rather than in plain text. Select Choose vaults for each environment to assign client-managed vaults per environment. If none is assigned, the secret is handled by a platform-managed vault.
Configure logging
Enable Logs to record all activities. With it off, logging is configurable per application and per workflow.
- Application-level — set behavior per activity type: Always Logged, Log Input, or Log Output.
- Per workflow — select Add Workflows, then configure logging on individual activities.
Configure access
On the Members and Teams tabs, add the people and teams who can use the profile.
- The profile creator gets view, edit, and delete permissions by default.
- Editors can add members and teams and set their Role.
- Use Transfer Ownership To to hand the profile to another member.
Sync with the latest deployment
Anyone with edit permission can select Sync With Latest Deployment to pull updated variables and workflows from the most recent deployment version.
Use a profile when testing
Add the X-Profile-Name header when testing a RESTService-triggered workflow, so the test runs against that profile's configuration.
Profile selection is no longer available in the deployment modal. Every execution specifies its profile at runtime through the header.
Important considerations
- Only RESTService-triggered workflows support deployment profiles.
- Subflows executed as part of the workflow inherit the profile context.
Next steps
Test the workflow against the profile. See Test a Workflow or API.