Use Adobe exceptions deployer

NOTE: this document has been superceded since the release of Creative Cloud Packager version 1.9.3.  Please see this document for installation instructions for packages created since this version of the packager tool.

Adobe® Exceptions Deployer Application provides an automated way to deploy the packages in the Exceptions folder, that is, the packages that you would otherwise deploy separately before and/or after deploying the main MSI or PKG file.

Exceptions Deployer Application can be used to deploy only the payloads generated by Adobe® Creative Cloud™ Packager in the Exceptions folder. Payloads not generated by Creative Cloud Packager (for example downloaded from the web) can not be deployed using Exceptions Deployer Application.

Exceptions Deployer Application is copied to the Exceptions folder when you create a package using Creative Cloud Packager.

Note:

In this document, the packages in the Exceptions folder are referred to as “exception payloads.”

Background information about installation packages

When creating a package, Creative Cloud Packager presents you with a list of applications and updates that can be installed, from which you make your choices. All of these choices are recorded in the package.

When you create a package for enterprise deployment with Creative Cloud Packager, two folders are created:

  • The Build folder contains the MSI (Windows) or the PKG (Mac OS) file for deployment with enterprise deployment tools such as Microsoft SCCM, Apple ARD, or JAMF Casper Suite.
  • The Exceptions folder contains the payloads that must be installed separately.

Packages in the Exceptions folder

On Windows

In Windows, the Exceptions folder includes all the packages that should be installed separately.

On Windows, Acrobat was previously included in the Exceptions folder, but on packages created with Creative Cloud Packager version 1.9.3 and above, Acrobat will now be placed in the Build folder and is installed along with the other applications in the main installation package.

On Mac OS

On the Mac OS, if you selected the DISABLE AIR COMPONENTS IN PACKAGE option in the Configure Package screen, AIR-based components are not installed with the regular package. They are instead copied into the Exceptions folder, from where you install them. The instructions on installing are provided in the next sections.

If, however, on the Mac OS, you did not select the DISABLE AIR COMPONENTS IN PACKAGE option in the Configure Package screen, no components are copied to the Exceptions folder.

Sequence of installation of packages in the Exceptions folder

Except for Acrobat XI for Windows (in older packages), all packages in the Exceptions folder should be deployed after you have deployed the main MSI or PKG package. Acrobat XI for Windows should be deployed before you deploy the main package.

Therefore, if you are using Exceptions Deployer Application to deploy Acrobat XI on Windows, you should run Exceptions Deployer Application before deploying the main MSI package (in pre mode). For all other packages, you run Exceptions Deployer Application after deploying the main packages (in post mode). If the Exceptions folder contains Acrobat for Windows as well as other packages, you run Exceptions Deployer Application twice—once before deploying the main MSI package (this will deploy Acrobat for WIndows) and once after deploying the main MSI package (this will deploy the other packages).

For Acrobat, Exception Deployer Application is not required. For Acrobat, you only need to run the setup.exe in the Build folder which will install Acrobat, the chosen type of license and any main applications not found in the Exceptions directory.

If any applications are still located in the Exceptions folder, you will need to run the ExceptionDeployer with its post-installation option to install them. These application include Adobe Scount, Gaming SDK, and Adobe Help.

For instructions on installing Acrobat manually, see Deploying Adobe Acrobat.

CCP deployment script

On Windows, you can use the following script to deploy Creative Cloud Packager. The attached script is an example and you can use it after editing the following details according to the package you are deploying:

  • Language: @cd /d "%~dp0"
  • Names of MSI and log file: start /wait msiexec /i "<msi_file_name>.msi" /qn /lv* "<log_file_name>.log"
REM ------------------------------------------------------------------------------------------------
REM Example Creative Cloud Packager deployment script
REM Please note: change language and MSI and log filenames to match the package being used
REM then save this file inside the package, alongside the .ccp file defining the package
REM 2018 Adobe Inc. - for support please visit http://www.adobe.com/support/
REM ------------------------------------------------------------------------------------------------

REM Ensure script is running in the directory from which is was executed
@setlocal enableextensions
@cd /d "%~dp0"

REM Example with German installLanguage option; replace de_DE with fr_FR, en_GB, en_US etc. as required
cd Exceptions
 exceptionDeployer.exe --workflow=install --mode=pre --installLanguage=de_DE
cd ..\Build
 start /wait msiexec /i "Adobe CC All.msi" /qn /lv* "%TEMP%\CC_all_msiexec.log"
cd ..\Exceptions
 exceptionDeployer.exe --workflow=install --mode=post

