IBM WebSphere Multichannel Bank Transformation Toolkit, Version 7.1

Retrieving tabs, columns, rows on the Workarea

About this task

Following functions are provided to retrieve the Ids of the elements on the Workarea:
  • Function I: Get the Id of the root page.
    Using API BTTUtil.Workarea. getRootPage without parameters, the Id of the root page is returned.
    Table 1. Function I
    Input Output
    null The Id of the root page is returned.
  • Function II: Get the parent Id of one element (row, column, tab).
    Using API BTTUtil.Workarea. getParent with an Id of row, column or tab, the parent Id of the component is returned.
    Table 2. Function II
    Input Output
    P1(Id of row, column or tab) The parent Id of the component is returned.
  • Function III: Get the children Ids of one element (column, tab, page).
    Using API BTTUtil.Workarea.getChildrenIds with an Id of column, tab or page, an array containing the children Ids is returned.
    Table 3. Function III
    Input Output
    P1(Id of column, tab or page) An array containing the children Ids is returned.
  • Function IV: Get the current index of one element in the parent.
    Using API BTTUtil.Workarea.getIndex with an element ID, the index id of the element in the parent is returned.
    Table 4. Function IV
    Input Output
    P1(elemId) The index id of the element in the parent is returned.
  • Function V: Search rows by attribute value, and get the Ids of the service instances which have the required value of a specified attribute.
    Using API BTTUtil.Workarea.getRowIdsByAttributeValue with an attribute object, an array containing the Ids of the service instances is returned.
    Table 5. Function V
    Input Output
    P1(attribute object) An array containing the Ids of the service instances is returned.
  • Function VI: Get current active tab.
    Using API BTTUtil.Workarea. getActiveTab without parameters, the active tab id is returned.
    Table 6. Function VI
    Input Output
    null The active tab id is returned.
  • Function VII: Get the IScope objects of the service instances by row Id, and get the attributes of the service instances
    Using API BTTUtil.Workarea.getIScope with a row Id parameter, the IScope object of the service instance corresponding to the row is returned.
    Table 7. Function VII
    Input Output
    P1(row Id) The IScope object of the service instance corresponding to the row is returned.
  • Function VIII: Expand a row on the Workarea.
    Using API BTTUtil.Workarea.expandRow with a row Id, the corresponding row is expanded.
    Table 8. Function VIII
    Input Output
    P1 (row Id) The corresponding row is expanded.
  • Function IX: Collapse a row on the Workarea.
    Using API BTTUtil.Workarea.collapseRow with a row Id, the corresponding row is collapsed.
    Table 9. Function IX
    Input Output
    P1 (row Id) The corresponding row is collapsed.
  • Function X: Highlight the nodes on the service list.

    Using API BTTUtil.Workarea.markNode with a note Id parameter, the corresponding service category node is highlighted.

    Using API BTTUtil.Workarea.markNode with a note Id parameter and a color parameter, the corresponding service category node is highlight with the specified color.
    Table 10. Function X
    Input Output
    P1(node Id) The corresponding service category node is collapsed.
    P1(node Id), P2(color) The corresponding service category node is highlight with the speficified color.
  • Function XI: Remove the highlight of nodes on the service list.
    Using API BTTUtil.Workarea.unmarkAllNodes without parameters, all the nodes on the service list are unmarked.
    Table 11. Function XI
    Input Output
    null All the nodes on the service list are unmarked.


Feedback