Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Welcome to ACP

• 1.1 Overview
  • 1.1.1 Purpose of ACP
  • 1.1.2 Functions of ACP
  • 1.1.3 Who will use ACP?
  • 1.1.4 Who should not use ACP?
  • 1.1.5 Improper Uses of ACP
  • 1.1.6 System Requirements for ACP
    • 1.1.6.1 Platform Requirements
    • 1.1.6.2 Licensing Requirements
    • 1.1.6.3 Environmental Requirements
• 1.2 Using this Manual
• 1.3 What's New in ACP
  • 1.3.1 New Features in ACP933
  • 1.3.2 New Features in ACP932
  • 1.3.3 New Features in ACP93
  • 1.3.4 ACP931/9301/9302
• 1.4 Changes to the Control File Schema (for previous ACP users)
  • 1.4.1 Server Portals not supported (Copy, Rename, Delete)
  • 1.4.2 Case Sensitive List Entries attribute removed (Copy)
  • 1.4.3 Changes in Rename section due to API Name/User ID
    • 1.4.3.1 Rename by API Name
    • 1.4.3.2 Rename by User ID
    • 1.4.3.3 Rename no longer supported
  • 1.4.4 Changes to Subobject Maps section due to API Name
    • 1.4.4.1 Subobject Map object reference by API Name
    • 1.4.4.2 Subobject Map subobject identified by API Name
    • 1.4.4.3 Subobject Map no longer supported

2 ACP Terms

• 2.1 Instance Terms
• 2.2 Function Terms
• 2.3 Data Terms
• 2.4 Machine Terms
• 2.5 File Terms
• 2.6 Process Terms
• 2.7 User Terms

3 Use Case

• 3.1 Configuration Management
• 3.2 Configuration Tasks
  • 3.2.1 Schematic of PLM Configuration
  • 3.2.2 Validate Agile PLM Data
  • 3.2.3 Create a Project
  • 3.2.4 Configure Agile PLM
  • 3.2.5 Export Admin Data
  • 3.2.6 Import Admin Data for Testing
  • 3.2.7 Test Admin Data Changes
  • 3.2.8 Prepare for Dry Run
  • 3.2.9 Execute Dry Run
  • 3.2.10 Execute Go Live
  • 3.2.11 Audit Configuration Changes

4 ACP Product Information

• 4.1 Installation of ACP
• 4.2 PLM Client Application
  • 4.2.1 Command-line User Interface
• 4.3 PLM SDK Application
• 4.4 Propagation Tool
  • 4.4.1 Propagation Strategies
  • 4.4.2 Propagation Method
• 4.5 A Control File drives every Propagation or Comparison
  • 4.5.1 API Name-based Rename and Subobject Maps
• 4.6 ACP Actions and Uses of the Control File
  • 4.6.1 Copy Action (and section of Control File)
  • 4.6.2 Rename Action (and section of Control File)
  • 4.6.3 Delete Action (and section of Control File)
  • 4.6.4 Subobject Maps (section of Control File)
  • 4.6.5 Ignore References (section of Control File)
  • 4.6.6 Name Compare and Deep Compare
• 4.7 Configuration Types
  • 4.7.1 Nonpropagating Administrator Objects
  • 4.7.2 Type Filtering on Configuration Types
  • 4.7.3 Object Matching (Mapping)
    • 4.7.3.1 Limitations of Mapping
• 4.8 Processing Order in ACP
  • 4.8.1 Processing Order Rules
    • 4.8.1.1 Copy Rules
    • 4.8.1.2 Rename Rules
    • 4.8.1.3 Delete Rules
• 4.9 Configuration History
• 4.10 Internationalization
• 4.11 Personalization
  • 4.11.1 Tab Display Configuration
  • 4.11.2 Global Views
  • 4.11.3 Global Searches and Out-of-box Searches
  • 4.11.4 Global Reports and Standard Reports

5 User Requirements

• 5.1 Standard PLM Privileges that can Access ACP
• 5.2 Tailored Roles for the ACP User
• 5.3 Privileges for the ACP User

6 Installing ACP

• 6.1 Required Information
  • 6.1.1 Operating System
  • 6.1.2 Agile PLM Version
  • 6.1.3 Application Server
  • 6.1.4 Installation Directory
  • 6.1.5 Work Directory
• 6.2 Prerequisites
  • 6.2.1 Java Runtime Environment
  • 6.2.2 ACP Installer
• 6.3 Windows Installation
  • 6.3.1 Extract
  • 6.3.2 Run Installer
    • 6.3.2.1 Open Command Window
    • 6.3.2.2 Go to ACP Installer Directory
    • 6.3.2.3 Run the Installer Script
• 6.4 UNIX (Linux) Installation
  • 6.4.1 Extract
  • 6.4.2 Make Executable
  • 6.4.3 Run Installer
    • 6.4.3.1 Open Terminal Window
    • 6.4.3.2 Go to ACP Installer Directory
    • 6.4.3.3 Run the Installer Script
• 6.5 Postinstallation Tasks
  • 6.5.1 ACP-Installed Directories
    • 6.5.1.1 ACP Client-Installed Directory Structure
    • 6.5.1.2 ACP Work Directory Structure

