Skip Headers

Agile Product Lifecycle Management Agile Configuration Propagation Guide Release 9.3.3 E39285-01 |
| Contents

Previous | Next |

# 6 Installing ACP

This chapter describes details regarding how to install ACP.

## 6.1 Required Information

To install ACP, you will need to know what operating system, application server, and version of Agile PLM are being used.

### 6.1.1 Operating System

This is the operating system of the machine on which you intend to install ACP. The following operating systems work with ACP:

- Windows family

- UNIX family (for example: Solaris, Linux)

### 6.1.2 Agile PLM Version

The versions of ACP and Agile PLM that will work together must be the same release. For instance, ACP933 works with Agile PLM 9.3.3, but it does not work with, for example, Agile PLM 9.3.0.2.

### 6.1.3 Application Server

The ACP Installer installs a specific set of files depending on the application server with which you connect to PLM. For ACP to communicate with Agile PLM, ACP and Agile PLM must be running the same application server. ACP works with the following application servers:

- Oracle Application Server (OAS)

- WebLogic Application Server (WLS)

### 6.1.4 Installation Directory

The installation directory is the directory (or folder) in which you want to install ACP. There are no restrictions to where you may install ACP; however, the installation directory you choose should not pre-exist. If it does exist, you will be cautioned and asked if you want to proceed. If you do proceed, the existing directory will be purged.

The ACP Installer offers a default directory to install to, but you should be clear before installing exactly what directory is in line with your site installation policy.

### 6.1.5 Work Directory

The work directory is a directory where all project folders will be created. This is your directory to manage any way you fit. The ACP Installer prompts you for your work directory so that it can place a sample ACP project to get you started.

## 6.2 Prerequisites

Downloading Java Runtime Environment and the ACP Installer are prerequisites for installing ACP.

### 6.2.1 Java Runtime Environment

ACP requires Java's JRE 1.6.x to install and run ACP. You must download and install Java yourself.

### 6.2.2 ACP Installer

You can download the ACP Installer from the current Oracle MediaPack under the Deployment_Tools/ACP directory.

The version of ACP must correspond exactly to the version of Agile PLM that you are using.

## 6.3 Windows Installation

To install ACP on a Windows-based system, follow the steps below.

### 6.3.1 Extract

The ACP Installer is contained in a standard ZIP file. You can unzip the files to a directory of your choice.

### 6.3.2 Run Installer

It takes two minutes or less to set up and install ACP.

#### 6.3.2.1 Open Command Window

The ACP Installer is an (Apache) Ant-based installer. It must be run from a command window.

#### 6.3.2.2 Go to ACP Installer Directory

Change the directory to the directory in which you unzipped the ACP Installer.

#### 6.3.2.3 Run the Installer Script

Use the following steps to run the installer script.

1. Set JAVA_HOME

   In order to run the ACP Installer, the environment variable JAVA_HOME must be set; it should be set to where you installed Java JRE 1.6.

       SET JAVA_HOME=<Java JRE 1.6 Directory>

2. Run Installation Script

   Run the specific installation script to install ACP on Windows systems:

       install_win

   When the script starts, the Oracle/Agile splash screen is presented, which indicates progress of the installer as it is working.

