Copyright © Cloud Software Group, Inc. All Rights Reserved

Composites

The composite components combine more than one component into a single component to provide an easy way to display multiple lists or elements without the need to add multiple components to your application, or to set up the events between those components — the events between the components provided in the composites are already configured.

The following are the composite components available:

•	CasesPreview - composite of the case list component (see Cases) and the preview pane

•	ProcsCases - composite of the procedure list component (StartHistoryProcs) — see Procedures) and the case list component (see Cases)

•	WorkItemsPreview - composite of the work item list component (see WorkItems) and the preview pane

•	WorkQsItems - composite of the work queue list component (see UserWorkQs) and the work item list component (see WorkItems)

Composite Properties

The composite components do not have properties that can be configured in the Properties Editor. Displaying the Properties Editor for a composite shows that it does not have its own properties:

To configure access to the functions available from each component in a composite, you must drill down to the desired component under the composite in the Component Hierarchy, then configure the appropriate property.

Composite Events

When configuring events for a composite component, the composite component itself should subscribe to events, not the components that are included in the composite.

For example, the ProcsCases composite component needs to subscribe to an event to cause it to display, as follows:

Note that you cannot drill down to the composite’s underlying components in the Component Hierarchy and set up event subscriptions for those components because the Event tab for the underlying components is disabled (although other components may want to subscribe to the events published by the underlying components).

CasesPreview

The CasesPreview component is a composite of the case list component ( Cases) and the preview pane. (This is considered a composite, although technically it does not comprise two components that you can see in the Component Hierarchy; in this context, the preview pane is considered a component.)

When a case is selected (single click) in the case list displayed by this component, the case summary is displayed in the preview pane. When a case is opened (double click, or select the Open Case function), the case detail tabs are displayed in the preview pane. For example:

The case detail tabs displayed are the same tabs that can be displayed using the CaseDetail component (see CaseDetail). The example illustrated above shows all four available tabs, although they may not all display, depending on the user’s access privileges.

The case list that is displayed using the CasesPreview component also contains the Preview icon, as well as the Preview menu selections on the View menu to allow you to display the case details in a floating window. (Note that the Cases component, which also displays the case list, always opens the case details in a floating window.)

Required Data

The CasesPreview component requires a procedure tag to be able to be displayed.

Subscribe to: HistoryProcs, NodeProcs, StartHistoryProcs, or StartProcs component:

−	List Item Select (single click) event

−	List Item Execute (double click) event

CasesPreview Component Properties

None — composite components do not have their own properties. To set the properties for the individual components that are part of the composite, click on the underlying component in the Component Hierarchy, then use the Properties Editor to set access for functions provided by that component.

For information about the properties available for the components included with CasesPreview, see:

•	Cases Component Properties

The Cases component is the only underlying component in CasesPreview. The case details that appear in the preview pane are not shown as a component in the Component Hierarchy. Therefore, you cannot separately configure access to the functions on the case details alone. When you configure access to functions using the properties on the Cases component under the CasesPreview component, you are configuring access to the functions on both the case list and the case details.

CasesPreview Component Events

None — composite components do not publish events themselves, although the individual components that comprise the composite publish events. Therefore, other components cannot subscribe to events of a composite, but they can subscribe to events of the underlying components.

For information about the events published by the components included with CasesPreview, see:

•	Cases Component Events

Note that the Cases component events include the events published by case detail tabs displayed when a case is opened from the case list.

ProcsCases

The ProcsCases component is a composite of the following two components:

−	StartHistoryProcs (see Procedures)

−	Cases (see Cases) (note that when using the ProcsCases component, the case list is always displayed with the preview pane; it appears the same as the CasesPreview component, but is actually the Cases component)

This composite component:

•	displays the procedure list — by default, the procedure list contains all procedures for which the user has start and history access (it uses the StartHistoryProcs component)

•	displays the case list when the user clicks on a procedure in the procedure list — by default, the case list subscribes to the “List Item Select (single click)” event on the StartHistoryProcs component, causing the case list to appear upon a single click of a procedure

•	displays the case summary in the preview pane when a case is selected (single click) from the case list

•	displays the case details in the preview pane when a case is opened (double click) from the case list

The ProcsCases component appears as follows:

Required Data

The ProcsCases component does not need data to render, although there must have been a previous login because it needs a valid user and server name.

ProcsCases Component Properties

None — composite components do not have their own properties. To set the properties for the individual components that are part of the composite, click on the appropriate component in the Component Hierarchy, then use the Properties Editor to set access for functions provided by that component.

For information about the properties available for the components included with ProcsCases, see:

•	Procs Component Properties

•	Cases Component Properties

ProcsCases Component Events

None — composite components do not publish events themselves, although the individual components that comprise the composite publish events. Therefore, other components cannot subscribe to events of a composite, but they can subscribe to events of the underlying components.

For information about the events published by the components included with ProcsCases, see:

•	Procs Component Events [note that the events published by the StartHistoryProcs component are described in the Procs component section]

•	Cases Component Events

WorkItemsPreview

The WorkItemsPreview component is a composite of the work item list component ( WorkItems) and the preview pane. (This is considered a composite, although technically it does not comprise two components that you can see in the Component Hierarchy.)

When a work item is selected (by single clicking) in the work item list displayed by this component, the work item summary is displayed in the preview pane. When a work item is opened (by double clicking, or selecting the Open Selected Work Items function), the work item form is displayed in the preview pane.

This differs from using just the WorkItems component, in that with the WorkItems component a work item summary is not displayed, and the work item form is always displayed in a floating window.

Work item forms will appear in the preview pane only if they were developed using TIBCO® General Interface. Non-General Interface forms always appear in a floating window.

The WorkItemsPreview component displays the work item list, followed by the preview pane:

The work item list Filter dialog may be displayed instead of the work item list if the number of work items in the work queue exceeds a specified threshold. For more information, see WorkItems.

The work item list that is displayed using the WorkItemsPreview component also contains the Preview icon, as well as the Preview menu selections on the View menu to allow you to display the work item form in a floating window. (Note that the WorkItems component, which also displays the work item list, only opens the work item form in a floating window.)

Required Data

The WorkItemsPreview component requires a work queue tag to be able to be displayed.

Subscribe to: UserWorkQs component:

−	List Item Select (single click) event

−	List Item Execute (double click) event

WorkItemsPreview Component Properties

None — composite components do not have their own properties. To set the properties for the individual components that are part of the composite, click on the underlying component in the Component Hierarchy, then use the Properties Editor to set access for functions provided by that component.

For information about the properties available for the components included with WorkItemsPreview, see:

•	WorkItems Component Properties

WorkItemsPreview Component Events

None — composite components do not publish events themselves, although the individual components that comprise the composite publish events. Therefore, other components cannot subscribe to events of a composite, but they can subscribe to events of the underlying components. For more information, see TIBCO iProcess Workspace (Browser) Components Concepts guide.

For information about the events published by the components included with WorkItemsPreview, see:

•	WorkItems Component Events

WorkQsItems

The WorkQsItems component is a composite of the following two components:

−	UserWorkQs (see UserWorkQs)

−	WorkItems (see WorkItems) (note that when using the WorkQsItems component, the work item list is always displayed with the preview pane; it appears the same as the WorkItemsPreview component, but is actually the WorkItems component)

This composite component:

•	displays the work queue list in a pane to the left of a vertical slider

•	displays the work item list in the upper right part of the window — by default, the WorkItems component subscribes to the “List Item Select (single click)” event on the UserWorkQs component, causing the work item list to appear upon a single click of a work queue.

•	displays the work item summary in the preview pane when a work item is selected from the work item list

•	displays the work item form in the preview pane when a work item is opened from the work item list

The WorkQsItems component appears as follows:

The work item list Filter dialog may be displayed instead of the work item list if the number of work items in the selected work queue exceeds a specified threshold. For more information, see WorkItems.

Required Data

The WorkQsItems component does not need data to render, although there must have been a previous login because it needs a valid user and server name.

WorkQsItems Component Properties

None — composite components do not have their own properties. To set the properties for the underlying components that are part of the composite, click on the appropriate component in the Component Hierarchy, then use the Properties Editor to set access for functions provided by that component.

For information about the properties available for the components included with WorkQsItems, see:

•	UserWorkQs Component Properties

•	WorkItems Component Properties

WorkQsItems Component Events

None — composite components do not publish events themselves, although the individual components that comprise the composite publish events. Therefore, other components cannot subscribe to events of a composite, but they can subscribe to events of the underlying components.

For information about the events published by the components included with WorkQsItems, see:

•	UserWorkQs Component Events

•	WorkItems Component Events

 

Copyright © Cloud Software Group, Inc. All Rights Reserved