7 Running ACP

• 7.1 ACP Projects
  • 7.1.1 ACP Project Directories
  • 7.1.2 Sample Project Directory
• 7.2 Creating Projects
  • 7.2.1 Existing Project
  • 7.2.2 New Project
• 7.3 ACP Properties
• 7.4 ACP Control File
• 7.5 ACP Scripts
• 7.6 ACP Exit Codes
• 7.7 ACP Log Files
• 7.8 Summary

8 Configuring the ACP Control File

• 8.1 ACP Control File
• 8.2 XML Format
  • 8.2.1 Element
    • 8.2.1.1 Empty Element
    • 8.2.1.2 Simple-Content Element
    • 8.2.1.3 Element-Content Element
    • 8.2.1.4 Mixed-Content Element
    • 8.2.1.5 Element with Attributes
  • 8.2.2 Root Element or Document Element
  • 8.2.3 Element Tags
  • 8.2.4 Element Attributes
  • 8.2.5 Comments in XML
  • 8.2.6 Special Characters
• 8.3 Business Logic Attributes in the Control File
  • 8.3.1 Objects per File
  • 8.3.2 File Prefix
  • 8.3.3 Criteria Force Update
  • 8.3.4 Autonumber Force Update
  • 8.3.5 Force Delete List Entry
  • 8.3.6 New User Password
  • 8.3.7 Process Extension Association Rule
  • 8.3.8 User Association Rule
• 8.4 Control File Sections
  • 8.4.1 Copy (<copy>) Section
    • 8.4.1.1 Configuration Types in Copy Section
    • 8.4.1.2 Include Patterns
    • 8.4.1.3 Exclude Patterns
    • 8.4.1.4 Regular Expressions
    • 8.4.1.5 Putting it all together in Copy section
  • 8.4.2 Rename (<rename>) Section
    • 8.4.2.1 Configuration Types in Rename Section
    • 8.4.2.2 Key Maps
    • 8.4.2.3 Source Key
    • 8.4.2.4 Target Key
    • 8.4.2.5 Putting it all together in Rename section
  • 8.4.3 Delete (<delete>) Section
    • 8.4.3.1 Configuration Types in Delete Section
    • 8.4.3.2 Name
    • 8.4.3.3 Putting it all together in Delete section
  • 8.4.4 Ignore References (<ignore_references>) Section
    • 8.4.4.1 Configuration Types in Ignore References Section
    • 8.4.4.2 Patterns
    • 8.4.4.3 Regular Expressions
    • 8.4.4.4 Putting it all together in Ignore References section
  • 8.4.5 Subobject Maps (<subobject_maps>) Section
    • 8.4.5.1 Configuration Types in Subobject Maps Section
    • 8.4.5.2 Object Reference
    • 8.4.5.3 Subobject Type
    • 8.4.5.4 Flex Attribute Rename
    • 8.4.5.5 Key Maps
    • 8.4.5.6 Source Key
    • 8.4.5.7 Target Key
    • 8.4.5.8 Putting it all together in Subobject Maps section

A ACP Configuration Types

• A.1 Supported ACP Configuration Types
• A.2 Configuration Types and Match Keys
• A.3 Renaming Subobjects
• A.4 Configuration Types as Evaluated by Deep Compare
  • A.4.1 Log and Report Files for Deep Compare

B Regular Expressions

• B.1 Java Regular Expressions
• B.2 Special Characters
  • B.2.1 XML Special Characters
• B.3 Java Regular Expression Special Characters
• B.4 Regular Expression Examples

C Properties

• C.1 Property Sources
• C.2 Defining Properties
  • C.2.1 Java-style Property
  • C.2.2 Property References
  • C.2.3 Indirect References
• C.3 Properties
  • C.3.1 Agile-owned Properties
  • C.3.2 Agile-defaulted Properties
  • C.3.3 Customer-owned Properties

D ACP Scripts

• D.1 Working Directory
• D.2 Java Home
• D.3 Running Scripts
  • D.3.1 ACP Launcher
• D.4 Propagation Scripts
  • D.4.1 export
  • D.4.2 import
• D.5 Version Script
  • D.5.1 version
• D.6 Project Management Script
  • D.6.1 create_project
• D.7 Password Encryption Script
  • D.7.1 encryptpwd
• D.8 Object Name Comparison Script
  • D.8.1 name_compare
• D.9 Object Detail Comparison Script
  • D.9.1 deep_compare
  • D.9.2 Generating the Deep Compare Difference Report
    • D.9.2.1 Command
    • D.9.2.2 Console Message:
    • D.9.2.3 Deep Compare Difference Report
    • D.9.2.4 Deep Compare Report Sections and Fields

E ACP Exit Codes

F ACP Program Logs

• F.1 Verobse Log
• F.2 Console (stdout) Log
• F.3 Anatomy of Console (stdout) Log
• F.4 Sample Console (stdout) Log
• F.5 Error Log
  • F.5.1 Error Messages
  • F.5.2 Anatomy of the Error Log
  • F.5.3 Sample Error Log
• F.6 Process Log
  • F.6.1 Anatomy of the Process Log
  • F.6.2 Sample Process Log