TK_AU_CheckAccess

   PROIV Aurora Help

Checks that an operator can access a menu item or Function Route. As an operator may have added an item to their Favourites or have an item stored in their Activity History, it is possible that the operator’s permission to access that item might have changed. This task is called prior to launching a session to ascertain whether the operator still has the required permissions to access the item.

If the error is empty, then access is permitted. If access is not permitted, the error contains a negative error number and errorReason contains the associated error text.

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, otherwise for multi-Co/Div logons, the value is null.

Otherwise for multi-Co/Div Aurora environments, the coDiv parameter is either the selected value for the menu that is launching the session, or it is the value that is saved against the option in the Favourites/History list. The multiCoDivEnabled parameter contains ‘Y’.

Input

operatorId

A

32

 

Input

multiCoDivEnabled

A

1

 

Input

profileId

A

32

 

Input

itemType

A

1

 

Input

itemName

A

240

 

Input

error

A

2

 

Input

errorReason

A

250

 

This Task calls the Start function @AU_CheckAccess 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: 810044