UDA or User-Defined Attributes provide an infrastructure that you can use to define new attributes, group them and associate that group to one or more type of documents transacted within CLM. The UDA framework is used for information only attributes that do not impact the E-Business Suite business flows and for information defaulting in purchasing documents. Examples of UDA include MDAP/MAIS Codes, program codes etc.
User-defined attributes capture all the detailed information about an object. The Attribute Setup Workbench enables you to create user-defined attributes with validation logic to support the needs of your organization.
A large number of federal fields are applicable to all type of documents transacted within the CLM application. The application captures and maintains these fields at the document header or for every line present on the document. Most of these fields are informational and are implemented as pre-defined UDAs
Note: CLM UDA uses the framework provided by Oracle Product Information Management UDA. However, Oracle CLM uses only parts of that infrastructure. This guide provides you details of UDAs that are applicable for Oracle CLM users.
A summary of the steps you need to complete when planning your implementation, are listed below:
Plan the attributes you require.
Group the attributes.
Define the values sets for attributes.
Write PL/SQL code and load this to the database in apps schema.
Register the code as PL/SQL function.
Update the attribute template for usage and optionally as actions.
The key decision areas when planning your UDA implementation are:
Decide upon the attributes you require and the levels (business entities) at which you need the attributes.
Decide on how you want to group the set of attributes which need to display on the same set of levels into attribute groups in to suit your requirements. All operations on UDAs happen at the Attribute Group level. Attributes cannot exist outside an attribute group.
Decide where the attribute groups should render. There are predefined locations on the application pages where UDAs can display. Usages on the Attribute Template control this display.
Now, decide upon the allowable set of values for each attribute and how you would like it to render. For example, an attribute could render as a text field, check box, list, and so on.
At this stage, decide whether you need any actions on your attribute groups. Actions are optional and enable you to configure the behavior of UDAs beyond simple data capture. Actions execute predefined PLSQL program units, which you need to write and load to the database in apps schema. You also need to register these program units as functions in the Attribute Setup Workbench and also associate these functions to the attribute group as actions via attribute template.
It is recommended that you create your value set before defining your attribute groups. Ensure you identify the attributes you want to capture on specific documents, and group the attributes into functional group based on the way you intend to share them across documents.
You use the Attribute Setup Workbench to complete your UDA setup. Use the CLM Purchasing Super User responsibility to access the Attribute Setup Workbench. Navigate to Setup : Attribute Setup Workbench: Attribute Setup Workbench to access and use the following tabs to complete the UDA setup:
To be able to set up UDA, you must:
Define value sets for User-Defined Attributes.
Define attribute groups.
Define functions and function parameters.
Create new revisions to existing templates or create a new template.
Create and update actions on the attribute template to associate attribute groups with functions.
Simulate and test your setup.
User-defined attributes capture all the detailed information about an object. The Attribute Setup Workbench enables you to create user-defined attributes with validation logic to support the needs of your organization. To do so, create value sets and associate the value sets with user-defined attributes. Attributes can have a static or dynamic list of valid values, or a range of values. For each user-defined attribute, you can optionally specify a value set with data type and validation rules to be applied when the user inputs data. Once created, value sets can be reused for different attributes. It is recommended that you create your value set before defining your attribute groups.
To create a value set:
On the Attribute Setup Workbench page, click the Value Sets tab.
Click Create.
On the Create Value Sets page that displays, enter the Value Set Name. This is the name by which the system and users keep track of the value set. You can only enter alphanumeric (a, b, c,..., 1, 2, 3,...) and the underscore ( _) characters for the value set name. You cannot use spaces or special characters. The length is limited to 15 characters. This is a mandatory field.
Note: Once specified, you cannot edit the value set name
Enter a Description for the value set.
Select a Data Type for your value set. The data type that you select determines the values that are available in the value set. An attribute's data type must match the data type specified for that attribute's value set. The different data types are:
Character
Number
Standard Date
Standard Date Time
Note: You cannot edit the data type once the value set has been created.
Enter value for Maximum Size if you wish to limit the user's input in the attribute text field. For example, in some cases you may wish to limit the number of characters in the attribute Date to 10 characters, or the number of characters in Name to 50. Keep the default value of 0 if you wish to omit this particular validation. This is a mandatory field.
Select a Validation Type from this list. This is a set of values against which the values entered by users are validated. You can choose from:
None - there is no explicit set of values against which the user's input is validated.
Independent - the explicit values against which the user's input is validated are defined here. To create explicit values, choose Poplist to display valid values as a drop-down list. Select List of Values radio to display valid values as a searchable list of values.
Translatable Independent - this validation type behaves the same as Independent, but enables the display of values in another language.
Table - the explicit values against which the user's input is validated comes from a database table. For Validation type Table, the value set can display as List of Values or Poplist.
Note: Use Poplist if the value set is likely to have < 5 values. It is recommended to use List of Values if the number of values fetched in a value set is greater than 5 - 10. Additionally, note that the LOV defaulting actions is supported only on attributes which have a value set of type List of Values.
Click Apply and Continue.
Depending on the Validation Type you selected, you can enter values for your value set.
If you selected Independent or Translatable Independent, then enter the following details
Enter a name for the Value. This is the name used to identify the value internally.
Optionally, enter a description for the value.
Ensure the Enabled check is selected.
Enter a Sequence for the value. This sequence number determines the order in which the value displays.
Optionally enter a Start Date and End Date.
Click Add Another to add another value to the value set.
If you selected Table as the validation type, then enter the following details:
Enter an Application Name. This is the name of the application in which the table is registered.
Enter a Table Name. This is the name of the database table or view in the schema.
In the Value Column section, enter the display name of the column. Enter the data Type of the value column, and the Size of the value column.
In the Meaning Column section, enter the description of the value that renders in the LOV window. Enter the Type to determine the data type of the meaning column. Enter the Size of the meaning column.
In the ID Column section, enter the internal value for the column. Enter the data Type of the ID column. Enter the Size of the ID column.
In the Where Clause section, enter an additional Where clause to further constrain a query. You can also use bind values in Where clauses in the following ways:
You can refer to other attributes in the same attribute group as the attribute that uses this value set by using the following syntax:
:$ATTRIBUTEGROUP$.<your attribute's internal name>
For example: (lookup_type='EGO_EF_Industry_TYPE' and instr(:$ATTRIBUTEGROUP$.Attr1 , tag) > 0 )
Note: In the example above, ensure you include a space between Attr1 and the comma for the SQL string to parse correctly.
You can refer to primary keys for the object to which the attribute group is associated by using the following syntax:
:$OBJECT$.<the object's primary key column name>
Click Apply.
The Attribute Setup Workbench enables you to create set of operational user defined attributes that display at predefined locations in the application pages. Once you have decided upon the attributes you require, and the levels at which you require them, you can group sets of attributes, that need to display on the same set of levels, into attribute groups in a meaningful way based on your requirements. All operations on UDAs happen at the Attribute Group level.
In CLM, attributes are supported at the following levels:
Award Header, Line, Shipment
IDV Header, Line
Requisition Header, Line
Solicitation Header, Line
Offer Line
An attribute group can be single-row or multi-row. Single row attribute groups displays a text field with a value. Multi-row attribute groups enable you to associate multiple sets of attribute values with the same object instance. For multi-row attribute groups, you can define which attributes or combination of attributes will maintain uniqueness of records in cases where the attribute group is displayed as multi-row.
You can set up as many attribute groups as necessary, with the following limitations on the number of attributes within each attribute group:
40 character attributes
20 number attributes
10 date attributes
40 translatable attributes
Attributes are defined by their names and values, and are saved within attribute groups. Attributes cannot exist outside an attribute group. You can create user-defined attributes that more specifically identify their characteristics and specifications, and capture information. At this point, decide on the allowable set of values for each attribute and how you would like to render the attribute. For example, you might want to display one attribute as a text field and another as a check box, and so on.
If you want to configure the behavior of UDAs beyond simple data capture, then define actions on your attribute group. You can define UDAs to possess certain validation logic (for example, value sets) and indexes. You can control where your attribute groups render based on the usages you define on the attribute template. There are however, predefined locations on the application pages where you can display UDAs.
You create attribute groups to combine attributes in a logical, functional manner.
To create attribute groups:
On the Attribute Setup Workbench page, click the Attribute Groups tab. Click Create.
On the Create Attribute Group page that displays, enter an Internal Name for the attribute group.
Enter a Display Name. This is the name of the attribute group as it will be displayed in the user interface.
Optionally, enter the Description of the attribute group.
Select the Behavior of the attribute group:
Multi-Row to associate multiple sets of attribute values with the same object instance.
Single-Row to associate one attribute value with each object instance.
Click Maintain Unique Key to view, update , and delete unique key attributes. If the attribute group is multi-row, the Maintain Unique Key check box determines whether or not the attribute is part of the key that uniquely identifies a row. A unique key is any set of attributes whose values can be used to uniquely identify a row within the attribute group. You can define the unique key on the attribute group Detail page. You can add/edit the unique key as long as doing so does not destroy the uniqueness (creating duplicates) of existing records. You can specify that each attribute is part of a unique key when creating the attribute, or--more conveniently--you can specify all unique key attributes in the group via the attribute group Detail page.
Note: This is applicable for multi row attribute groups only.
Enter a value in the Number of columns shown in the table field. This field determines the number of columns that display in the attribute group page. The default value is 5.
Enter a value in the Number of rows shown in the table field. This field only appears for multi-row attribute groups and determines the number of rows that display in the attribute group page before the Next and Previous links display. The default value is 5.
This field only appears for multi-row attribute groups and determines the number of rows that display in the attribute group page
Select the Business Entities to which you want to apply the attribute group.
Note: When you enable an attribute group at multiple levels, the attribute data will flow as a target document is auto-created from a source document.
You can select all or choose from:
Order Header
Order Line
Order Shipments
Requisition Header
Requisition Line
Solicitation Headers
Solicitation Line
Offer Line
Click Apply and Add Attributes to add user-defined attributes to your attribute group.
On the Create Attribute page that displays, enter the internal name of the attribute. This the name by which the attribute is tracked internally.
Enter the Display Name. This is the name of the attribute as it appears within the user interface.
Enter the Sequence number for the attribute. The sequence determines the order in which the attribute is displayed on the page, and also determines the order in which the attribute is processed.
Enter a Tip for the attribute. This is the description of the attribute; this description also appears as tip text on pages that have attributes that can be updated.
Select a value for the Data Type. The data type you select determines the values that are available in the column and value set. An attribute's data type must match the data type specified for that attribute's value set. The list of values for a value set only displays value sets whose data type matches the data type of the attribute.
Note: Selecting a data type always clears the column and value set. For example, say you selected the Number data type. Then you select your column and value set--remember that your column and value set choices are determined by the data type you chose. Then you decide to change the data type from Number to Date. Notice that after you change the data type, your column and value set are cleared; you need to select new ones based on your new data type. Additionally, the data type determines the values that are available in the Display As field. You cannot change the data type once an attribute is created.
Note: The maximum number of characters for a character type attribute and translatable text fields is 2000 characters. Number type fields have a maximum size and precision of 22.5 (22 digits to the left of the decimal and 5 digits to the right).
Select a value for the Column to select where the attribute is stored in the database table. The column list of values only returns columns with the data type you specified in Data Type. The list of values also indicates whether or not the column is indexed.
The Enabled check box determines whether or not the attribute is enabled (and available for use) or disabled (and not available for use). By default, the Enabled check box is selected. If the attribute is enabled, specify whether or not the attribute is optional or required. If required, the user cannot save data for an object using the attribute group without entering a value for that attribute. You can always disable attributes. However, you cannot delete attributes after an attribute group has been associated with an Attribute Template or a CLM document.
Select the Read Only check box to specify whether or not the user can update the attribute value.
Select the Required check box to specify whether or not the user must enter an attribute value.
Select a value in the Display As list to determine how the attribute appears within the user interface. The available values for Display As are determined by the data type selected.
Select a Value Set that will serve as a set of constraints for an attribute.
Enter a Default Value for the attribute. If you've selected a value set, the value set's constraints apply to the default value. This value defaults upon object creation.
Note: In an attribute group with at least one required attribute, no default values are applied for any attributes when a required attribute does not have an assigned default value.
Click Apply and Add Another to save and create another attribute.
Once done, click Apply.
When you copy an attribute group, all of the attribute group's field values and attributes default to the new attribute group. You can override all defaulted values and attributes except for the attribute group Behavior field.
To copy attribute groups:
On the Attribute Setup Workbench: Attribute Groups page, search for the attribute group you want to duplicate and click the Copy icon adjacent to it.
On the Create Attribute Group page that displays, the field values from the original attribute group appear. You must enter a new Internal name and Display Name for the copied attribute group. You have the option to change all field values except for the Behavior field; you cannot change the original Single-Row, Multi-Row in the Behavior field.
Click Apply. The Attribute Details page displays. The attributes from the original attribute group are attached to the newly copied attribute group. From this page, you can edit or delete the existing attributes and add new attributes.
To define your own custom logic, you can add user-defined functions and actions to Attribute Groups without having to customize the entire page. By first setting up user-defined attributes, you can then execute user-defined functions with those attributes. You need to define functions only if you plan to have actions associated with your attribute groups.
Actions execute predefined PLSQL program units. You must write these program units, containing logic you want to execute on various events related to the attribute group, and load them to the database in apps schema. Register these program units as functions. Using different algorithms, you can calculate values by passing attribute values to functions. User-defined functions can be PL/SQL functions. Functions use input and/or output parameters of various data types such as string, integer, or Boolean. You can also map these parameters to attributes, object primary key values, and external attributes. Actions are trigger points for functions which trigger at specific events or are displayed as buttons or links on the page. You can also prompt the user based on the user's input.
To create a user-defined function:
On the Attribute Setup Workbench page, select the Functions tab.
On the Search and Select: Functions page that displays, click Create Function.
On the Attribute Setup Workbench: Functions page that displays, enter an Internal Name for the function.
Enter a Display Name. This is the name of the function as it appears in the user interface.
Enter a Description for the function.
Select the Function Type from the list. The supported function type for CLM is PL/SQL. When you select PL/SQL as the function, then you must also specify the Package in which the procedure resides and the procedure that implements your custom logic.
Note: Run the PL/SQL package in your custom schema and then create a synonym for this package in the APPS schema.
Click Apply.
To delete a user-defined function:
On the Attribute Setup Workbench page, select the Functions tab.
On the Search and Select: Functions page that displays, select the function you want to delete and click Delete.
Note: You can only delete a function when it is no longer associated with an action.
After creating a user-defined function, specify the parameters to pass when that function is called.
To create parameters for a function:
On the Attribute Setup Workbench page, select the Functions tab.
On the Search and Select: Functions page that displays, select the function for which you want to create parameters and click the Function Name.
On the Function Details page that displays, you can view the Basic Information of the Functions. This includes the Internal Name, Display Name, Description, Function Type, and the details associated with the function type.
Click Add.
On the Create Function Parameter page, enter the Internal Name of the parameter.
Note: The internal name of the parameter must match exactly (case sensitive) to the parameter name of the PLSQL procedure/function in the database.
Enter the Display Name of the parameter as it appears in the user interface.
Enter the Sequence. This is the order in which this parameter appears relative to other parameters associated with this function. Sequence must be unique among all parameters associated with this function. Specify the order sequence of the function parameters; this is the order in which the parameters are passed to a function or procedure.
Select the Data Type from the list, which contains the available data types. The values available are dependent on the type of function for which you are defining parameters.
Note: The data type of the parameter must match the data type of the corresponding PLSQL function or procedure parameter in the database.
Select the Parameter Type for each parameter based on whether the corresponding attribute is providing an input parameter to the function or expecting a return value from the function (for example, input, output, input/output). The parameter options for a parameter depend on the function type and parameter data type you have already selected.
The valid parameters for PL/SQL functions are:
Date
Error Array
Number
Varchar
Click Apply.
Using a template enables you to streamline the document creation process and is a mandatory step. There can be only one template for a given combination of Functional Area, Document Type, Document Style and Level. You can have any number of revisions to a template, however, only one of them can be active at any time. The effective dates determine whether a template revision is active or not. There can be only one revision with future effective dates. The revision number starts with 0 and increases incrementally by 1 each time you create a new revision to the template. You can work with Attribute Templates to:
To search a template:
On the Attribute Setup Workbench page, select the Attribute Templates tab.
Enter the parameters to search for a template. You can search based on any or all of the following criteria:
Template Name - the name of the template.
Functional Area - choose from Purchasing, Requisitions, or Solicitation.
Document Type - choose from Blanket Purchase Agreement, Contract Purchase Agreement, Standard Purchase Order, Solicitation, or Offer.
Document Style - Choose from the defined document styles.
Level - choose a level from Shipment, Line, or Header.
Click Go. The search results display up to 10 records. Click Next to view more search results.
To create a new template:
On the Attribute Setup Workbench page, select the Attribute Templates tab.
Click Create Template.
Enter a Template Name. Use this name to identify the template.
By default, the Functional Area is Purchasing. Creating templates is supported only for Purchasing functional area.
Note: For other functional areas such as Requisition and Solicitation, you can revise the existing predefined templates.
Select the Document Type. By default, you can only create templates for Purchasing. For Purchasing, you can select from:
Blanket Purchase Agreement
Contract Purchase Agreement
Standard Purchase Order
Select the Document Style from the list. The list displays all active document styles that have the document type enabled.
Select the Level from the list. You can select from:
Header
Line
Shipment
Optionally, select a template from the Copy Usages list. When you select a template to copy and click Continue, the application creates a new template by copying usages and actions from the selected template. The newly created template displays in update mode with a revision 0.
Enter an Effective Date. Ensure you enter only the current date or a future date.
Enter any comments.
Click Continue to create the new template.
To update a template:
On the Attribute Setup Workbench page, select the Attribute Templates tab.
Enter the parameters to search for a template. The page displays up to 10 records at a time.
Click the Template Name to view the Template. The Templates page displays the current revision of the template. The current revision is the one which is effective on the system date. If there is no current revision, then it displays the latest revision.
The Actions column displays a pencil icon denoting update, if the latest revision of the template does not have a transaction document associated with it. Click the Update icon to update the latest revision of the template. The Update Template page displays. You cannot update the Template Name, Functional Area, Document Type, Document Style, Level, and the Revision Number.
Enter an Effective From date. This is the date from which the revision is applicable.
The Effective To date is automatically displayed on the previous revision of the template when you provide an effective from date on the newer revision of the template.
Enter any comments for the template.
In the Usages section, you can view the existing Usages associated with the template. Usages denote the area on the document UI where the attribute group will display. Usage also indicates the purpose of an attribute group on a document (for example document numbering attribute group, complex pricing attribute group etc). You can also view the Context, Sequence, and Attribute Group associated with the usage.
Click the Usage Name to view the Template Usage.
Click Create Usage to add a new usage to the Template. On the Create Template Usage page that displays, select a value from the Usages list. The table below lists the Usages available in CLM.
| Usage Name | Purchasing | ||
|---|---|---|---|
| Header | Line | Shipment | |
| Document Numbering | Rendered in Document Number popup. | NA | NA |
| General Information | Rendered on Header Page | Rendered on Line Details page | Rendered on Schedule Details page |
| Addresses | Rendered on address tab. Driven by the address type lookup. | NA | NA |
| Additional Information | Rendered on address tab, not rendered on ISP | Rendered on Line details page, not rendered on ISP | NA |
| Base Document Information | Rendered on Header page, read only on Modification | NA | NA |
| Federal Forms | Rendered on address tab, dependent on Document Form | NA | NA |
| Complex Pricing | NA | Rendered on Pricing Details popup. | NA |
| Modification | Rendered on Header page only on Modificaton | NA | NA |
| Document Chaining | Rendered on Header page, attribute group data shared across Base document and all its modification | Rendered on Line Details page, attribute group data shared across Base document and all its modification | Rendered on Schedule Details page, attribute group data shared across Base document and all its modification |
| Usage Name | Requisition | |
|---|---|---|
| Header | Line | |
| Document Numbering | Rendered in Document Number popup. | NA |
| General Information | Rendered on Checkout: Requisition Information page | Rendered on Requisition Line details page |
| Addresses | Rendered on Checkout: Requisition Information page. Driven by the address type lookup. | NA |
| Additional Information | NA | NA |
| Base Document Information | NA | NA |
| Federal Forms | NA | NA |
| Complex Pricing | NA | Rendered on Pricing Details popup. |
| Modification | NA | NA |
| Document Chaining | Rendered on Checkout: Requisition Information page, attribute group data shared across Base document and all its amendments. | Rendered on Requisition line details page, attribute group data shared across Base document and all its amendments. |
| Usage Name | Solicitation | Offer | |
|---|---|---|---|
| Header | Line | Line | |
| Document Numbering | Rendered in Document Number popup. | NA | NA |
| General Information | Rendered on Header Page | Rendered on Line Details page | Rendered on line details page |
| Addresses | Rendered on address page. Driven by the address type lookup. | NA | NA |
| Additional Information | Rendered on Header page, read-only on amendment | Rendered on Line details page | NA |
| Base Document Information | NA | NA | NA |
| Federal Forms | Rendered on Header page, dependent on Document Form | NA | NA |
| Complex Pricing | NA | Rendered on Pricing Details popup. | Rendered on Pricing Details popup. |
| Modification | NA | NA | NA |
| Document Chaining | NA | NA | NA |
See: Extending CLM Attributes using Attribute Setup Workbench for more information.
Click the Actions icon to update an action on a usage. Alternatively, click Create Action to add a new action for the usage.
Enter a Sequence. This determines the order in which the attribute groups having the same usage render on the user interface.
Select an Attribute Group from the list to associate the usage to the attribute group. Click Apply.
Click the Attribute Group name to view and update the attribute group details. You can update all details except the Internal Name, and the Behavior.
To create a new revision to a template:
On the Attribute Setup Workbench page, select the Attribute Templates tab.
Enter the parameters to search for a template.
Click the Template Name to view the Template. The Templates page displays the current revision of the template. The current revision is the one which is effective on the system date. If there is no current revision, then it displays the latest revision.
The Actions column displays an icon denoting create revision if the latest revision has a transaction document associated with it. Click the Revision icon to revise the template. A warning message displays asking you to confirm that you want create a revision for the existing template. Click Yes to create a revision. The Update Template page displays with the template name and revision number for the template. You cannot update the Template Name, Functional Area, Document Type, Document Style, Level, and the Revision Number.
Enter an Effective From date. This is the date from which the revision is applicable.
The Effective To date is automatically displayed on the previous revision of the template when you provide an effective from date on the newer revision of the template.
Enter any comments for the template.
In the Usages section, you can view the existing Usages associated with the template. Usages denote the area on the document UI where the attribute group will display. Usage also indicates the purpose of an attribute group on a document (for example document numbering attribute group, complex pricing attribute group etc). You can also view the Context, Sequence, and Attribute Group associated with the usage.
Click the Usage Name to view the Template Usage.
Click Create Usage to add a new usage to the Template. On the Create Template Usage page that displays, select a value from the Usages list.
See: CLM UDA Usages - Purchasing
Click Copy Usage to copy an existing usage. On the Copy Template Usage page that displays, select the Template from which you want to copy the usage. Select the Usage you want to copy. Select the Action. You can choose from Add or Replace. By default, the Action is Replace. If you select Add, the Usages are added to the template. If you select Replace, then all existing usages are replaced by the usages you select. If you selected the Add action, then if you encounter duplicates, you can review and delete the usages you do not require, per the validation rules as follows:
The application allows only one usage for a given combination of document number usage and context (Applicable To, Owned by Issuing Org, and Operating Unit).
The application allows only one usage for a given combination of complex pricing usage and context (Applicable To, Owned by Issuing Org, and Operating Unit).
The application allows only one usage for addresses.
The application allows multiple usage entries for the same context for other types of usages but with different attribute groups and sequences.
When you click Apply, the application submits a concurrent request to compile a template, without which a template cannot be used on a document.
Click the Actions icon to update an action on a usage. Alternatively, click Create Action to add a new action for the usage.
Enter a Sequence. This determines the order in which the attribute groups having the same usage render on the user interface.
Select an Attribute Group from the list to associate the usage to the attribute group. Click Apply.
Click the Attribute Group name to view and update the attribute group details. You can update all details except the Internal Name, and the Behavior.
To associate the function as an action on a template, you can define actions.
To view, update, delete, or create actions:
On the Attribute Setup Workbench page, select the Attribute Templates tab.
Enter the parameters to search for a template. The page displays up to 10 records.
Click the Template Name to view the Template. The Templates page displays the current revision of the template. The current revision is the one which is effective on the system date. If there is no current revision, then it displays the latest revision.
Click the Update or Revision Action.
On the Update Template page, click the Actions icon to view the existing actions associated with the template. Select an Action from the list and click Update to update the action or Click Delete to delete the selected action. Click Create Action to create a new UDA action associated with the template.
On the Create Action page that displays, the Object Name, Classification, and Attribute Group display by default. You cannot update these.
Enter a Sequence to define the order in which the action must execute.
Enter an Action Name to identify the action.
Optionally, enter a Description for the action.
Select a Function you defined from the list.
In the Action Execution region, select an Execution Method from the list. This controls the type of action. You can choose from:
User Action - Renders as a button next to the Attribute Group. The action is executed whenever the user clicks on the button.
LOV Defaulting Action - Triggers when an attribute with an LOV is modified by the user.
Reference Data Refresh - This automatically triggers when saving or submitting changes.
Submission Check Action - Triggers on submitting a document for approval. Errors are displayed on the user interface.
Document Number Generation Action - Triggers when the user clicks the OK button on the document numbering popup.
Defaulting Action - Triggers when rendering the attribute group for the first time. Also triggers for non-rendered attribute groups when the document is saved for the first time.
Post Data Save Action - Triggers upon saving the document. This is meant for executing any logic you want whenever a given attribute value is altered.
Validation Action - Triggers just before saving the document. Errors are displayed on the user interface.
Price Calculation Action - Triggers from the OK and Calculate buttons in the pricing details popup.
Post Approval Action - this action triggers at the end of the approval cycle.
If you selected User Action as the Execution Method, then you need to enter some more details to define the user action. These are:
Display Style - This is optional and defines the user interface element that executes the action. The action will display as a button or link next to the attribute group on the user interface where the attribute group renders. The action is executed when the user clicks on the button or the link.
Prompt Application - This is mandatory and is the application of the prompt for the action if the prompt is defined in the database.
Prompt Message Name - This is mandatory and is the message name of the prompt if the prompt is defined in the database. Otherwise, the actual prompt. This message is the label of the button or link.
Dynamic Prompt Function - This is optional and selects an existing function whose return value will define the prompt of the action. Must have parameter of type Return, with data type String. The value returned by this function will be the button or the link label.
Dynamic Visibility Function - This is optional and selects an existing function whose value will determine whether or not the action is rendered. The button or link is displayed or hidden based on the return value of this function.
Click Apply. The Action Details page displays.
Click Update in the Basic Information region to make updates to the basic information of the action.
In the Mappings for Function section, click Update. Use this page to map the parameters for the function.
On the Create Mappings page that displays, you can view the Action and the Function. You cannot update these details.
In the Mapping table, for each Parameter Name, select the Mapping Group Type and a Mapped Attribute. You can map function parameters to attributes in the attribute group, document primary keys, external parameters as follows:
| Mapping Group Type | Mapped Attribute |
|---|---|
| Attribute Group | The list displays the attributes available within an attribute group. |
| Primary Key | The Primary Key list displays those primary keys associated with the document type. For example, for PO line level, you can select the PO Line ID and Draft ID. If you are on PO Header, then you can select PO Header ID and Draft ID. If you are on the Requisition Line, you can select Requisition Line ID. |
| External Attribute | When you select this mapping group type, the mapped attribute field changes to a free text field, and you must enter the external parameter to match exactly (case sensitive) to the parameter name in the list of external parameters available in CLM UDA. The external parameters supported are:
External parameters are certain important fields on the document which are made available to UDAs to facilitate tighter integration as well as passing error messages back to the base application. |
Click Apply.
Use the Simulate tab to simulate and test your UDA setup based on the value sets, Defaulting and LOV Defaulting Event actions.
To simulate and test your UDA attributes:
On the Attribute Setup Workbench page, select the Simulate tab.
Select the Template from this list. This is the template you created or updated and want to test.
Select a value from the Usages list. This is the usage you want to test.
Click Test to test your UDA setup based on the value sets, Defaulting and LOV Defaulting Event actions.