Organization Chart Subrecord Definitions
This section describes the following organization chart subrecord definitions:
-
PTORGNODE_SBR
-
PTORGGPOPUP_SBR
-
PTORGCRMB_SBR
-
PTORGBOXLST_SBR
-
PTORGBOXFLD_SBR
-
PTORGIM_SBR
-
PTNODE_DISP_SBR
PTORGNODE_SBR
This table describes the fields in PTORGNODE_SBR:
| Field | Description |
|---|---|
|
PTCHART_NODE |
Specifies the node name. This is a key field. |
|
PTPARENT_CHART_ND |
Specifies the parent of the current chart node. This is a key field. If a node does not have a parent node defined, then the node is placed on the first level. |
|
PTND_DISPLAY_ORDER |
Specifies the display order of the sibling nodes for the same parent node. Nodes display left to right according to display order. By default, the nodes are ordered as they appear in the rowset. |
|
PTCONNECTLINESTYLE |
Specifies the style class name for connection line style. The default style class is PT_ORGCHART_CONNECT1. |
|
PTNDMAINICON_IMAGE |
Specifies the main icon image name for the node. |
|
PTNODESTYLENAME |
Specifies the style class name for the node to control node background color, border, style, and so on. The default style class is PT_ORGNODE. |
|
PTFOCUS_FLAG |
Specifies a focused node (that is, the node that has focus). Y – Focused node. N – Not a focused node. If more than one node is set to focused, only the first focused node in the rowset will be recognized as the focused node. The default is “N”. |
|
PARENT_FLAG |
Indicates whether a node is a parent. Y – The node is a parent and its direct children are already loaded into the rowset. X – The node is a parent and its direct children are not loaded in the rowset (that is, they will be loaded on demand). N – The node is not a parent. The default value is “N”. An expanded/collapsed icon is only displayed on the parent node. If your PeopleCode does not set the CollapsedImage and ExpandedImage properties of the organization chart, no expanded/collapsed icon is displayed on any of the nodes and all expand/collapse actions are disabled. |
|
EXPANDED_FLAG |
Indicates whether the node is expanded or collapsed. Y – The chart shows the node expanded with the expanded image icon and its immediate children displayed. N – The chart shows the node collapsed with the collapsed image icon. |
|
DISPLAYED_FLAG |
Specifies whether the node displays in the chart. Y – The node displays
if the parent node's N – This node and its child nodes do not display in the chart's display area. The default is “Y”. |
|
PTHASPOPUP_FLAG |
Indicates whether the node has a pop-up. Y – This node has a link that invokes a pop-up and the data for the pop-up is already loaded into the pop-up node rowset. X – This node has a link that invokes a pop-up and the data for the pop-up is not loaded in the rowset. The data will be loaded on demand. N – This node does not have a link to invoke a pop-up chart. The default value is “N”. |
|
PTPOPUPEXPAND_FLAG |
Indicates whether a node’s pop-up nodes display. Y – Pop-up nodes display. N – No pop-up nodes display. If the user clicks the close icon in the pop-up node, the FieldChange event for PTPOPUPEXPAND_FLAG executes. The application sets the value of PTPOPUPEXPAND_FLAG to “N” when the pop-up node is closed. |
|
PTNODE_DESCRn |
Specifies the text for descriptorn of the node, where n is an integer that starts at 1 and increments by one for each descriptor used by the chart; for example, PTNODE_DESCR2. The PTORGNODE_SBR subrecord is delivered with fields for descriptors 1 – 7. If you need more than seven descriptors, add a set of descriptor fields (PTNODE_DESCRn, PTNDDESCnLINKABLE, PTDESCRn_ICON_IMG, and PTDESCRn_ICON_POS) for each additional descriptor, to a maximum of 99 descriptors. If this is an icon-only descriptor (PTNDDESCnLINKABLE = “I” or “O”), the text in this field is used as the data hint for the icon. The maximum length is 50 characters. |
|
PTNDDESCnLINKABLE |
Specifies the descriptor type for descriptor n, where n is an integer from 1 to 99; for example, PTNDDESC2LINKABLE. Y - Linkable text N - Static text I - Linkable Icon O - Icon only A -Related action menu D - Linkable drop-down menu R - Read-only (non-linkable) drop-down menu L - Linkable drop-down list box M - IM icon The default value is “N”. The value in this field is overridden by the node display template, if one is implemented. |
|
PTDESCRn_ICON_IMG |
Specifies the name of the image associated with descriptor n, where n is an integer from 1 to 99; for example, PTDESCR2_ICON_IMG. For icon-only descriptors ("I" or "O"), the text in PTNODE_DESCRn is the data hint text. Note: If PTDESCRn_ICON_IMG is set to a valid image, the image is only displayed if PTNDDESCnLINKABLE is set to “Y”, “N”, “I”, or “O”.. |
|
PTDESCRn_ICON_POS |
Indicates the position of the icon relative to descriptor n, where n is an integer from 1 to 7; for example, PTDESCR2_ICON_POS. L – To the left of the description. R – To the right of the description. The default value is based on user language. For instance, “L” for English and “R” for Hebrew. |
|
PTADJUSTFORNULLS |
Indicate whether to collapse empty attributes to conserve vertical space within the nodes. Y – Collapse. N – Do not collapse. The default value is “N”. |
|
PTPOPUPHDRMAINDESC |
Specifies the main descriptor of the pop-up chart header for this node |
|
PTPOPUPHDRMAINICON |
Specifies the name of the image to place on the top left of the pop-up chart header. |
|
PTORGCHRTIMG |
Specifies the node image. The maximum image size depends on your database platform. Note: If this field is placed on a grid on the page and the column is hidden (Visible = False), the node images do not appear on the chart. |
|
PSIMAGEVER |
A unique number that is assigned to each image. This is a system-maintained value. |
|
PTDESCR_UNDER_IMG |
If you are using a node display template, this specifies the first node line number that appears under the node image. The specified line number and all following lines appear below the image. All lines prior to the specified line appear to the side of the image. If you are not using a node display template, specify an integer from 1 to 7. The corresponding descriptor and all following descriptors appear below the image. All descriptors prior to the one specified appear to the side of the image. If no value is specified, the node lines all appear to the side. If no image is displayed, this field is ignored. This field takes an integer value. |
|
PTPHOTO_START |
Specifies the node line number on which the photo starts. This field only applies if you are using a node display template. |
|
PTNODE_DISPLAY_ID |
Specifies which display template ID to use with this node. |
|
PTCHART_SCHEMA_ID |
Specifies the current schema value. The system sets this value using the ChartCurrentSchemaLevel OrgChart property value. When the user selects a different schema value, the system sets field to the new value, sets the ChartCurrentSchemaLevel OrgChart property value to the new value, and redraws the chart using the new schema level. If the application changes the ChartCurrentSchemaLevel OrgChart property value, the system sets this field to the new value and redraws the chart using the new schema level. |
PTORGPOPUP_SBR
This table describes the fields in PTORGPOPUP_SBR.
| Field | Description |
|---|---|
|
PTCHART_NODE |
Specifies the name of the node that invoked this pop-up chart. This is a key field. |
|
PT_POP_UP_ID |
The unique ID for the pop-up. This is a key field. |
|
PTPREDECESSOR_NODE |
Specifies the name of the predecessor node to the current chart node. The predecessor node is the node that invoked this node. Your application PeopleCode must set this value when the link is clicked on the predecessor node. |
|
PTND_DISPLAY_ORDER |
Sets the display order of the nodes within the same pop-up. By default the nodes are ordered as they appear in the rowset. |
|
PTNDMAINICON_IMAGE |
Specifies the main icon image name for the node. |
|
PTNODESTYLENAME |
Specifies the style class name for the node to control node background color, border, style, and so on. If no style class name is specified the PeopleTools default style class is used. |
|
PT_POPUP_PARENT_ID |
Set to the ID of the parent pop-up chart to which the PT_POP_UP_ID is attached. If the chart ID PT_POP_UP_ID is connected from the organization node, then its corresponding PT_POPUP_PARENT_ID value is NULL. |
|
PTHASPOPUP_FLAG |
Indicates whether the node has a pop-up. Y – This node has a link that invokes a pop-up and the data for the pop-up is already loaded into the pop-up node rowset. X – This node has a link that invokes a pop-up and the data for the pop-up is not loaded in the rowset. The data will be loaded on demand. N – This node does not have a link to invoke a pop-up chart. The default value is “N”. |
|
PTPOPUPEXPAND_FLAG |
Indicates whether a node’s pop-up nodes display. Y – Pop-up nodes display. N – No pop-up nodes display. If the user clicks the close icon in the pop-up node, the FieldChange event for PTPOPUPEXPAND_FLAG executes. The application sets the value of PTPOPUPEXPAND_FLAG to “N” when the pop-up node is closed. |
|
DISPLAYED_FLAG |
Indicates whether the node will appear in the pop-up chart. Y = The node appears in the pop-up chart. N = The node never appears in the pop-up chart, including its pop-up nodes. Default is “Y”. |
|
PTNODE_DESCRn |
Specifies the descriptor n of the node, where n is an integer from 1 to 8; for example, PTNODE_DESCR2. Maximum length is 50 characters. |
|
PTNDDESCnLINKABLE |
Specifies whether the descriptor n is linkable, where n is an integer from 1 to 8; for example, PTNDDESC2LINKABLE. Y – Linkable N – Not linkable |
|
PTDESCRn_ICON_IMG |
Specifies the name of the image associated with descriptor n, where n is an integer from 1 to 8; for example, PTDESCR2_ICON_IMG. |
|
PTDESCRn_ICON_POS |
Indicates the position of the icon relative to descriptor n, where n is an integer from 1 to 8; for example, PTDESCR2_ICON_POS. L – To the left of the description. R – To the right of the description. The default value is based on user language. For instance, “L” for English and “R” for Hebrew. |
|
PTADJUSTFORNULLS |
Indicates whether to collapse empty attributes to conserve vertical space within the nodes. Y – Collapse N – Do not collapse |
|
PTPOPUPHDRMAINDESC |
Specifies the main descriptor of the pop-up chart header for this node. |
|
PTPOPUPHDRMAINICON |
Specifies the name of the image to place on the top left of the pop-up chart header. |
PTORGCRMB_SBR
This table describes the fields in PTORGCRMB_SBR:
| Field | Description |
|---|---|
|
PTORGCRMBID |
Assigns the breadcrumb ID. PTORGCRMBID is a key field. |
|
PTPARENT_ORGCRMBID |
Specifies the breadcrumb ID of Parent node. Only one row, which will be the first breadcrumb, can have this field blank or there will be a runtime error. |
|
PTORGCRMBDESCR |
Sets the breadcrumb description. In an organization chart this is generally a name. |
|
DISPLAYED_FLAG |
The displayed flag, Y = Displayed. N = Not displayed. The default is “N”. |
|
PTORGCRMBLINKABLE |
The linkable flag. Y = Linkable N = Not linkable The default is “Y”. |
PTORGBOXLST_SBR
This table describes the fields in PTORGBOXLST_SBR:
| Field | Description |
|---|---|
|
PTDESCR_DRPDWN_ID |
Specifies the node description drop-down list box ID. PTDESCR_DRPDWN_ID is a key field. |
|
PTORGDRPLSTITM_ID |
The drop down list item ID for the specified drop down list. PTORGDRPLSTITM_ID is a key field. |
|
PTORGDRPLS_GRP_ID |
Specify the group ID for the drop down list item in the drop-down box. For a folder menu, set this value to the list item ID (PTORGDRPLSTITM_ID) of the parent folder. For a top-level folder, set this value to blank. For a flat (single-level) drop-down list box, set this value to blank. |
|
PTND_DISPLAY_ORDER |
Set the display order of the list item within the same drop-down box. By default, the list will display in the order the list items appear in the rowset. |
|
PTNODELISTDESCR |
The text that will appear for the drop down list item. The maximum length is 60 characters. |
|
PTORGLISTDESCSTYLE |
Specify the style class for the list item. The default style class for drop down list items depends on the type of drop down. |
PTORGBOXFLD_SBR
This table describes the fields in PTORGBOXFLD_SBR:
Note:
This subrecord is retained for backward compatibility. With PeopleTools version 8.52 and later, Oracle recommends using node display templates. The PTORGBOXFLD_SBR is not used with a chart that implements node display templates.
See Configuring the Node Record for Drop-Downs.
| Field | Description |
|---|---|
|
PTDESCRn_DROPDOWN |
The drop down list ID for descriptor n, where n is an integer from 1 to 7; for example, PTDESCR2_DROPDOWN. |
|
PTDESn_SLCT_ITM_ID |
The selected list Item ID in the drop-down box for descriptor n, where n is an integer from 1 to 7; for example, PTDES2_SLCT_ITM_ID. The system sets this field to the value of the list item ID when the user clicks on a list item in the drop-down list box for descriptor n. You can add PeopleCode to the PTNODE_DESCRn field that performs business logic using the value in this field. |
PTORGIM_SBR
Note:
PTORGIM_SBR has been desupported and currently exists for backward compatibility only.
PTNODE_DISP_SBR
This table describes the fields in PTNODE_DISP_SBR:
| Field | Description |
|---|---|
|
PTNODE_DISPLAY_ID |
Specifies the ID of a display template. The PTNODE_DISPLAY_ID field on the organization chart node record specifies the node display template to be used for the node. |
|
PT_SCHEMA_LEVEL_ID |
Specifies the schema level. Specify a numeric value 1-10. |
|
PT_CNT_ID |
Specifies the descriptor. For example, PTNODE_DESCR1. |
|
PT_NODE_VIEW |
Specifies the name of the node view. |
|
PT_LINE_NUM |
Specifies the node line number on which the descriptor will appear. |
|
PT_DISPLAY_TYPE |
Specifies the display item type. Y - Linkable text N - Static text I - Linkable Icon O - Icon only A -Related action menu D - Linkable drop-down menu R - Read-only (non-linkable) drop-down menu L - Linkable drop-down list box M - IM icon If this field is set to “M” but no rows are defined in the PT_ORGIM_SBR for the node, no IM icon will be shown. The value in this field overrides the value in PTNDDESCnLINKABLE in the organization chart node record. |
|
PT_DISPLAY_FLAG |
Specifies whether the descriptor will be displayed in the node. The default value is “Y”. |
|
PTND_DISPLAY_ORDER |
Sets the display order of the descriptor/icon within the line number. |
|
PT_PADDING_RIGHT |
Specifies the padding, in pixels, to the right of the descriptor. If PT_COL_ALIGN is set to centered or left aligned, this field is ignored. |
|
PT_PADDING_LEFT |
Specifies the padding, in pixels, to maintain to the left of the descriptor. If PT_COL_ALIGN is set to centered or right aligned, this field is ignored. |
|
PT_CNT_STYLE |
Specifies the style class name that will be used to control the style of the descriptor. The default style class for drop downs depends on the type of drop down. |
|
PT_DESCR_MAX |
Specifies the maximum length for the descriptor. If the full descriptor text is longer than PT_DESCR_MAX, then an ellipsis (“…”) is appended to the displayed text. The entire text appears in a data hint. The default value is 50 characters. This value overrides any value set in the NodeMaxDisplayDescLength OrgChart property. |