Download

Using Exceptions Deployer Application to deploy the exception payloads

Exceptions Deployer Application zip package

The zip package contains two files:

  • ExceptionDeployer file, which is the Exceptions Deployer Application executable file
  • ExceptionConfig file, which contains configuration-related information for exception payloads.
Note:

Do not edit the ExceptionConfig file—it contains internal configuration-related information to be used with Exceptions Deployer Application.

Exceptions Deployer Application should be run from the Exceptions folder. It is copied to the Exceptions folder when you create a package using Creative Cloud Packager.

Requirements to run Exceptions Deployer Application

  • Exceptions Deployer Application should be launched with Admin credentials.
  • There can only be a single running Exceptions Deployer Application instance on a machine.

Exceptions Deployer Application syntax and description

Run Exceptions Deployer Application from the Exceptions folder, with the following syntax. The parameters in bold are mandatory.

ExceptionDeployer 
 --workflow=install 
 --mode=pre|post 
 --INSTALLDIR=<path_of_installation directory> 
 --installLanguage=<locale_code for Acrobat>
 --abortOnFail
 --help
Note:

The installLanguage option is required only if you are installing Acrobat for Windows.

Parameter

Description

--workflow=install

The workflow in which Exceptions Deployer Application is to be used. Currently, install is the only workflow.

--mode=pre|post

Specifies whether Exceptions Deployer Application is being run before or after deploying the main package.

Specify pre if you are running Exceptions Deployer Application to deploy the exception payload before deploying the main package. Currently, Acrobat for Windows is the only package that should be deployed before the main MSI package, and, therefore, requires Exceptions Deployer Application to be run before deploying the main package.

Specify post if you are running Exceptions Deployer Application to deploy the exception payload after deploying the main package. Currently, all exception payloads except Acrobat for Windows should be deployed after deploying the main package.

Note: It is recommended that you run Exceptions Deployer Application in both the pre and the post mode

--INSTALLDIR=<path of installation directory>

The path to the directory in which the exception payload should be installed.

Exception payloads should be installed in the same location in which the MSI or PKG file has been installed. You would have specified this information in the configuration screen while creating the main package.

If you do not specify this option, the exception payloads are installed in the default location specified within the payload.

--installLanguage

Specifies the locale for the Acrobat package.

Note:This option is required only if you are deploying Acrobat for Windows. If you specify this option for other packages, it will be ignored.

For a list of available locales for Acrobat in a particular suite, see the Locales for different Acrobat configurations.

--abortOnFail

Specifies whether Exceptions Deployer Application should continue with deployment of the next package if the deployment of one of the packages is unsuccessful.

Default is false, that is, if one of the packages can not be deployed, Exceptions Deployer Application does not exit—it continues with the deployment of the next package.

--help

Displays the command usage and syntax.

Examples

  • The following command is used to deploy Acrobat for Windows. (You will recollect that Acrobat for Windows should be deployed before deploying the main package.) The --mode=pre option specifies that Exceptions Deployer Application is run before deploying the main package. The installLanguage is specified as en_US (US English)—this option is also mandatory while deploying Acrobat for Windows.

ExceptionDeployer --workflow=install --mode=pre --installLanguage=en_US

  • The following command is used to deploy all the packages in the Exceptions folder (except the Acrobat for Windows package if present) The --mode=post option specifies that Exceptions Deployer Application is run after the main package has been deployed. Note that the --installLanguage option is not required here. Also, because the --INSTALLDIR option has not been specified, the exception payload will be deployed in the default location specified within the payload.

ExceptionDeployer --workflow=install --mode=post

  • The following command specifies that the package(s) in the Exceptions folder should be deployed to the \test directory on the client machine. The assumption is that you had earlier deployed the main package to the \test location on the client machine

ExceptionDeployer --workflow=install --mode=post --INSTALLDIR=\test

  • The following command specifies that the package(s) should be installed in the location \test on the client machine. Because the abortOnFail option is set to true, if one of the packages cannot be deployed, Exceptions Deployer Application will exit instead of continuing with the deployment of the next package.

ExceptionDeployer --workflow=install --mode=post --INSTALLDIR=\test --abortOnFail=true

Return values

After execution, Exceptions Deployer Application returns one of the following values:

0

Exception payload(s) deployed successfully

1

Generic error, for example an internal error

2

One or more payloads could not be deployed. For example, only two out of three payloads might have been deployed successfully.

Detailed information is available in the Exceptions Deployer Application Log file, explained in the next section.

Using the Exceptions Deployer Application man page on Mac OS