3. Answer Prompts

   The installer prompts you for required information. The prompts have default responses indicated by brackets ([]). Press the Enter key to accept the default response.

   a. Are you sure you want to install this version of ACP? ([y], n)

   Just above this prompt, the ACP Installer displays the version of ACP that will be installed. Please verify that this is the version you intended to install. If it is not, you must respond "n" to this prompt.

   b. Select App Server Platform to use? ([oas], wlsThe application server platform is based on the application server used by the Agile PLM instance to which ACP will connect. You can enter only an abbreviation to designate the application server:

   - Oracle App Server: oas

   - WebLogic App Server: wls

   c. Enter directory to install ACP?[C:\Agile\ACP<####>]

   This is the directory to which the ACP binaries and other files will be installed. The ACP Installer tries to provide a reasonable default location for you to install ACP, but you can use another location. "<####>" represents the version of Agile PLM with which this version of ACP works.

   d. Enter the work directory to use with ACP?[C:\Agile\ACPWork<####>]

   This is the directory where you will create ACP project directories; ACP is run from a project directory. This directory can be relative to the installation directory you entered, or it can be a completely separate directory tree. "<####>" represents the version of Agile PLM with which this version of ACP works.

   e. The chosen ACP install directory already exists. Do you want to continue? (y, [n])

   This prompt appears only when the install directory you specify already exists. This prompt cautions you about potentially installing over another application or overwriting an inappropriate directory. If you wish to continue, you must enter "y" as a response.

## 6.4 UNIX (Linux) Installation

To install ACP on a UNIX- or Linux-based system, follow the steps below.

### 6.4.1 Extract

The ACP Installer is contained in a standard ZIP file. You can unzip the files to a directory of your choice. When unzipping the ZIP file, use the -a option to make sure text files are extracted properly.

    unzip -a acp_install.zip

### 6.4.2 Make Executable

For UNIX and Linux users, the ACP Installer must be prepared for execution. This is simply a matter of making the appropriate install script executable. The script exists in the directory to which you extracted the ACP Installer ZIP file.

    chmod u+x install_unix

### 6.4.3 Run Installer

It takes two minutes or less to set up and install ACP.

#### 6.4.3.1 Open Terminal Window

The ACP Installer is an (Apache) Ant-based installer. It must be run from a terminal window.

#### 6.4.3.2 Go to ACP Installer Directory

Change the directory to the directory in which you unzipped the ACP Installer.

#### 6.4.3.3 Run the Installer Script

1. Set JAVA_HOME

   In order to run the ACP Installer, the environment variable JAVA_HOME must be set; it should be set to where you installed Java JRE 1.6.

       JAVA_HOME=<Java JRE 1.6 Directory>

2. Run Installation Script

   Run the specific installation script to install ACP on UNIX/Linux systems:

       install_unix

   When the script starts, the Oracle/Agile splash screen is presented if X11 is running on your system. This indicates progress of the installer as it is working.

3. Answer Prompts

   The installer will prompt you for the required information. The prompts have default responses indicated by brackets ([]). Press the Enter key to accept the default response.

   a. Are you sure you want to install this version of ACP? ([y], n)

   Just above this prompt, the ACP Installer displays the version of ACP that will be installed. Please verify that this is the version you intended to install. If it is not, you must respond "n" to this prompt.

   b. Select App Server Platform to use? ([oas], wls)

   The application server platform is based on the application server used by the Agile PLM instance to which ACP will connect. You can enter only an abbreviation to designate the application server:

   - Oracle App Server: oas

   - WebLogic App Server: wls

   c. Enter directory to install ACP?[/opt/Agile/ACP<####>]

   This is the directory to which the ACP binaries and other files will be installed. The ACP Installer tries to provide a reasonable default location for you to install ACP, but you can use another location. "<####>" represents the version of Agile PLM with which this version of ACP works.

   d. Enter the work directory to use with ACP?[/<Home>/<user>/ACPWork<####>]

   This is the directory where you will create ACP project directories; ACP is run from a project directory. This directory can be relative to the installation directory you entered, or it can be a completely separate directory tree. "<####>" represents the version of Agile PLM with which this version of ACP works.

   e. The chosen ACP install directory already exists. Do you want to continue? (y, [n])

   This prompt appears only when the install directory you specify already exists. This prompt cautions you about potentially installing over another application or overwriting an inappropriate directory. If you wish to continue, you must enter "y" as a response.

## 6.5 Postinstallation Tasks

The following sections describe post-installation tasks.

### 6.5.1 ACP-Installed Directories

You might require multiple instances of ACP to work with multiple versions of Agile PLM, for example, if you are beginning the Upgrade process to a new PLM release but must maintain updates in the earlier, live version of PLM.

\Agile PLM | <- where Agile PLM is installed
--- | ---
\ACP | <- where ACP client is installed
\ < version > | <- level for multiple instances of ACP
\bin \classes \lib | <- standard installed directories ( below)
(Etc.) | Etc.

#### 6.5.1.1 ACP Client-Installed Directory Structure

The following directories are owned by the installation. Do not modify the files in these directories, as they are subject to change without notice.

- ant - contains a subset of the Ant utility. ACP uses Apache Ant for project management.

- bin - contains scripts to run the ACP utility programs

- classes - contains text resources that may be localized (that is, translated) or customized

- lib - contains the set of libraries that are required for the ACP utility.

- schema - contains the schema file for the ACP Control File

- schema / docs - contains the online documentation for the ACP Control File, acp_control_file.html

- templates - contain template project files and property files

#### 6.5.1.2 ACP Work Directory Structure

It is a best practice that you organize your configuration needs into "projects". Each project is maintained in a separate project folders. Project folders are contained in the work directory specified when ACP is installed.

This topic is the starting point for the next chapter, "Running ACP".