TK_AU_GetNavigationMenus

   PROIV Aurora Help

Returns an XML report of the PROIV Application menus

I/O

Variable

Type

Length

Notes

Input

coDiv

A

3

If the Aurora URL is Company/Division code specific, then the coDiv contains its value, and the multiCoDivEnabled is null. Otherwise for multi-Co/Div Aurora environments, the coDiv value is the currently selected and the multiCoDivEnabled parameter contains ‘Y’.

Input

operatorId

A

32

 

Input

multiCoDivEnabled

A

1

 

Input

language

A

2

 

Input

menuId

A

32

 

If the root menu is required, the menuId’s value is an empty string.

The following is an example of the required XML:

<?xml version="1.0"?>

<Menu>

    <MenuItem>

        <Id>MENU_01</Id>

        <Type>M</Type>

        <Description>Menu 01</Description>

    </MenuItem>

    <MenuItem>

        <Id>MENU_02</Id>

        <Type>M</Type>

        <Description>Menu 02</Description>

    </MenuItem>

    <MenuItem>

        <Id>TASK_01</Id>

        <Type>T</Type>

        <Description>Task 01</Description>

    </MenuItem>

    <MenuItem>

        <Id>FUN_01</Id>

        <Type>F</Type>

        <Description>Function 01</Description>

    </MenuItem>

    <MenuItem>

        <Id>URL_01</Id>

        <Type>U</Type>

        <Description>http://www.proiv.com</Description>

    </MenuItem>        

</Menu>

Allowable types are:

M: Menu

T: Task

F: Function

U: URL (where description holds the full URL

This Task calls the Start function @AU_NAV_GetMenus by default. When implementing a third party security and menu system, it is recommended that you implement this specific function name instead of altering the Task Definition to call an alternative Start function. You can import an empty version of the function from the aurora_core_replaceables.vpx file and then edit as appropriate. However, if you change the Start function on the Task Definition to call an alternative function name, the definition must be changed at system upgrade with a new version from the aurora_core_replaceables.vpx file.

 


 

Comment on this topic

Topic ID: 810048