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

IS_GROUP_MEMBER

Script Function: Checks 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.'s membership statusThis represents the condition of a task (such as active, blocked, generating). within a user groupA group of users who have a common profile of rights. A particular object type in the Automation Engine. User groups are an organizing construct to help you better manage users because you can grant user groups access rights the same way that you grant various access rights to a single user. All users in the user group are automatically given those access rights. This makes managing users not only more efficient but also more secure because working with user groups gives you a better overview of what rights are assigned.

Syntax

IS_GROUP_MEMBER (User, UserGroup)

Syntax

Description/Format

User

Name of a User objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task
Format: script literal or script variable

UserGroup

Name of a UserGroup object
Format: scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.


Return codes

"1" - The user is a member of the user group
"0" - The user is no member of the user group or the user and/or the user group do(es) not exist.

Comments

The membership status of a user within a user group may be checked using this script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,…. Both must be in the 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. in which this script function is called.

Example

In this example, the membership status of "BU/AE" within the user group "ADMIN" is tested. The result is written out in the activation reportA report provides more detailed information about a task's execution or a component..

:SET &USGR#   = "ADMIN"
:
SET &MEMBER# = IS_GROUP_MEMBER("BU/AE", &USGR#)
:
IF &MEMBER# = 1
:   
PRINT "Member in &USGR#"
:
ELSE
:   
PRINT "No member in &USGR#"
:
ENDIF

 

See also:

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