View source for (I) VMS

'Tips for developers working within the Sysgem Enterprise Manager (SEM) environment'.

== (I) VMS Script ==

''Variables set by the SEM framework:''

The VMS DCL Script: ''"(I) VMS script"'' runs on the target (VMS) system after a menu option has been selected and BEFORE the display of the input form. 

The main purpose of the script is, for example, if this menu option is a user account management option to 'edit' a VMS user account, then this script will run on the target VMS server to extract the latest set of fields from the selected account so that those fields may be displayed in a 'modify' input form and displayed to the user. 


'''''Variables:'''''

The details of the variables stored automatically by the SEM framework at the start of script are shown below.

* Details of the Current SEM User:

Details of the SEM user that has invoked the menu option are stored in the following VMS System Logicals:

    $ USER_NT_USERNAME "Windows NT username"
    $ USER_NT_COMPUTER "Windows NT computer name"
    $ USER_SYSGEM_USERNAME "SYSGEM username"
    $ USER_DISPLAY_VERBOSE "Verbose display option (either 0 or 1)"
    $ CLIENT_BUILD "SEM Client Build (e.g. 2.3 4459)"


* Details of the Target Server:

Details of the target VMS server are displayed in the following VMS System Logicals:

    $ SERVER_DEF_NAME "Agent name - from the Agent Definition"
    $ SERVER_DEF_DESC "Agent description - from the Agent Definition"
    $ SERVER_DEF_ADDR "Agent address - from the Agent Definition"
    $ SERVER_DEF_PORT "Agent port - from the Agent Definition"
    $ SERVER_DEF_CNTX "Agent context - from the Agent Definition"


* Details of the Current Display Window:

    $ SysgemDisplayName "Custom Display Name (e.g. Enterprise Accounts)"
    $ SysgemMenuOption "Menu Option (e.g. &Modify)"


* Startup Fields:

The content of the fields entered in the start-up window as the display window was invoked:

    $ STARTUP_XX  "Where XX is the two character code used in the startup window"


* Selected Entry:

All fields in the selected entry in the display window are recorded as variables. The two character code that defines the field is appended to the VMS System Logical: "ENTRY_" ... for example:

    $ ENTRY_SV     - holds the Server (Agent) name of the selected record
    $ ENTRY_UN     - holds the Username of te selected user account

... to see which field codes are used - see the defintion of the display columns in the "Columns" page of SEM development interface.


* Details of the Authorization Server

   $ USE_AUTH_SVR_PROXY   "Whether the Authorization Server may be used for DB access (either 0 or 1)"
   $ AUTH_SVR_ADDRESS     "The address of the Authorization Server as used in the SEM Login window"
   $ AUTH_SVR_PORT        "The port number of the Authorization Server as used in the SEM Login window"