Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction

• 1.1 About this Guide - Developing PLM Extensions
  • 1.1.1 PLM Extensions
• 1.2 SDK Components
  • 1.2.1 Client-Side Components
    • 1.2.1.1 Documentation
    • 1.2.1.2 Installation
    • 1.2.1.3 Server-Side Components
• 1.3 SDK Architecture
• 1.4 System Requirements
• 1.5 Java Requirements
  • 1.5.1 JVM Parameters for Preventing Out of Memory Exceptions
• 1.6 Agile SDK Installation Folders
• 1.7 Checking Your Agile PLM System
• 1.8 Agile PLM Business Objects

2 Developing Web Service Extensions

• 2.1 About Web Service Extensions
  • 2.1.1 Key Features
  • 2.1.2 WSX Architecture
• 2.2 Web Services Technology
  • 2.2.1 Web Services Architecture
  • 2.2.2 Security
  • 2.2.3 Tools
  • 2.2.4 Finding Additional Information About Web Services
• 2.3 Developing and Deploying a Web Service
  • 2.3.1 About Deployment Descriptors
  • 2.3.2 Reserved Web Service Names
• 2.4 Using a Web Service
  • 2.4.1 Defining a Web Service Entry Point
• 2.5 Authenticating Users
  • 2.5.1 Using Single Sign-On Cookies for Client-Server Access
    • 2.5.1.1 Deployment Architecture
    • 2.5.1.2 Invoking the Web Service Client with a Single Sign-on Cookie
    • 2.5.1.3 Retrieving the Single Sign-On Cookie
    • 2.5.1.4 Modifying the SOAP Binding Stub Code
• 2.6 Preparing the Environment for MyFirstWebService
  • 2.6.1 Downloading Tools to Build the Sample
  • 2.6.2 Installing the Java SDK
  • 2.6.3 Installing Ant
• 2.7 Building MyFirstWebService Sample
• 2.8 About Web Service Clients
  • 2.8.1 Client Programming Languages
  • 2.8.2 Accessing a Web Service
• 2.9 Creating a Web Service Client
  • 2.9.1 Generating the SOAP Request
  • 2.9.2 Submitting the SOAP Request
  • 2.9.3 Processing the SOAP Response
  • 2.9.4 Running the Sample on the Web Service Client
  • 2.9.5 Creating an Agile Session inside WSX
• 2.10 Microsoft .NET Interoperability
• 2.11 Web Service Extensions FAQs

3 Developing Process Extensions

• 3.1 About Process Extensions
• 3.2 Developing Custom Autonumber Sources
  • 3.2.1 Defining a Custom Autonumber Source
  • 3.2.2 Packaging and Deploying a Custom Autonumber Source
• 3.3 Configuring Custom Autonumber Sources in Java Client
  • 3.3.1 Assigning Autonumber Sources to a Subclass
• 3.4 Developing Custom Actions
  • 3.4.1 Defining a Custom Action
    • 3.4.1.1 Formatting New Lines (Line Breaks) in PLM Clients
  • 3.4.2 Custom Actions and User Sessions
  • 3.4.3 Packaging and Deploying a Custom Action
  • 3.4.4 Roles and Privileges for Custom Actions
    • 3.4.4.1 User Privileges for Configuring Process Extensions
  • 3.4.5 Configuring Custom Actions in Agile Java Client
    • 3.4.5.1 Using the Process Extension Library
    • 3.4.5.2 Assigning Process Extensions to Classes
    • 3.4.5.3 Assigning Process Extensions to Workflow Statuses
• 3.5 Working with AutoView Extensions
  • 3.5.1 About AutoVue and AutoVue Viewer
  • 3.5.2 PX Interfaces for AutoVue Extension
    • 3.5.2.1 Actions Performed by the Calling PX
    • 3.5.2.2 Displaying Results of PX Actions
• 3.6 Defining and Deploying URL-Based Process Extensions
  • 3.6.1 Before Building a URL-Based Process Extension
  • 3.6.2 Defining a URL-Based Process Extension
  • 3.6.3 Setting Cookie Expiration Properties for URL Process Extensions
  • 3.6.4 Passing Encoded Agile PLM Information to Other Applications
  • 3.6.5 Creating an Agile PLM Session from the Target System
  • 3.6.6 Retrieving an Agile PLM Object from an HTTP Request
  • 3.6.7 Identifying Attributes for Agile PLM Classes
• 3.7 Creating an External Report
• 3.8 Deploying Process Extensions in Clustered Environments
• 3.9 Best Practices for Copying third Party JAR Files
  • 3.9.1 Process Extensions FAQs

4 Developing Dashboard Management Extensions

