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:

• Search for Attribute Templates

• Create new Attribute Templates

• Update Attribute Templates

• Revise Attribute Templates

• View and Create Actions for Attribute Templates

Searching for Attribute Templates

To search a template:

1. On the Attribute Setup Workbench page, select the Attribute Templates tab.

2. 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.

3. Click Go. The search results display up to 10 records. Click Next to view more search results.

Creating a New Attribute Template

To create a new template:

1. On the Attribute Setup Workbench page, select the Attribute Templates tab.

2. Click Create Template.

3. Enter a Template Name. Use this name to identify the template.

4. 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.

5. 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

6. Select the Document Style from the list. The list displays all active document styles that have the document type enabled.

7. Select the Level from the list. You can select from:

   • Header

   • Line

   • Shipment

8. 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.

9. Enter an Effective Date. Ensure you enter only the current date or a future date.

10. Enter any comments.

11. Click Continue to create the new template.

Updating an Attribute Template

To update a template:

1. On the Attribute Setup Workbench page, select the Attribute Templates tab.

2. Enter the parameters to search for a template. The page displays up to 10 records at a time.

3. 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.

4. 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.

5. Enter an Effective From date. This is the date from which the revision is applicable.

6. 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.

7. Enter any comments for the template.

8. 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.

9. Click the Usage Name to view the Template Usage.

10. 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.

    CLM UDA Usages - Purchasing

    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

    CLM UDA Usages - Requisition

    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.

    CLM UDA Usages - Sourcing

    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 chapter for more information.

11. Click the Actions icon to update an action on a usage. Alternatively, click Create Action to add a new action for the usage.

    See: View and Create Actions for Templates

12. Enter a Sequence. This determines the order in which the attribute groups having the same usage render on the user interface.

13. Select an Attribute Group from the list to associate the usage to the attribute group. Click Apply.

14. 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.

    See: Creating Attribute Groups

Creating a New Revision to an Existing Attribute Template

To create a new revision to a template:

1. On the Attribute Setup Workbench page, select the Attribute Templates tab.

2. Enter the parameters to search for a template.

3. 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.

4. 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.

5. Enter an Effective From date. This is the date from which the revision is applicable.

6. 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.

7. Enter any comments for the template.

8. 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.

9. Click the Usage Name to view the Template Usage.

10. 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

    See: CLM UDA Usages - Requisition

    See: CLM UDA Usages - Sourcing

11. 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.

12. Click the Actions icon to update an action on a usage. Alternatively, click Create Action to add a new action for the usage.

    See: View and Create Actions for Templates

13. Enter a Sequence. This determines the order in which the attribute groups having the same usage render on the user interface.

14. Select an Attribute Group from the list to associate the usage to the attribute group. Click Apply.

15. 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.

    See: Creating Attribute Groups

Viewing and Creating Actions for Attribute Templates

To associate the function as an action on a template, you can define actions.

To view, update, delete, or create actions:

1. On the Attribute Setup Workbench page, select the Attribute Templates tab.

2. Enter the parameters to search for a template. The page displays up to 10 records.

3. 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.

4. Click the Update or Revision Action.

5. 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.

6. On the Create Action page that displays, the Object Name, Classification, and Attribute Group display by default. You cannot update these.

7. Enter a Sequence to define the order in which the action must execute.

8. Enter an Action Name to identify the action.

9. Optionally, enter a Description for the action.

10. Select a Function you defined from the list.

11. 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.

12. 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.

13. Click Apply. The Action Details page displays.

14. Click Update in the Basic Information region to make updates to the basic information of the action.

15. In the Mappings for Function section, click Update. Use this page to map the parameters for the function.

16. On the Create Mappings page that displays, you can view the Action and the Function. You cannot update these details.

17. 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: x_msg_data - use this external parameter for validation check functions and submission check functions x_msg_count - use this external parameter for validation check functions and submission check functions x_errorcode - use this external parameter for validation check functions and submission check functions x_return_status - use this external parameter for validation check functions and submission check functions VENDOR_CONTACT_ID - use this external parameter to pass vendor contact to the associated function VENDOR_SITE_ID - use this external parameter to pass the vendor site to the associated function. VENDOR_ID - use this external parameter to pass the vendor to the associated function. ITEM_ID - use this external parameter to pass the item description to the associated function. LINE_TYPE_ID - use this external parameter to pass the line type to the associated function. SHIP_TO_LOC_ID - use this external parameter to pass the ship-to location to the associated function. ORG_ID - use this external parameter to pass the organization description to the associated function. AGENT_ID - use this external parameter to pass the agent description to the associated function. CONTRACT_TYPE - use this external parameter to pass the contract type to the associated function. CATEGORY_ID - use this external parameter to pass the category description to the associated function. PREPARER_ID - use this external parameter to pass the preparer description to the associated function. 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.

18. Click Apply.