Creating custom artifact elements

Edit online

View authors can use custom artifact elements (CAEs) to build views. Custom artifact elements gather artifacts of a specific type based on a SQL query, and are used to show artifacts in view containers. In the editor you define or modify the SQL query, conditions, and link relationships with other artifacts.

Before you begin

  • By default, only administrators create, modify, or delete custom artifact elements. For permission requests, contact your administrator.
  • The product comes with a set of predefined custom artifact elements that view authors can use when they build a view. You can modify the predefined custom artifact elements for your project. If you want to learn how to create custom artifact elements, use the predefined ones as examples.

    Go to Views > Browse custom artifact elements to work with the predefined custom artifact elements that are organized in folders by engineering discipline. In the view editor, the custom artifact elements are in the palette. If the custom artifact elements are missing, ask your administrator to deploy the content packages that are available on the application administration Contents page.

  • Sorting of CAEs is not supported.

About this task

When you create a custom artifact element, it becomes available on the palette in the view editor. View authors can use the new custom artifact element for creating views. The new custom artifact element also appears available in list at Views > Browse custom artifact elements.

Procedure

  1. Create a folder for the new custom artifact element.
    1. In the main menu, go to Views > Browse custom artifact elements, and click Create folder in the page.
    2. Name your folder My custom artifact elements, and click Create. The Create option appears if you click outside the name field. The Create custom artifact element action is added for the CAE folder. On hovering over the selected CAE folder, the Create custom artifact element action is displayed.
    3. Click Create custom artifact element to create the CAE in the selected folder. All the artifacts and folders within the CAE folder are selected.
  2. To create a new custom artifact element, select the values from Initial data for custom artifact element window.
  3. In the Limit the scope field, select the project areas that you want to add in custom artifact element.
  4. In the Choose an artifact field, select the artifact elements.
  5. In the Set conditions field add conditions to the custom artifact elements. Click OK to create the artifact element.
  6. Identify your custom artifact element.
    1. Name your custom artifact element My Work Item.
    2. Enter the ID my_work_item.
  7. In the Save to window, select the My custom artifact elements folder that you created at the beginning of this procedure.
  8. Click Preview to test the custom artifact element.
  9. Optional: To browse the custom artifact elements from the main menu, go to Views > Browse custom artifact elements.

What to do next

View authors can use the new custom artifact element when they create views.