AX1497

GetUserInfo data lookup

You can use GetUserInfo rows in a DataLookup data source to return information about Axiom Software users, as defined in Security.

The GetUserInfo data lookup supports similar query parameters as the GetUserInfo function, and can be used as a substitute for this function to improve file performance. The data lookup is intended to be used in cases where the queried value is not expected to change during the current file session, and therefore the value only needs to be queried once (or only after specific events).

To create a GetUserInfo data lookup, add a [GetUserInfo] row to a DataLookup data source and add the appropriate parameter columns. For more information on creating the DataLookup data source, see Creating DataLookup data sources.

GetUserInfo parameters

[GetUserInfo] rows use the following parameter columns. Within the DataLookup control row, these parameter names must be placed in square brackets—for example, [CodeName]. The parameters can be placed in any order.

NOTE: If the entry for any parameter depends on a value returned by another data lookup row, then that row must be in a different data source and executed before this row is executed. For more information, see Dependent data lookups.

Parameter Description

CodeName

Specifies the user property to return. Use one of the following values:

  • UserID: Returns a user's database ID (a numeric value assigned by Axiom Software).
  • UserName: Returns a user's login name.
  • UserEmail: Returns a user's email address.
  • FirstName: Returns a user's first name.
  • LastName: Returns a user's last name.
  • Domain: Returns a user's Active Directory domain. This returns blank for users that were not imported from Active Directory.

UserName

Optional. The login name of the user for which you want to return information.

If specified, the UserID parameter is ignored.
UserID

Optional. The database ID of the user for which you want to return information.

This parameter can be used instead of UserName to specify a user.
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.

Result

The Result column is where the return value for the row is placed when the data lookup is executed. You can reference this cell to use the return value in other areas of the file.

This column must be present in order for the data lookup to be valid.

IsError

Optional. Indicates whether the return value for the data lookup was an error.

  • If TRUE, the return value is an error. This may be an Axiom #ERR code, a specific error message, or a custom error message defined in the data lookup (such as the GetData invalid query message).
  • If FALSE, the query executed successfully.

The IsError column can be helpful if you need to set up formulas with error trapping. Instead of using the ISERROR Excel function, you can use a construction such as:

=IF(Info!$M$10=True, "", Info!$L$10)

Where the IsError column is in M10 and the Result column is in L10. If the data lookup returns an error, this function returns blank instead of displaying the error.
  • If both UserName and UserID are left blank, then GetUserInfo returns information for the current user.
  • If either UserName or UserID is specified, then GetUserInfo returns information for that user.

Example

The following screenshot of a DataLookup data source shows several GetUserInfo examples:

For more examples of GetUserInfo use, see GetUserInfo function. The same examples work for both approaches. To use a function example in a DataLookup data source, you would place the applicable function parameters in the corresponding parameter columns.

See also