Creating Custom Display Parts
Manager Contents
User Contents

Contents

Introduction and Overview
Data Link Parameter Usage

Introduction and Overview

CATSWeb Display Parts and Dashboards enable configurable content to be created and used in various locations in the CATSWeb system. Administrators may wish to create custom Display Parts with special content that extends beyond the capabilities of standard Display Part types. Typical applications include:

  • Incorporating content from Business Intelligence and Reporting systems.
  • Creating Dynamic Display Parts that adapt their content in real-time based on user identity and data inside and outside the CATSWeb system.
  • Including user interface elements from other Web-based systems, allowing CATSWeb to serve as a portal to, or proxy for, these applications.
  • Adding video, Flash or script-based content to the system.

CATSWeb provides for custom Display Part creation via its ActiveX DLL (COM) and Web Service Data Links. The process is straightforward, especially for administrators who have worked with Event Hooks:

  • Implement an ActiveX DLL (COM object), Web Service or Web Service Provider that generates the custom HTML for the Display Part.
  • Return the HTML to CATSWeb in a colHTML collection item named "!BODY!" (CWEB_HTML_BODY$). Note that this is the same technique used to return custom HTML for Drill Down Results.
  • Create a Data Link that points to the DLL, Web Service or Web Service Provider.
  • Create a Data Display Part, choose Data Link as the Data Source, and select your Data Link from the prior step.

The custom Display Part is now ready for use.

Back to Top

Data Link Parameter Usage

CATSWeb passes the Data Link implementation the traditional set of parameters as described here, with the following clarifications and exceptions:

  • rsRecord - In all usage scenarios, this is the Display Part configuration record (Subcomponent record). The name of the Display Part, optional parameters, etc. are available here.
  • rsParams - When the Display Part is being generated for use in a Dashboard or for a full page view (regardless of original location), rsParams will be Nothing unless a Secondary Data Source was specified in the Display Part configuration record. When the Display Part is being generated for use in an Issue/Action/Subtask view page, whether in a Fixed Text Area or as a Child Subform, rsParams will be a copy of the Issue, Action or Subtask record. The Secondary Data Source from the Display Part configuration record (if any) will be ignored.
  • colHTML - When the Display Part is being generated for use in an Issue/Action/Subtask view page, whether in a Fixed Text Area or as a Child Subform, this collection will contain the following additional named items:
    • Category (CWEB_FLD_CATEGORY$) - The Category ("form name") value for the Issue, Action or Subtask record.
    • RecordType (CWEB_FLD_RECTYPE$) - The string equivalent CWEB_RECTYPE_ value for the Issue, Action or Subtask record.

      The following value is only present if the Display Part is contained in a Fixed Text Area (not present if being generated as a Child Subform):
      • TableField (CWEB_FLD_TABLE_FIELD$) - The Table Field name of the Fixed Text Area that is containing the Display Part.

Back to Top