8 Process Extensions

This chapter provides information about how to customize and configure process extensions.

8.1 Overview to Process Extensions

The Process Extensions node lets you define custom actions that extend the functionality of the Agile PLM system. The custom actions you define can be used to create custom reports, user-driven and workflow-triggered custom actions, and custom tools accessible through Agile PLM clients.

A Process Extension (PX) is either a Java class deployed on the Agile Application Server or a link to a URL. The URL can be a simple website or the location of a Web-based application.

There are two types of process extensions available in Agile PLM:

Custom process extensions (Custom PX) is a general name for PXs created in Data Settings > Process Extensions node. These PXs have limited initiation capability. This node continues as the site to store and manage your custom PXs.
Event-based process extensions (Event PX) are created in the System Settings > Event Management > Event Handlers node. For more information about Event-based process extensions, see "Handler Types" in Chapter 29, "Event Management."

There are several integration points for process extensions available in Agile PLM clients. You can invoke process extensions from the following areas:

Actions menu
Tools menu
Workflow Status
External reports
Dashboard – URL-based process extensions that are created with Dashboard as the integration point are listed in the Dashboard Extension field, while a Dashboard table with View Type List is created. The output of the URL-based process extension is displayed in the Dashboard table.

Note:

Technically, a custom AutoNumber source is another type of process extension because it uses the same server-side framework as custom actions. For more information about custom AutoNumber sources, see "AutoNumbers."

What tools do you need to develop process extensions? For URL-based PXs, you do not need any additional tools. You can define any number of URL-based PXs in the Process Extension Library and specify where those URLs can be accessed from in the client.

Note:

A server property called agile.sso.expirationTime controls the expiration of the cookie used by a URL-based PX. The default value of the property is 86400 (seconds), which means the cookie will expire after one day. The administrator can increase or decrease the expiration time by adding this property to agile.properties under <AgileHome>\agileDomain\config. Remember the value is in seconds.

To create process extensions that are Java classes deployed on the Agile Application Server, you need to use the Agile SDK, work with Oracle Consulting - Agile Practice, or work with an Agile partner to develop process extensions that suit your company.

For more information about how to use the process extensions framework to develop and deploy custom AutoNumber sources and custom actions, see the Agile SDK Developer Guide.

8.2 Using the Process Extension Library

The Process Extension Library is where you define the custom actions that can be used in Agile PLM clients. When you add a custom action to the Process Extension Library, you specify how to initiate that action from the client.

Agile PLM provides two default process extensions, as shown in the following table.

Table 8-1 Default process extensions

Name	Description
Accept Package Response	Sends an Accept response to the Agile PLM system that submitted a Package.
Reject Package Response	Sends a Reject response to the Agile PLM system that submitted a Package.

Agile Content Service (ACS) uses these process extensions to automatically send Accept or Reject responses during Agile-to-Agile communication. For more information, see Agile Content Service User Guide.

There are several ready-to-use process extensions used by Product Governance & Compliance. For more information, see Product Governance & Compliance User Guide.

Of course, you can add any number of additional process extensions to the Process Extension Library.

To add a custom action to the Process Extension Library:

Under Data Settings, double-click Process Extensions. The Process Extension Library window opens.
In the Process Extension Library window, click the Create New icon. The Add Process Extension dialog box appears.
Enter the following information:
- Name: Enter the name of the custom action.
- API Name: autogenerated
- Description: Enter a brief description of the custom action.
- Type: Select URL or Internal Custom Action.
- Address: Specify a Web address (if Type is set to URL).
- Internal Custom Action: Select a custom action from the list (if Type is set to Internal Custom Action). The list reflects the custom actions that have been deployed on the Agile Application Server using the process extensions framework. If no custom actions have been deployed, the list is empty.
- Initiate From: Select one or more locations from which the custom action can be initiated. Select from the following options:
  - Actions Menu: Enables users to select the custom action from the Actions menu of a properly configured class.
  - External Report: Enables users to generate a report by accessing an external resource or URL. If the process extension is an internal custom action, the External Report option is unavailable.
  - Tools Menu: Enables users to select the custom action from the Tools menu.
  - Workflow State (status): Invokes the custom action whenever a properly configured workflow enters a particular status. If the process extension is a URL, the Workflow State option is unavailable.
  If you specify that a custom action is initiated from the Actions menu or a workflow status, you can configure subclasses or workflows to use that custom action. If you specify that a URL is used to generate an external report, you can use the Agile Web Client to create the report. If you specify that an action is initiated from the Tools menu, it is available at all times in the Agile client.
- Roles: Select one or more roles to use for the custom action. To use the roles and privileges of the current user, leave this field blank. To temporarily override roles and privileges of the current user, select one or more roles. Once the custom action is completed, the client reverts to the current user's roles and privileges.
- Enabled: Select Yes.
Click OK to save the process extension.

To modify a process extension:

Under Data Settings, double-click Process Extensions. The Process Extension Library window opens.
Open the process extension you want to modify.
Change the settings, and then click OK.

To delete a process extension:

Under Data Settings, double-click Process Extensions. The Process Extension Library window opens.
Select the process extension you want to delete and click the Delete icon.

Note:

Custom actions currently being used by a class, workflow, or external report cannot be deleted. If you disable a custom action, it is inactive. Removing a custom action from the Process Extension Library does not affect custom code that has been deployed on the Agile Application Server.

8.3 Assigning Process Extensions to Classes

To add custom actions to the Actions menu of an Agile PLM object (such as a part or an ECO), you configure the object's class. Each base class, class, and subclass has a Process Extensions tab. The custom actions that you assign to a class must be previously defined in the Process Extension Library.

Process extensions are inherited from classes and base classes. Consequently, if you assign a process extension to a base class, it is also assigned to classes and subclasses beneath the base class.

Note:

Process extensions can be assigned to only one level in a class hierarchy. For example, if a process extension is assigned to the Part subclass it cannot be assigned to the Item base class.

However, for Agile Portlets, using the process extension Configurator, process extensions can be assigned only to base classes, that is, Items base class, not Parts or Documents classes, nor Part or Document subclasses.

To assign process extensions to a class:

Under Data Settings, double-click Classes. The Classes window opens.
Double-click the base class, class, or subclass you want to work with.
Click the Process Extensions tab.
In the toolbar, click the Assign icon. The Assign Process Extension dialog box appears.
Select custom actions in the Choice List, and then click the arrow button to move them into the Selected List. When you are finished, click OK.
Click OK to save settings.

8.4 Assigning Process Extensions to Workflow Statuses

For each workflow status except the Pending status, you can assign one or more custom actions that are initiated when the workflow enters that status. The custom actions you assign to a workflow status must be previously defined in the Process Extension Library.

Note:

The Automated Transfer Orders (ATOs) class and its subclasses do not support workflow-initiated process extensions.

To assign process extensions to a workflow status:

Under Workflow Settings, double-click Workflows. The Workflows window opens.
Double-click the workflow you want to work with.
Click the Status tab.
Select a status other than Pending. The Criteria properties table for the selected status appears below the status table.
Double-click the selected status in the Criteria properties table.
In the Process Extensions list, click the down arrow icon. A popup window appears.
Select custom actions in the Choices List, and then click the > button to move them into the Selected List. When you are finished, click OK.
Click Save to save settings.