IsSecurityContextField

Description

Tests whether a field is used as a security context, which means access to it requires that the user is in one of the groups in the ratl_context_groups field.

Syntax

VBScript


entitydef.IsSecurityContextField fieldname 

Perl


$entitydef->IsSecurityContextField($fieldname); 
Identifier
Description
entitydef
An EntityDef object corresponding to a record type in a schema.
fieldname
A String containing the name of the field to be tested.
Return value
The return value is Boolean True if this field is used as a security context field; otherwise the return value is Boolean False.

Security can be managed at the database, record type, and field levels. This method tests security properties at the field level.

Security cannot be managed by HCL Compass APIs. To manage security, you need to use the HCL Compass designer and HCL Compass client.

Examples

VBScript


is_secure = entitydef.IsSecurityContextField fieldname 

Perl

$is_secure = $entitydef->IsSecurityContext($fieldname);