• 4.1 About Dashboard Management Extensions
  • 4.1.1 Roles and Privileges in Dashboard Management Extensions
• 4.2 Developing Custom Chart Dashboard Management Extensions
  • 4.2.1 Understanding ChartDataModel and ChartDataSet
  • 4.2.2 Defining a Custom Chart DX Data Source
  • 4.2.3 Packaging and Deploying a Custom Chart DX Source
  • 4.2.4 Configuring Chart DXs in Java Client
    • 4.2.4.1 Displaying Optional Tabs in Agile Web Client
• 4.3 Developing Custom Table Dashboard Management Extensions
  • 4.3.1 Understanding Collections and CustomTableConstants
  • 4.3.2 Defining a Custom Table DX Data Source
    • 4.3.2.1 Configuring the Link Data Type for Objects Created in Custom Table DXs
    • 4.3.2.2 Invoking Advanced Search in a Custom Table DX Data Source
    • 4.3.2.3 Enabling Quick View in a Custom Table DX Data Source
    • 4.3.2.4 Displaying Quick View with Mouseover
    • 4.3.2.5 Opening the Selected Object in the Right Pane
  • 4.3.3 Packaging and Deploying a Custom Table DX Source
    • 4.3.3.1 To package and deploy a Table DX source:
  • 4.3.4 Configuring Table DXs in Java Client
    • 4.3.4.1 To Add a Table to a Tab:
  • 4.3.5 Defining Custom (URL) Extensions

5 Working with Agile PLM Events and Event Context Objects

• 5.1 Understanding Agile PLM Events and Event Framework
• 5.2 Key Components of an Agile PLM Event
  • 5.2.1 Event Types
  • 5.2.2 Event Handler and Handler Types
  • 5.2.3 Event Subscribers
    • 5.2.3.1 Event Trigger and Trigger Types
    • 5.2.3.2 Event Trigger Types
    • 5.2.3.3 Synchronous and Asynchronous Execution Modes
    • 5.2.3.4 Synchronous and Asynchronous Operations in OAS Clusters
    • 5.2.3.5 Event Error Handling Rule
    • 5.2.3.6 Event Order
    • 5.2.3.7 Event FAQs
• 5.3 Working with Event Context Objects
  • 5.3.1 Understanding Event Context Objects
    • 5.3.1.1 Persistent and Transient Data
    • 5.3.1.2 Event Information Objects
    • 5.3.1.3 Event Script Objects
