com.tibco.wcc.schema.showEvents

This topic describes the data passed in the payload for PageBus event, com.tibco.wcc.schema.showEvents.

The event message for this schema comes in two formats, denoted by a version number in the schemaVersion property:

  • schemaVersion=1: This defines the format of the data passed in the showEvents event message when the event is published by a WCC component (Process Instances, Work Items, Organization Browser, and Organization Resource List). This event format can be captured and used as needed.
  • schemaVersion=2: This defines the format of the showEvents PageBus event that can be published by an external application. This version of the showEvents event message format is handled by the WCC Event Views component to create a temporary event view and display it in a WCC Event Viewer component.

Data in the PageBus event — schemaVersion=1:

topic: The PageBus topic for the event -- see Non-WCC Components Publishing Events.
topic: "com.tibco.wcc.order.wccPrototype.wccWorkItems.showEvents"
message: schemaId = "com.tibco.wcc.schema.showEvents"
         scope = "public"
         schemaVersion = Indicates whether the event is being published by a WCC
             component or by an external application -- see description above.
         view = Name of the event view being created.
         descriptionType = "detail" or "summary". These are defined in the
             appropriate eventDescriptions.xml file. See the Configuring Events
             chapter in the Workspace Configuration and Customization guide.
         filterId = The ID of the <filter/> element that is used to initially
             populate the event list when the view is selected.
         eventImage = Image displayed for view in the event view list.
         eventNode = Defines the item (work item, process instance, etc.) selected
             when the show events function is initiated.
         eventLinkNode = Defines the event view created by the selected show events
             drop-down menu selected. See associated <link/> record in
             eventLinks.xml.
         viewType = Always "context" to denote the new event view is in the context
             of the item (work item, process instance, etc.) selected when the show
             events function is initiated.
         ids = (Only appears in message for show events from the process instance
             list.) An array containing the ID of the process instance selected when
             the show events function is initiated.

Example:

topic: "com.tibco.wcc.order.wccPrototype.wccProcessInstances.showEvents"
message: schemaId = "com.tibco.wcc.schema.showEvents"
         scope = "public"
         schemaVersion = "1"
         view = "SalesCallbackProcess instances"
         descriptionType = "summary"
         filterId = "All"
         eventImage = "JSXAPPS/base/application/images/ProcessTemplate.gif"
         eventNode = "<record jsxid="id0x0937e1a0" jsxtext="" jsximg=""
             StatusImage="JSXAPPS/base/application/images/ProcessInstanceActive.gif             " INSTANCE.VERSION="1.0.0.201005251718"
             INSTANCE.NAME="SalesCallbackProcess"
                .
                .
                .
         eventLinkNode = "<record jsximg="JSXAPPS/base/application/images/
             ProcessTemplate.gif" descriptionType="summary" defaultFilterId="All"              jsxtext="Instances of this process" jsxexecute="this.getAncestorOfType
             ('com.tibco.wcc.base.ListContainer').showEventViewer(this.getRecordNod             e(this.getValue()))" name="{INSTANCE.NAME} instances"
                .
                .
                .
         viewType = "context"
         ids = [
                  "pvm:0a123"
               ]

Data in the PageBus event — schemaVersion=2:

topic: The PageBus topic for the event -- see Non-WCC Components Publishing Events.
topic: "com.tibco.wcc.order.wccPrototype.wccWorkItems.showEvents"
message: schemaId = "com.tibco.wcc.schema.showEvents"
         scope = "public"
         schemaVersion = Indicates whether the event is being published by a WCC
             component or by an external application -- see description above.
         eventLinkId = The <links/> element messageId, which defines the contextual
             or event link to add. These are defined in eventLink.xml. For example:              <links messageId="WorkItem_WorkspaceContext">.
         substitutionDataXml = The XML containing the attributes that are
             substituted into the <link/> element that is used. The root element
             name is record: <record att1="val1" att2="val2"/>
         menuText = If there are multiple <link/> elements, the menuText value is
             used to locate a specific one. If null, the first link is used.
         eventLinkXml = The XML that defines the event links. If this is null, the
             application-configured eventLinks XML is used.

Example:

topic: "com.tibco.wcc.order.wccPrototype.wccProcessInstances.showEvents"
message: schemaId = "com.tibco.wcc.schema.showEvents"
         scope = "public"
         schemaVersion = "2"
         eventLinkId = "WorkItem_WorkspaceContext"
         substitutionDataXml = "<record ActivityID="pvm:001i8"
              AppInstance="pvm:0a121" AppName="CSCallbackProcess" ID="2"
              Name="ManagerReview"/>"
         menuText = "My activity for this work item"
         eventLinkXml = ""