This program returns the valid Menu Items for a specified user and Menu Group (a.k.a. [ Menu Item ] Parent).
Build the Atrium Menu
Menu Items are returned by the
PUIATEXMNU exit program one by one in the Item data structure.
|Subfield||Subfield Values Explanation||Purpose|
|Used as a unique reference value for Menu Items and Menu Groups, must be unique.|
|If not at root level, value is Code for Menu Group the Menu Item is directly under. If the Parent value is |
|Specifies Node as being a Menu Item or Menu Group.|
|Determines how Action value is to be executed.|
|[ If Leaf Node, ] Execute Action value as ActionType.|
|Name of Menu Item.|
|Path of the image to be used as the menu icon for the Menu Item.|
|Determines whether the Action should be executed in a new Atrium Tab or in a New Browser Window or Tab.|
|Determines the number of times a Menu Item can be opened in Atrium Tabs.|
|Parameter to be added to the URL or passed to the Application.|
1 Requires PC Command Listener, Launcher or Applet.
2 Which one the browser opens the Action in can be affected by user's browser settings.
3 If Menu Item is being opened in a New Browser Window or Tab, this value will not be able to limit the number of instances.
Because there can be an unknown number of Menu Items to return, when Atrium calls this exit program, just one Menu Item (in the Item data structure) is returned. Atrium repeatedly calls the program until there are no more Menu Items to return, in which case
PUIATEXMNU returns the Item data structure empty.
PUIATEXMNU runs in stateless environment and has no way to determine how many menu items it has returned or which one to send next. To handle this, Atrium keeps track of this. Atrium will clear the Item data structure before the first call to indicate that is wants the first Menu Item of parent Item.Parent. On subsequent calls Atrium does not alter the Item data structure previously returned (on second call, first Menu Item is still in the Item data structure). This allows
PUIATEXMNU to determine which Menu Item to return next. After the last Menu Item has been returned, Atrium will call
PUIATEXMNU again, the item data structure will be returned cleared to indicate that there are no more Menu Items.
Atrium Calls PUIATEXMNU
Item data structure is cleared.
Returns the first Menu Item in the item data structure.
Item data structure contains the first Menu Item.
Sets file pointer and returns the second Menu Item.
Item data structure contains the second Menu Item.
Sets file pointer and returns the third Menu Item.
Item data structure contains the nth Menu Item.
Sets file pointer and returns Menu Item n+1.
Item data structure contains second to last Menu Item.
Sets file pointer and returns the last Menu Item.
Item data structure contains last Menu Item.
Sets file pointer, determines pointer at EOF, and returns cleared Item data structure.