On Mac OS, you can use the Adobe Exceptions Deployer man page to get information on the syntax and usage from the command line. Use the following steps to set up the man page:

  1. Mount the Exceptions Deployer Application dmg file.
  2. Open a command terminal
  3. Change the directory to the mounted dmg file.
  4. Run the following command:
    sudo sh Install_XDAManPage.sh

This sets up the Exceptions Deployer Application man page. You can now get the syntax and usage information by running the man ExceptionDeployer command.

Exceptions Deployer Application log file

The Exceptions Deployer Application log file provides detailed information about the events that occur during deployment of exception payloads.

The log file is named ExceptionDeployer.log. This file is located as follows:

  • In Windows, the log file is in the %temp% location.
  • In Mac OS, the log file is in the folder ~/Library/Logs/.

Here are excerpts from contents of sample log files:

ExceptionDeployer.log on Windows: before deploying the main MSI file

11/22/2011 15:19:36[INFO] ExceptionDeployer - Build Version - 3.0.35.0
11/22/2011 15:19:36[INFO] ExceptionDeployer - Logging Level verbosity Set  to 4
11/22/2011 15:19:36 [INFO] ExceptionDeployer - 

11/22/2011 15:19:36 [INFO] ExceptionDeployer - ##################################################
11/22/2011 15:19:36 [INFO] ExceptionDeployer - Launching the ExceptionDeployer...
11/22/2011 15:19:36 [INFO] ExceptionDeployer - *********************************
11/22/2011 15:19:36 [INFO] ExceptionDeployer -    AcrobatProfessional10.0-EFG

11/22/2011 15:21:24 [INFO] ExceptionDeployer - The process return code is (0).
11/22/2011 15:21:24 [INFO] ExceptionDeployer - Exception deployment passed for (AcrobatProfessional10.0-EFG)
11/22/2011 15:21:24 [INFO] ExceptionDeployer - *********************************
11/22/2011 15:21:24 [INFO] ExceptionDeployer - *********************************
11/22/2011 15:21:24 [INFO] ExceptionDeployer - 

11/22/2011 15:21:24 [INFO] ExceptionDeployer - *********************************
11/22/2011 15:21:24 [INFO] ExceptionDeployer -    AdobeContentViewer-mul

11/22/2011 15:21:24 [INFO] ExceptionDeployer - Install information not found for this payload. Skipping the payload.
11/22/2011 15:21:24 [INFO] ExceptionDeployer - Exception deployment skipped for (AdobeContentViewer-mul)
11/22/2011 15:21:24 [INFO] ExceptionDeployer - *******************************
11/22/2011 15:21:24 [INFO] ExceptionDeployer - **************************************************
##################################################
11/22/2011 15:21:24 [INFO] ExceptionDeployer - Ending the ExceptionDeployer Return Code (0)
11/22/2011 15:21:24 [INFO] ExceptionDeployer - ###########################################
11/22/2011 15:21:24 [INFO] ExceptionDeployer - ###########################################
11/22/2011 15:21:24 [INFO] ExceptionDeployer - 

ExceptionDeployer.log on Mac OS: after deploying the main PKG file

Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - Build Version - 3.0.35.0
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - Logging Level verbosity Set  to 4
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - Launching the ExceptionDeployer...
Tue Nov 22 16:24:08 2011 [ERROR] ExceptionDeployer - ExceptionDeployer not launched with Admin privileges.
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - Ending the ExceptionDeployer Return Code (1)
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:24:08 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer - Build Version - 3.0.35.0
Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer - Logging Level verbosity Set  to 4
Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer - Launching the ExceptionDeployer...
Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:24:34 2011 [INFO] ExceptionDeployer -    AdobeContentViewer-mul

Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer - The process return code is (0).
Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer - Exception deployment passed for (AdobeContentViewer-mul)
Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:24:56 2011 [INFO] ExceptionDeployer -    AdobeDreamweaverWidgetsBrowser1.0-mul

Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - The process return code is (0).
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - Exception deployment passed for (AdobeDreamweaverWidgetsBrowser1.0-mul)
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer -    AdobeHelp

Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - The process return code is (0).
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - Exception deployment passed for (AdobeHelp)
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:02 2011 [INFO] ExceptionDeployer -    AdobeStory1.0-mul

Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - The process return code is (0).
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - Exception deployment passed for (AdobeStory1.0-mul)
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - **************************************************
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - 

Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - Ending the ExceptionDeployer Return Code (0)
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - ##################################################
Tue Nov 22 16:25:10 2011 [INFO] ExceptionDeployer - 

Get help faster and easier

New user?