Packages

A package is a deployable version of a solution. It includes the assets in the solution, except draft assets. After a package is created, it can be deployed to a target environment. The Packages page lets you manage and install solution packages. It displays packages created from solutions across your environments, organized by source environment and version. Only Solution owners in the source environment can view the package in the package list.

Application lifecycle management (ALM) is the practice of managing software through distinct stages, typically development, testing, and production. ALM ensures changes are validated before reaching end users, reducing risk of breakage and ensuring stability for users. Nintex supports deploying solutions across environments through solutions packages. Packages are typically created in a development environment, installed in a test environment for validation, and finally installed in production after appropriate testing. For more information, see Environments.

Concepts

Package versioning

Solution packages use manual semantic versioning with three components: major.minor.patch (for example, 2.1.3). When you create a package, choose the version number that best describes the change:

• Major: Significant changes that may break existing functionality or require manual changes to existing workflows (1.0.0 > 2.0.0)

• Minor: New features or enhancements that don’t break existing functionality (1.0.0 > 1.1.0)

• Patch: Bug fixes and minor corrections that don’t change functionality (1.0.0 > 1.0.1)

The version number helps users understand what to expect when they install the package.

When to create a package

Create a package when you're ready to move solution assets from one environment to another. Common scenarios include:

• Deploying tested changes from source to destination environment

• Creating a restore point before making significant changes

  Important:  Draft versions of assets are not included in packages. Publish any draft assets before creating a package to ensure they’re included.

• Promoting approved features after stakeholder review

Packages can be used to establish a clear version history. Each package represents a deployable unit, which means you can roll back to previous versions if issues arise.

View packages

• Go to Solutions > Packages.

The Packages page displays all packages created for solutions. Packages are organized by source environment and version.
The source environment determines which Solution owners can view the package. Only Solution owners defined in the source environment can view the package in the package list.

Create a package

Important:  Draft versions of assets are not included in packages. Publish any draft assets before creating a package to ensure they’re included.

To create a package:

1. Go to the Solution you want to package. For more information, see Solutions

2. Click Create a package.

3. Enter the Version Number using the semantic versioning format (major.minor.patch). For more information, see Package versioning.

4. In the Description field, document what changed in this version.

   Tip: Include key changes, affected assets, and any configuration requirements. Good descriptions help team members understand what each version contains and whether reconfiguration is needed after deployment.

5. Review the package contents listed under Package contents. Ensure all expected assets appear in the list.

6. Click Next.

The solution assets are bundled into a package. When packaging completes, the Package created dialog appears with suggested next steps. You can install the package immediately by clicking Go to target environment, or click Close to return to the solution detail page.

Install a package

To install a package:

1. Go to Solutions > Packages to access the Packages repository.

2. Beside the desired package, click Deploy.

3. Select a target environment to install the package.

4. Review the confirmation dialog.

   Important: All assets in the solution within the current environment will be overwritten during installation. Ensure you have no unsaved changes or important work that will be lost. If you have critical changes, consider creating a separate package from the current environment before proceeding.

5. Click Install.

The package installs in the target environment. When installation completes, the Deployment complete dialog appears with suggested next steps. You can configure the installed solution assets immediately by clicking Configure settings, or click Close to return to the Packages repository.

Update configuration settings

After installing a package in a new environment, you may need to manually update environment-specific configuration values in the solution assets.

Values relevant to the previous environment such as test users, example data, testing URLs, or development connections must be updated to match the current environment for the solution to work as expected.

Some common values that may need updating include:

• Workflow Form start events: Form URLs and deployment locations may differ between test and production.

• Third-party start events: Webhook URLs, connection credentials, and other related values that may tie to testing/staging environments may need to be updated for production.

• Connector actions: Third-party service connections may require switching from testing endpoints to production endpoints or different credentials.

• Communication actions: Actions that communicate with users may require adjusting values like email recipient addresses, task assignment users, etc.

• Test data: Any hardcoded values used for testing (example text, sample IDs, placeholder URLs) should be updated to reflect the current environment.

Configure connections after deployment

After you deploy a package, some assets might require configuration in the target environment before they can be used. For example, a workflow or app in the package might use a connection that does not exist in the target environment.

If configuration is required, the asset shows a warning icon on the solution details page. Workflows or Apps that require configuration remain in Draft status until the required settings are configured and it is published.

To configure assets after deployment:

1. Open the solution details page using one of these options:

   • In the Deployment complete dialog, select Configure settings.

   • Go to Solutions > All solutions, and then open the solution that contains the asset

2. Configure the required settings for the asset.

Configure workflow settings

1. Find the workflow that requires configuration. The workflow appears in a draft state until the required connection is configured.

2. Click the next to the workflow.

3. Select Configure workflow.

4. In the Configure workflow panel, expand the section you want to update. Configure the required settings, such as start event settings, component workflows etc.

5. Select the assigned use, such as Production or Development.

6. Click Publish.

Configure app settings

1. Find the app that requires configuration. The app shows a warning icon until the required configuration is complete.

2. Open the app and configure the required connection.

   Important: Connection variables are deployed with the connection, but variable values are not deployed. Add the required variable values in each target environment after deployment.

3. If the connection uses variables, open the connection and go to the Variables tab.

4. Add or update the required variable values for the target environment.

5. Click Save.

Packages columns, settings, and selections

Section	Column	Description
(unlabeled)	Solution Name	The name of the solution associated with the package.
	Latest package	The package version number (for example, v1.0.1) : Displays all deployed package versions and the environments where they are deployed.
	Total assets in package	Number of assets included in the latest package. Assets can include Workflows, Tables, Apps and Documents.
	Total package versions	Total number of package versions created for the solution.
	Deploy	Deploys the selected package. Click to open a list of available environments, then select an environment to deploy the latest package version.
Options ()	Package contents	The assets included in the selected package.
	View all package versions	Displays all available versions of the package.
	View deployment history	Displays the deployment history for the package, including previous deployments, deployment logs and their status.
	Delete	Deletes the selected package from the solution.