AX2369

GetSecurityInfo("FileGroup")

If "FileGroup" is specified as the first parameter, GetSecurityInfo returns the user's plan file access filter, given a file group.

Syntax

GetSecurityInfo("FileGroup", "FileGroupName", "UserName", LocalizeResult, "Domain")

Parameter Description

FileGroup

Use the keyword FileGroup to return information on a user's file group access filter.

FileGroupName

The name of the file group. A file group alias name can also be used.

UserName

Optional. The name of the user or role for which to return the security information. If omitted, the current user is assumed.

LocalizeResult

Optional. Boolean value to determine whether the plan file permission is returned using integer values or by using the permission name in security.

  • If FALSE (default), the function returns "0" to indicate no access, and "1" to indicate full access.
  • If TRUE, the function returns the permission names "No Access" or "Full Access".

If the user's access is filtered, the filter text is returned.

Domain

Optional. The Active Directory domain of the user.

The domain property only applies to users that have been imported from Active Directory. Manually created users do not have a value for domain.

You might be required to specify a domain to identify the correct user if users have been imported from multiple Active Directory domains and have the same user name. If all user names are unique across domains, then it is not necessary to specify the domain.

All non-numeric entries must be placed in double quotation marks, unless you are using cell references to reference the text held in another cell. However, the Boolean values TRUE and FALSE do not need to be in quotation marks.

Remarks

  • The second parameter of this function also accepts a file group code. However, use of file group code is being phased out. If you have existing functions that use the file group code, these functions should eventually be migrated to use the file group name.

  • This function only returns information on which plan files a user can access within the file group; it does not provide information on what level of access the user has to those files (for example, read only or read/write). Note that if a user has no access plus a filter, then GetSecurityInfo will return no access, even though the filter may be relevant if the user is eligible for permission "elevation" due to a plan file process.

  • Users can be granted different levels of access to different sets of plan files within the same file group. For the purposes of this function, all filters are concatenated with OR to result in the total set of plan files that the user can access at some level. If a subsystem restriction applies, it is concatenated with AND.

  • If the filter uses a filter variable (such as {CurrentUser.LoginName}), the variable is resolved when the function returns values for a user, and not resolved when the function returns values for a role.

  • GetSecurityInfo is a volatile function.

Examples

=GetSecurityInfo("FileGroup","Budget 2024")

This example returns "1" if the current user has full access to file group Budget 2024.

=GetSecurityInfo("FileGroup","Budget 2024",,TRUE)

This example returns "Full Access" if the current user has full access to file group Budget 2024.

=GetSecurityInfo("FileGroup","Budget 2024","Jdoe")

This example returns "(DEPT.Region='North')" if user Jdoe has filtered access to file group Budget 2024.

=GetSecurityInfo("FileGroup","Budget 2024","Jdoe",,"Corporate")

This example returns the file group filter for the user Jdoe who was imported from the Corporate domain. This would be necessary if another user named Jdoe was imported from a different Active Directory domain.

See also