Display Parts may be used to create custom child record listings to augment or replace the standard child record listings provided by CATSWeb. The listings are fully configurable, and can automatically enforce Record Access Restrictions. Most listings can be created via point-and-click configuration. The example below shows how to create a custom Subtask listing for Actions. The same technique may be used to create custom Issue listings for Actions, or any arbitrary child record listing.

Example - Custom Subtask Listings for Actions

To create a custom Subtask listing for Action forms, follow these steps:

• Open a new Subtask query form, using your preferred Subtask form (your choice of Subtask form determines the field captions that will be used to label the output columns).
• Enter an arbitrary value such as "-999" for the Parent ID parameter. Or if the Parent ID is not present on your query form, enter a "*" in any parameter field.
• Check the field select boxes for the fields that you wish to appear in the listing.
• Specify your desired Output Ordering parameters.
• Save the query publicly using any name you wish (ex: "Child Subtask List Query").

Step 2 - Create a Data Display Part

• From the Manage page, click Display Parts in the Form and Workflow Design section.
• In the Add Subcomponent Type list, select Display Part - Data. Click Add.
• Enter the following information in the Display Part - Data form:
  • Display Part Name - Enter any name (ex: "Child Subtask List").
  • Title - Enter any title, such as "Subtasks".
  • Data Source Type - Select the Subtask Query option and click the iconic reload button.
  • Subtask Query - Select the name of the Subtask Query that you created in the first step.
  • Query Parameter Replacements - Enter "ParentID=ActionID". This tells the Display Part that it should replace the Parent ID query parameter value (if any) with the Action ID value of the Action record that is displaying the Display Part.
• Click Submit to create the Display Part.

Step 3 - Add the Display Part to the Action Form

• From the Manage page, click Action Forms in the Form and Workflow Design section.
• Click the name (Category) of the Action form that will contain the custom subtask list. The Edit Category page will appear.
• There are two ways to add the Display Part to the Action form.
  1. The standard method.
     Scroll down to the Child Subforms section. Click Add.
     Enter the following information:
     • Child Subform Type - Select the Display Part option and click the iconic reload button.
     • Display Part - Select the Display Part that you created in Step 2.
     • Order - Specify an arbitrary order value.
     • If your CATSWeb system includes the Record Archiving option, an Availability setting will be present. Leave this at the default option of Live View.
     • Click Submit to create the new Child Subform.
  2. Using a Fixed Text Area.
     Display Parts are designed to be used in the View mode of the form. They may function in Add or Edit mode, and may function as Fixed Text Areas in other form types, but these usages are not supported by AssurX.
     • To insert a Display Part into a Fixed Text Area, open the Field Definition form and specify a token like this as the Text value:
       
       {Display Part: Child Records}
       
       Check the Visible on View box and uncheck Visible on Add and Visible on Edit. You may wish to adjust the Background Color, Horizontal Alignment and Vertical Alignment for best aesthetics.
       
       See Using Display Parts in Issue/Action/Subtask Forms for additional considerations.
       

Test your new custom subtask listing by browsing to an Action record that uses this form. The Display Part will be present and will only list the Subtask records for that Action record. If you wish, you may choose to disable the standard subtask listing for the Action form by unchecking the Standard Subtask Listing setting on the Action form's category edit page.

Back to Top

Extending the Solution - Custom Archived Subtasks Listing

If your CATSWeb system includes the Record Archiving option, your Action form will still use the standard Archived Subtasks listing when viewing an archived Action (or will have no Archived Subtasks listing at all, if you chose to uncheck the Standard Subtask Listing box for the form). You may wish to create a custom Archived Subtasks listing. To do this:

• Assure that the Archive Querying option is installed. If the subtask query form includes an Archived Subtasks selection in the Select From list, this option is installed.
• Use the process in Step 1 above to create a second public subtask query. In this query, select Archived Subtasks in the Select From list, and be sure to check the field select box for Archive ID.
• Use the process in Step 2 above to create a second Data Display Part. Choose the new archive query in this Display Part, and enter the same Query Parameter Replacements value.
• Use the process in Step 3 to add the new Display Part to the Action form. But this time, choose the Archived View option for the Availability value.

Test your new custom archived subtasks listing by navigating to an Action record that has been edited, and has child subtasks that have been edited. Click View Edit History, then click on one of the archived instances of the Action. Your new Display Part will be present and will list the archived Subtasks for the Action.

Back to Top