Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Installing X-Author for Excel

Installing and using X-Author for Excel requires you to install specific managed packages (for Salesforce) or solutions (for Microsoft Dynamics) in your environment (example: Salesforce, Microsoft Dynamics) and X-Author for Excel Add-in on your computer. Depending on your environment, refer to the specific sections below:

Tip:

The Conga Push Upgrade is an automated tool that upgrades packages available in your Salesforce org (Production or Sandbox) to the latest versions. In addition, it ensures all the Conga published managed packages are on the latest versions for the registered orgs. To register your org for push upgrade, see Registering for Conga Push Upgrade.

Installing X-Author for Excel in Salesforce

The following table summarizes the components required to install and begin working with X-Author for Excel. Refer to the most recent X-Author for Excel Release Notes for the current versions.

Component

Type

Notes

Conga X-Author for Excel (Apttus_XApps / Runtime).

Salesforce Managed Package

This package must be installed first.

Conga X-Author Designer for Excel (Apttus_XAppsDS / Designer).

Salesforce Managed Package

The following packages are optional and may be required in addition to the above components based on your license or licenses.

Conga X-Author for Excel (Admin)

Salesforce Managed Package

Required for Power Admin licenses or the legacy Data Migration product.

Conga Document Generation

Salesforce Managed Package

Required for X-Author Presto licenses. This package must be installed first.

Conga X-Author for Excel Document Generation

Salesforce Managed Package

Required for X-Author Presto licenses.

Salesforce Package Licenses

The following table describes the minimum Salesforce package licenses required for specific X-Author roles. For detailed information on required X-Author licenses and permissions, refer to Getting Started with X-Author for Excel.

Role

Salesforce Package License

Runtime User

X-Author for Excel

Designer

X-Author for Excel, X-Author Designer for Excel

Power Admin

X-Author for Excel, X-Author Designer for Excel, X-Author for Excel (Power Admin)

Presto User

X-Author for Excel, Document Generation, X-Author for Excel Document Generation

To enable licenses in Salesforce

After you install the X-Author for Excel Salesforce packages, you must send your Org ID to Conga. By default, when X-Author for Excel is installed, the lowest level of license is provisioned. After Conga has upgraded functionality in your environments, take the following steps to enable X-Author functionality according to your license:

  1. Log in to Salesforce.
  2. Click on the Conga X-Author for Excel tab.
  3. Click Refresh License.


    All users connecting to X-Author for Excel are now able to use licensed product features.

Installing X-Author for Excel in Microsoft Dynamics

X-Author for Excel is comprised of both Microsoft Dynamics managed solutions and an Excel add-in for each user.

Note:

Designers will see both the X-Author Designer and X-Author for Excel tabs in the Excel menu. End users should install the runtime-only add-in and they will see only the X-Author for Excel tab.

Microsoft Dynamics Managed Solutions

The following Microsoft Dynamics managed solution must be installed:

Component

Type

Notes

XAuthorForExcelSolution_0_1

Microsoft Managed Solution

This solution must be installed first.

Note:

User must have System Administrator Role.

Installing X-Author for Excel in Apttus Omni

You must have an Apttus Omni hosted tenant and the Excel add-in for each user.

Note:

Designers will see both the X-Author Designer and X-Author for Excel tabs in the Excel menu. End users should install the runtime-only add-in and they will see only the X-Author for Excel tab.

Installing the X-Author for Excel Add-in

The installation process creates a folder on your computer that contains the files required to use both the X-Author Designer and the X-Author for Excel tabs in Excel. Depending on the version of Windows you are using, the folder is created either in your Program Files or Program Files (x86) directory.

  • For Designers, install the X-Author for Excel Add In : Designer + Runtime Microsoft Excel.
  • For Runtime Users, install the X-Author for Excel Add In : Runtime Only version.
Note:

Refer to the most recent X-Author for Excel Release Notes for the correct version of the add-in to install.

Installation Requirements

Your computer must meet the minimum requirements listed below.

Note:

The Mac OS X operating system is not supported; however, X-Author can be used on a Mac that is running a Windows Virtual Machine in a VMWare or Parallels environment.

Component

Requirement

Microsoft

Microsoft Excel 2010 (32 bit & 64 bit), Microsoft Excel 2013 (32 bit & 64 bit), Microsoft Excel 2016 (32 bit & 64 bit)

Microsoft

Microsoft .NET Framework 4.5

Microsoft

Microsoft Visual Studio 2010 Tools for Office Runtime

Microsoft

Microsoft Office 2010 Primary Interop Assemblies

Environment

Any environment (example: Salesforce, Microsoft Dynamics) edition that provides API support for the objects that will be accessed in an X-Author for Excel App.

