Install or upgrade

This topic covers how to install or upgrade Nintex DocGen. Ensure that you have purchased Nintex DocGen before performing these steps, then find the installation or upgrade below that you want to perform. Government cloud organizations are required to Install or upgrade from within Salesforce Lightning.

Caution: Before upgrading Nintex DocGen on a production org, you must upgrade on a sandbox org and complete thorough testing.

Supported Salesforce Editions

Nintex DocGen supports the following editions of Salesforce:

  • Professional

  • Enterprise

  • Unlimited

  • Force.com

  • Developer

Before installing Nintex DocGen ensure that you are using a supported edition of Salesforce.

Install or upgrade from within Salesforce Lightning

All customers within their Salesforce Lightning org can perform these steps to install or upgrade Nintex DocGen.

Government cloud organizations are required to use these steps to install or upgrade Nintex DocGen.

  1. In Salesforce Lightning, click > View All > Visit AppExchange. The AppExchange Home screen appears.
  2. Type Nintex DocGen in the Search AppExchange field and select Enter.
  3. Select and download the Nintex DocGen app. (Salesforce may prompt you to log into your account. Use the credentials for the Salesforce org where you intend to install the package, and allow access when prompted.)
  1. Do one of the following:
    • Install: Choose a production or sandbox org for your installation.
    • Upgrade: Choose a sandbox org and complete thorough testing before upgrading a production org
  1. Agree to the terms and conditions and confirm your installation.
  2. Select Install for All Users and click Install or Upgrade. Nintex recommends the Install for All Users option. During an upgrade, this option enables read/edit permissions to any new objects and fields that are included in the upgrade. See Install options.
  3. A message that says that the app is taking a long time to install may appear. If this happens, you will receive an email notification after the install. After you receive the email, click Done.

In some scenarios, such as a first-time installation, you may need to approve third-party access upon first installation or when prompted:

  1. In Approve Third-Party Access, select Yes, grant access to these third-party web sites.
  1. Click Continue.

Additional install or upgrade options

Below are additional install or upgrade options.

Install or upgrade from the Salesforce AppExchange

If you're unable to install or upgrade Nintex DocGen in Salesforce Lightning, or if you're using Salesforce Classic, you can download the app directly from the Salesforce AppExchange.

You must have the user permissions to download AppExchange packages before performing the following steps. For more information, see Installing Packages in Salesforce Application Installation Guide.

Important: For users encountering exception errors when trying to install from the AppExchange, it may be done to Skip triggers not enabled in Salesforce settings. For more information how to enable Skip triggers refer to the following Salesforce help article: Enable Salesforce Files Settings For Managed Packages.

  1. Visit Nintex DocGen in the Salesforce AppExchange, and click Get It Now. Salesforce may prompt you to log into your account. Use the credentials for the Salesforce org that you intend to install the package in.
  1. Do one of the following:
    • Install: Choose a production or sandbox org for your installation.
    • Upgrade: Choose a sandbox org and complete thorough testing before upgrading a production org.
  1. Agree to the terms and conditions and confirm your installation. You may be prompted to log in to Salesforce again.
  2. Select Install for All Users and click Install or Upgrade. Nintex recommends the Install for All Users option. During an upgrade, this option enables read/edit permissions to any new objects and fields that are included in the upgrade. See Install options.

In some scenarios, such as a first-time installation, you may need to approve third-party access upon first installation or when prompted:

  1. In Approve Third-Party Access, select Yes, grant access to these third-party web sites.
  1. Click Continue.

Install or upgrade from Nintex Customer Central

You can also install or upgrade the latest or previous Nintex DocGen builds from Nintex Customer Central.

  1. Access and log into Nintex Customer Central.

  2. Click Product Releases.

  3. Select Salesforce from the drop-down.

  4. Find the product build that you want to download, and click the corresponding option in the Download/Access column. A browser window opens with the Salesforce log-in screen.

  5. (Optional) To install or upgrade in a Sandbox org from Nintex Customer Central:

    1. In your browser URL, replace the login text by typing test in its place, and press Enter.

      Example: https://test.salesforce.com/...

  6. Use the credentials for the Salesforce org that you intend to install the package in.

  7. Complete the install/upgrade options.

Install options

During a Nintex DocGen installation or upgrade, you'll notice 3 install options that allow you to determine who will receive the install or upgrade. Although Nintex recommends selecting the Install for All Users option, there may be use cases where you would need to select one of the 2 install options below:

Install options Use case examples Instructions Notes
Install for Admins Only*

The Install for Admins Only option can be used in situations where the admin wants to perform testing of the latest Nintex DocGen version. Once testing is complete, the admin can choose to implement the latest version to other profiles.

Select the Install for Admins Only option and click Install.

 

  • *The Install for Admins Only option is NOT recommended for an upgrade. Existing users may experience errors until their profiles have been updated to include read permissions to any new objects or fields.

  • For install, the Install for Admins Only option is recommended only if you can't use other 2 options. To enable access for non-administrative users in your organization, you will have to deploy custom objects for the app.
Install for Specific Profiles The Install for Specific Profiles option can be used to restrict access to the objects and fields in Nintex DocGen.

Under Select Specific Profiles, you can set all profile access levels at once by setting the Set access level for all profiles to drop-down list to one of the following options:

  • No Access
  • Full Access
  • Drawloop User - For profiles that only need to generate documents
  • Drawloop Admin

Once an option is selected, click Set.

The 4 options above can also be set for each profile.

Once the access levels are selected for each profile, click Upgrade.

  • The No Access, Full Access, Drawloop User, and Drawloop Admin options are security settings that determine access to the custom objects and components installed in the package. It doesn't affect permissions for existing objects.
  • To provide access to additional profiles at a later time, you need to edit field-level security and assign permissions. See User permissions.

After installing or upgrading Nintex DocGen

After the Nintex DocGen installation or upgrade is complete, you can perform the following. (The steps below are optional.)

Confirm the installation or upgrade

To confirm that your installation or upgrade was successful, perform one of the following options:

Confirm in Salesforce Lightning

  1. In the Salesforce Setup pane, go to Platform Tools.
  2. Expand Apps > Packaging.
  3. Click Installed Packages and verify that Nintex DocGen is listed.

Confirm in Salesforce Classic

  1. In the Salesforce Setup pane, go to Build.
  2. Click Installed Packages and verify that Nintex DocGen is listed.

Configure Nintex DocGen for Salesforce using the DocGen Setup Wizard

From the Nintex Admin tab in Salesforce, click on the DocGen Setup Wizard to perform the following:

  • Set up user permissions and licensing.

  • Authorize Nintex DocGen for Salesforce.

  • Copy a sample DocGen Package into your Salesforce org to help you get started generating customized documents.

  • Add buttons to enabled Classic Experience layouts.

  • Configure your Nintex eSign integration.