Adding a Discovery gadget to a customized user interface

A Discovery gadget enables users to view limited information about selected cases that they do not have Read authority to access. You can include the section rule for a Discovery gadget in any section of your user interface, such as in the layout of a customized search gadget, or above a list control that is populated by a report definition.

Note: For an end user to see a list of discoverable instances, you must have access control policies defined, and the pyIsDiscoveryEnabledForOperator Access When rule must evaluate to true. For more information, see Creating an Access Control Policy and Enabling discovery features for access control policies.
  1. In Designer Studio, open the Application Explorer.
  2. Navigate to and open the user interface that you want to add the Discovery gadget to.
  3. Click Layout > Section, and drag the section into the section where you want to add the Discovery gadget.
  4. If you are adding the Discovery gadget to a list control, complete the following steps.
    1. In the Section field, enter pxDiscoverableItems.
      The pxDiscoverableItems section is defined in the @baseclass class so you can include this section in any section.

      The pxDiscoverableItems section shows only records that have the condition NotReadAndDiscover .

    2. Click the Gear icon to configure the input parameters.
    3. On the Parameters tab, select the source of the discoverable instances.
      • Report Definition – Specify the Applies To class and the name of the report definition rule. When a report definition is the source, the columns in the report are replaced with the columns that you specify in the pyDefaultDiscoverableReport report definition rule. When the report runs, the corresponding results are displayed. The report definition name overwrites the default column source in the pyDefaultDiscoverableReport report definition rule.
      • Virtual RD Page – Enter the name of the virtual report definition page. When a virtual report definition page is the source, the columns in the report are replaced with the columns from the pyDefaultDiscoverableReport report definition rule to display discoverable instances.
      • Property Reference – Specify the property reference. When a property reference is the source, the columns in the report are replaced with the columns from pyDefaultDiscoverableReport to display discoverable instances.
    4. Select the Show discoverable items count check box.
    5. Click Submit.
  5. If you are adding the Discovery gadget to a search gadget, complete the following steps.
    1. In the Section field, enter pxDiscoverableSearchItems.
      The pxDiscoverableSearchItems section is defined in the @baseclass class, so you can include this section in any section.
    2. Click the Gear icon to configure the input parameters.
    3. On the Parameters tab, select the source of the discoverable instances.
      • Report Definition – Specify the following information:
        • In the Applies To field, enter Work-.
        • In the RD name field, enter pyWorkSearch.
      • Virtual RD Page – Enter the name of the virtual report definition page.
      • Property Reference – Specify the property reference that you want to use to store the virtual report definition page name.
    4. For the Search String, Case Type List, Include Attachments, Type Of Work, and Updated On fields, refer to the clipboard page that is used as the source for the values to enter.
    5. Click Submit and save your changes.
    6. Optional: If All Of or One Of attributes are used in the policy conditions, you must add all the properties that are used as column sources in the Custom Search Properties.
      1. Click Designer Studio > System > Settings > Search.
      2. For the All work index type, click Re-index.
      3. Select the Only Classes listed below radio button, and specify the work classes to reindex.
      4. Click OK.
      5. Click Submit.
      6. In the Records Explorer, clickSysAdmin > Custom Search Properties.
      7. Click +Create.
      8. Enter a short description and a class name, and click Create and open.
      9. Click the Gear icon for the property.
      10. In the Selected Properties section of the Property Configurations dialog box, select properties to add.
      11. Click Submit.
      12. Expand the property list, and select the properties to include in search.
      13. Click Save.
  6. Save your changes.