• 5.4 Working with Event Information and Event Script Objects
  • 5.4.1 Working with Base Event Actions
    • 5.4.1.1 Base Event Information Object - Java PX
    • 5.4.1.2 Base Event Script Objects - Script PX
  • 5.4.2 Working with General Object Actions
    • 5.4.2.1 General Object Actions - Java PX
      • 5.4.2.1.1 Create Object
    • 5.4.2.2 Update Title Block
    • 5.4.2.3 Save As Object
    • 5.4.2.4 Delete Object
    • 5.4.2.5 Export Object
    • 5.4.2.6 General Object Actions - Script PX
    • 5.4.2.7 Create Object
    • 5.4.2.8 Update Title Block
    • 5.4.2.9 Save As Object
    • 5.4.2.10 Delete Object
    • 5.4.2.11 Export Object
  • 5.4.3 Working with Table and Relationship Actions
    • 5.4.3.1 Table and Relationship Actions - Java PX
    • 5.4.3.2 Update Table
    • 5.4.3.3 Update Relationship
    • 5.4.3.4 Table and Relationship Actions - Script PX
    • 5.4.3.5 Update Table
  • 5.4.4 Working with Variant Management Events
    • 5.4.4.1 Variant Management Events - Java PX
    • 5.4.4.2 Variant Management Events - Script PX
  • 5.4.5 Working with Workflow Object Actions
  • 5.4.6 Change Status for Workflow
  • 5.4.7 Approve for Workflow
    • 5.4.7.1 Reject for Workflow
    • 5.4.7.2 Escalation for Workflow
  • 5.4.8 Reminder for Workflow
    • 5.4.8.1 Audit for Workflow
    • 5.4.8.2 Promotion Failure for Workflow
    • 5.4.8.3 Comment for Workflow
    • 5.4.8.4 Change Approvers or Observers for Workflow
  • 5.4.9 Workflow Object Actions - Script PX
    • 5.4.9.1 Change Status for Workflow
    • 5.4.9.2 Approve for Workflow
    • 5.4.9.3 Reject for Workflow
    • 5.4.9.4 Escalation for Workflow
    • 5.4.9.5 Reminder for Workflow
    • 5.4.9.6 Audit for Workflow
    • 5.4.9.7 Promotion Failure for Workflow
    • 5.4.9.8 Comment for Workflow
    • 5.4.9.9 Change Approvers or Observers for Workflow
  • 5.4.10 Working with Specific Object-Based Actions
    • 5.4.10.1 Specific Object-Based Actions - Java PX
    • 5.4.10.2 Incorporate Item and Unincorporate Item
    • 5.4.10.3 Change Status for Sourcing Project
    • 5.4.10.4 Specific Object-Based Actions - Script PX
    • 5.4.10.5 Incorporate Item and Unincorporate Item
    • 5.4.10.6 Change Status for Sourcing Project
  • 5.4.11 Working with Files and Attachments Objects Actions
    • 5.4.11.1 Files and Attachments Objects Actions - Java PX
    • 5.4.11.2 Purge File Version
    • 5.4.11.3 Files and Attachments Objects Actions - Script PX
    • 5.4.11.4 Get File, Check Out Files, Check In Files, Cancel Check Out Files
    • 5.4.11.5 Purge File Version
  • 5.4.12 Working with Product Governance and Compliance Actions
    • 5.4.12.1 Product Governance and Compliance Actions - Java PX
    • 5.4.12.2 Compliance Rollup On Object
    • 5.4.12.3 Product Governance and Compliance Actions - Script PX
    • 5.4.12.4 Compliance Rollup On Object
  • 5.4.13 Working with Miscellaneous Object Actions
    • 5.4.13.1 Miscellaneous Object Actions - Java PX
    • 5.4.13.2 Transfer Authority
    • 5.4.13.3 Miscellaneous Object Actions - Script PX
    • 5.4.13.4 Transfer Authority
  • 5.4.14 Working with Event Integration Points in PLM Clients
    • 5.4.14.1 Event Integration Points - Java PX
    • 5.4.14.2 Extend Actions Menu
    • 5.4.14.3 Extend Tools Menu
    • 5.4.14.4 Scheduled Event
    • 5.4.14.5 Event Integration Points - Script PX
    • 5.4.14.6 Extend Actions Menu
    • 5.4.14.7 Extend Tools Menu
    • 5.4.14.8 Scheduled Event
  • 5.4.15 Guidelines for Java PX and Script PX Handlers
    • 5.4.15.1 Working with Agile PLM Administrator
    • 5.4.15.2 Testing Event Java PX and Event Script PX
    • 5.4.15.3 Triggering Guidelines for Java PX, Script PX, and Notification Handlers
    • 5.4.15.4 General Object Actions
    • 5.4.15.5 Create Object Event and SaveAs Event
    • 5.4.15.6 Update Title Block Event
    • 5.4.15.7 Update Table Event
    • 5.4.15.8 Workflow Actions
    • 5.4.15.9 Promotion Failure for Workflow Event
    • 5.4.15.10 Create Automatic Transfer Object Action (ATO)
    • 5.4.15.11 Files and Attachments Actions
    • 5.4.15.12 Check In File Event
    • 5.4.15.13 Check Out File Action
    • 5.4.15.14 Cancel Check Out File Event
    • 5.4.15.15 Get File Event

A Migrating Custom Process Extensions to Event Framework

• A.1 Understanding Custom PXs and Java PXs
  • A.1.1 Custom PXs in PX Framework
  • A.1.2 Process Extensions in Event Framework
  • A.1.3 Custom PXs You Can Migrate to Event Framework
• A.2 Migration Task List
  • A.2.1 Task - 1: Modify the Custom PX Code
    • A.2.1.1 Custom PX Code
    • A.2.1.2 Java PX Code
  • A.2.2 Task - 2: Package and Deploy the Modified Code
  • A.2.3 Task - 3: Configure Event in Event Framework
    • A.2.3.1 Create Event
    • A.2.3.2 Create Event Handler
    • A.2.3.3 Create Event Subscriber
    • A.2.3.4 Configure Trigger Type, Execution Mode, Order, and Error Handling Rule
    • A.2.3.5 Trigger Type Field
    • A.2.3.6 Execution Mode Field
    • A.2.3.7 Order Field
    • A.2.3.8 Error Handling Rule
  • A.2.4 Task - 4: Test the Migrated PX in Event Framework
  • A.2.5 Task - 5: Remove Custom PX from Process Extension Library
  • A.2.6 Task - 6: Inform PLM Administrator

B Groovy Implementation in Event Framework

• B.1 What Is Groovy?
  • B.1.1 Sources of Information
  • B.1.2 Script PX or Java PX?
• B.2 Event Framework Implementation
  • B.2.1 Key implementation considerations
  • B.2.2 Starting a Script
  • B.2.3 Accessing SDK with Scripts
  • B.2.4 Use Cases

C Variant Management Configuration Graph Schema

• C.1 The XML Schema