Before you install the X-Author add-in:

  • You must be connected to the Internet.
  • You must have access to the add-in executable file.
  • You must have Administrator permissions on the computer being used for the installation.
  • You must close all instances of Microsoft Excel.
  • You must have Conga provided login credentials to access the Conga Community Portal and download packages.

Downloading the X-Author Add-in: Designer + Runtime

  1. Log in to Salesforce.
  2. Click on the Conga X-Author for Excel tab.
  3. Click Download X-Author™ For Excel . This navigates you to the Conga community portal and enter your login credentials.
  4. Go to Resources > Install Center on the community portal.
  5. Under My Packages, select Conga X-Author for Excel.
  6. In the Conga X-Author™ Enterprise Add-In: Designer + Runtime section, select the required version and clickDownload > Confirm Download.
    The executable installer is downloaded to your system.

To Install the X-Author Add-in: Designer + Runtime

  1. Double-click the installer executable to display the InstallShield Wizard. In rare instances, a restart of Windows may be required. Click Yes to confirm the restart. After you log in to Windows, the installer automatically resumes.
  2. Click Next to start the wizard.
  3. On the License Agreement screen, select I Accept and click Next. If you do not accept the terms of the agreement, X-Author will not be installed on your computer.
  4. Click Install to begin the installation process. If any components need to be installed for X-Author to work as expected, they will be automatically detected as missing and installed. If components are required but cannot be accessed through the Internet, an appropriate message will be displayed and the installation will need to be completed after all missing components have been manually installed.
  5. Click Finish to close the wizard and complete the installation.
  6. Open Microsoft Excel.

    Designers: The X-Author Designer and X-Author for Excel ribbon tab should be available in Excel. If the ribbon tab is not displayed, you may need to register X-Author Designer or X-Author for Excel with Excel.



    Runtime Users: The X-Author for Excel ribbon tab should be available in Excel.

Showing Disabled X-Author Add-in Tabs

X-Author for Excel provides the utility Show. X-Author Tabs.exe to re-enable the X-Author add-in in Microsoft Excel after errors have disabled it. This ensures that the add-in will always be enabled when opening Excel after the utility is run. When you install X-Author for Excel, the diagnostic utility is installed in the same directory. A shortcut for Show X-Author Tabs.exe is also created on the desktop.

You must have administrator rights in the system where you want to run the diagnostic

tool.

Registering the X-Author Add-in

In rare cases, the X-Author Designer or X-Author for Excel tabs are not properly installed and, therefore, are not visible in your Microsoft Excel ribbon menu. If this occurs, you must manually register the X-Author add-in to add it to the Excel ribbon.

Registering for Conga Push Upgrade

You can register your org for Conga Upgrade Program to auto-upgrade Conga managed packages. Conga Upgrade Program supports upgrading from the Spring '18 release or later to the latest major release (n) or previous two major releases (n – 1 or n – 2).

To register your org with Conga Upgrade Program for auto-upgrade

This section provides a high-level flow of the org registration process and early feedback programs. Refer to Conga Upgrade Program documentation for a comprehensive overview of features.

  1. Launch the Conga Upgrade Program's registration page.
  2. Select your Salesforce org type (Production or Sandbox).
    The Salesforce login page is displayed.
  3. Enter your credentials and click Login.
    You are redirected to the connected app called Conga Push Upgrade CA, which prompts you to allow access to the org information.
  4. Click Allow.
    The org registration form is displayed.
  5. Click Set Package Access Control to set the accessibility for Conga packages to be upgraded with Conga Upgrade Program.
  6. Click Submit.

    The Early Feedback pop-up is displayed. In addition, Conga sends an email notification to the system administrator on successful registration with a list of packages (including dependent packages, if any) handled in the upgrade process.

    The early feedback program executes a test suite to check if the customizations in your org are compatible with the upgrade. For more information, see the Conga Automation Early Feedback program.

  7. Click Try Now. A Conga Automation Dashboard is displayed with a Quick Guide pop-up. Click Yes to go through the quick tour of the dashboard.
  8. Click Click to see the test to view a list of tests to be executed for your org,
    A List of Tests pop-up is displayed.
  9. Enter your Email ID and Organization Name.
    You can enter multiple email ids.
  10. Click Trigger Welcome Email.
    Conga sends a welcome email to the email ids entered in the previous step with a list of tests performed in the early feedback program.
  11. Click Proceed.
    A Conga Services Test Automation Execution Page is displayed.
  12. Click the checkbox next to the Job ID and click Begin Test Execution to run the predefined automated test suite against your org.

    For the latest information on Conga Upgrade Program, see Conga Upgrade Program documentation.