Automation Engine Script Guide > Ordered by Function > User Data > SYS_USER_ALIVE

SYS_USER_ALIVE

Script Function: Checks whether a userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. is logged on to AE with a UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."].

Syntax

SYS_USER_ALIVE(Name, Department)

Syntax

Description/Format

Name

Name of the user.
Format: script literal or script variable

Department

User's departmentDepartment name to which the Automation Engine user belongs..
Format: scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.


Return codes

"Y" - The user is logged on to the UserInterface.
"N" - The user is not logged on to the UserInterface or the User objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task does not exist.

Comments

This script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… checks if a user is logged on to AE.

Name and Department identify a user (for example, SMITH/DEV). You can only check users of your own clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type..

Users who are logged on via a utility or Call Interface cannot be identified .

The script function returns "N" if the user is not logged on or if the User object does not exist in the current client. If the specified user does not exist, you can react to this error by using the script statement :ON_ERROR and analyze it by using the script functions for error handling. Depending on the settings that have been specified, script processing either continues or aborts.

Example

The following example checks whether a user has logged on to DEV. The user's name and department are passed on to the script function in the form of script variables. The script aborts if the user "SMITH/DEV" is not defined. The result is output to the activation protocol.

:ON_ERROR ABEND
:
SET &USR# = "SMITH"
:
SET &DEP# = "DEV"
:
SET &RET# = SYS_USER_ALIVE(&USR#, &DEP#)
:
PRINT &RET#

 

See also:

Script element Description

SYS_USER_DEP

Supplies the department of the user who has started the taskAn executable object that is running. Tasks are also referred to as activities..

SYS_USER_LANGUAGE Supplies the language in which the Server generates the log files.
SYS_USER_LNAME Supplies the first and last name of the user who has started the task.
SYS_USER_NAME Supplies the name of the user who has started the task.

Script Elements - User Data

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH