LoadABN
Mon 01 January 2018Syntax
LoadABN(&DS_rowset, &chart_rowset, &relactions_rowset, node, initial_node[, disp_relactions][, fldr_img_class_ID][, CREF_img_class_ID])
Description
Note: SmartNavigation has been deprecated. This function remains for backward compatibility only.
Use this function to load data into the SmartNavigation chart and to generate an HTML code fragment that will be rendered in the browser as menu drop-downs, fly-outs, and breadcrumbs. The function loads data for the node specified by the node parameter from the rowset data source into the SmartNavigation chart rowset. If the data source contains siblings of node, the siblings are loaded and displayed in the chart at the same level as node.
The LoadABN function is applicable to rowset data sources only, and not to tree data sources. The standalone data source record specified by the &DS_rowset parameter must include the PT_ABNORGND_SBR, PT_ABNNDURL_SBR, PT_ABNNDDTL_SBR and PTORGBOXFLD_SBR subrecords in that order. Prior to calling the LoadABN function, data must be loaded from the applicable database data source into the standalone rowset data source.
Because this standalone rowset data source includes the PT_ABNORGND_SBR subrecord, the data is organized by an organization chart hierarchy of parent and child nodes. To simplify loading data from the database data source, it should also be organized using the organization chart hierarchy.
Parameters
|
Field or Control |
Definition |
|---|---|
| &DS_rowset |
Specifies the data source as a standalone rowset. |
| &chart_rowset |
Specifies the SmartNavigation chart rowset. Typically, this is the rowset returned by the GetABNChartRowSet function. |
| &relactions_rowset |
Specifies the related actions rowset. Typically, this is the rowset returned by the GetABNRelActnRowSet function. |
| node |
Specifies the currently requested chart node. Typically, this is returned directly by calling the GetABNNode function. |
| initial_node |
Specifies the initial chart node. Typically, this is returned directly by calling the GetABNInitialNode function. |
| disp_relactions |
Specifies a Boolean value indicating whether to display the related actions folder in the fly-out menus. True indicates to display the related actions folder; False indicates that the related actions folder is not displayed. The default value is True. This is an optional parameter. However, if you want to use custom folder or CREF icons (with the fldr_img_class_ID or CREF_img_class_ID parameters, respectively), you must explicitly define the disp_relactions parameter. |
| fldr_img_class_ID |
Specifies the class ID for a custom folder icon as a string. This class must be defined in a style sheet, and the style sheet must be assigned to the SmartNavigation folder. This is an optional parameter. To use the default folder icon, you can omit this parameter or specify the null string "". However, to ensure forward compatibility, you must specify the null string. |
| CREF_img_class_ID |
Specifies the class ID for a custom CREF icon as a string. This class must be defined in a style sheet, and the style sheet must be assigned to the SmartNavigation folder. This is an optional parameter. To use the default CREF icon, you can omit this parameter or specify the null string "". However, to ensure forward compatibility, you must specify the null string. |
Returns
None.