Directory functions

FINDUSER / TROUVERUTILISATEUR

Since Process17.0.0

Description

This function allows you to find a user in the Process directory.

Syntax

1

@FINDUSER("login")

the function contains the following arguments :

Parameter Description Mandatory Comment
login login of the searched user. Yes
Return value

The FINDUSER function returns a user object of type com.axemble.vdoc.sdk.interfaces.IUser if the object has been found, otherwise it returns null.

Examples

Example 1 : find user “user1”
1

@FINDUSER("user1")

FINDGROUP / TROUVERGROUPE

Since Process17.0.0

Description

This function allows you to find a group in the Process directory.

Syntax

1

@FINDGROUP(organization; "groupName")

the function contains the following arguments :

Parameter Description Mandatory Comment
organization Organization object of type com.axemble.vdoc.sdk.interfaces.IOrganization. Yes
groupName System name of the group you are looking for. Yes
Return value

The FINDGROUP function returns a group object of type com.axemble.vdoc.sdk.interfaces.IGroup if the object has been found, otherwise it returns null.

Examples

Example 1 : find a default organization group
1

@FINDGROUP(@FINDORGANISATION("DefaultOrganization"); "AParticularGroup")
Example 2 : find a group in the logged-in user’s organization
1

@FINDGROUP(iUser.Organization; "AnyGroup")

FINDORGANIZATION /TROUVERORGANISATION

Since Process17.0.0

Description

This function allows you to find an organization in the Process directory.

Syntax

1

@FINDORGANIZATION("organizationName")

the function contains the following arguments :

Parameter Description Mandatory Comment
organizationName System name of the organisation you are looking for. Oui
return value

The FINDORGANIZATION function returns an organization object of type com.axemble.vdoc.sdk.interfaces.IOrganization if the object has been found, otherwise it returns null.

Examples

Example 1 : find the default organization
1

@FINDORGANIZATION("DefaultOrganization")
Example 2 : test the membership of the logged-in user the consulting group
1

@ISMEMBEROFGROUPS(iUser;@FINDGROUP(@FINDORGANIZATION("DefaultOrganization");"Consulting"))

FINDLOCALIZATION / TROUVERLOCALISATION

Since Process17.0.0

Description

This function allows you to find a localization in the Process directory.

Syntax

1

@FINDLOCALIZATION("localizationName")

the function contains the following arguments :

Parameter Description Mandatory Comment
localizationName System name of the localization you are looking for. Oui
return value

The FINDLOCALIZATION function returns a location object of type com.axemble.vdoc.sdk.interfaces.ILocalization if the object has been found, otherwise it returns null.

Examples

Example 1 : find the default localization
1

@FINDLOCALIZATION("DefaultLocalization")

ISMEMBEROFUSERS / ESTMEMBREDEUTILISATEURS

Since Process17.0.0

Description

This function is used to indicate whether a user is present in User(s), Role fields of a form.

Syntax

1

@ISMEMBEROFUSERS(user;objects...)

the function contains the following arguments :

Parameter Description Mandatory Comment
user User object of type com.axemble.vdoc.sdk.interfaces.IUser. Yes It is possible to use iUser Bookmark.
objects… Object of type iUser and/or list of objects of type iUser and/or system names of fields of type User(s) or Roles. Yes Separated by * semicolons*.
return value

The function ISMEMBEROFUSERS returns @TRUE if the object was found, otherwise it returns @FALSE.

Examples

Example 1 : Check the availability of the logged-in user in three fields of the form
1

@ISMEMBEROFUSERS(iUser;simpleFieldUser;OperatorRoleField;UsersList)

ISMEMBEROFGROUPS / ESTMEMBREDEGROUPES

Since Process17.0.0

Description

This function allows to check whether a user is a member of one or more groups in the Process directory.

Syntaxe

1

@ISMEMBEROFGROUPS(user;objects...)

the function contains the following arguments :

Parameter Description Mandatory Comment
user User object of type com.axemble.vdoc.sdk.interfaces.IUser. Yes It is possible to use iUser Bookmark.
objects… Object of type iGroup and/or list of objects of type iGroup and/or system names of fields of type Group(s). Yes Separated by * semicolons*.
return value

The function ISMEMBEROFGROUPS returns @TRUE if the object was found, otherwise it returns @FALSE.

Examples

Example 1 : check the presence of the logged-in user in the Marketing group
1

@ISMEMBEROFGROUPS(iUser;@FINDGROUP(@FINDORGANIZATION("DefaultOrganization");"Marketing"))

ISMEMBEROFORGANIZATIONS / ESTMEMBREDEORGANISATIONS

Since Process17.0.0

Description

This function allows to check whether a user is a member of one or more organizations in the Process directory.

Syntax

1

@ISMEMBEROFORGANIZATIONS(user;objects...)

the function contains the following arguments :

Parameter Description Mandatory Comment
user User object of type com.axemble.vdoc.sdk.interfaces.IUser. Yes It is possible to use iUser Bookmark.
objects… Object of type iOrganization and/or list of objects of type iOrganization and/or system names of fields of type Organization(s). Yes Separated by * semicolons*.
Valeur de retour

The function ISMEMBEROFORGANIZATIONS returns @TRUE if the object was found, otherwise it returns @FALSE.

Examples

Example 1 : check if the logged-in user is in the default organization
1

@ISMEMBEROFORGANIZATIONS(iUser;@FINDORGANIZATION("DefaultOrganization"))

ISMEMBEROFLOCALIZATIONS / ESTMEMBREDELOCALISATION

Since Process17.0.0

Description

This function allows to check whether a user is a member of one or more localization in the Process directory.

Syntax

1

@ISMEMBEROFLOCALIZATIONS(user;objects...)

the function contains the following arguments :

Parameter Description Mandatory Comment
user User object of type com.axemble.vdoc.sdk.interfaces.IUser. Yes It is possible to use iUser Bookmark.
objects… Object of type iLocalization and/or list of objects of type iLocalization and/or system names of fields of type Localization(s). Yes Separated by * semicolons*.
return value

The function ISMEMBEROFLOCALIZATIONS returns @TRUE if the object was found, otherwise it returns @FALSE.

Examples

Example 1 : check if the logged-in user is in the default localization
1

@ISMEMBEROFLOCALIZATIONS(iUser;@FINDLOCALIZATION("DefaultLocalization"))

ISMEMBEROFROLES / ESTMEMBREDEROLES

Since Process17.0.0

Description

This function allows to check whether a user is a member of one or more roles.

Syntax

1

@ISMEMBEROFROLES(user;"roleNames"...)

the function contains the following arguments :

Parameter Description Mandatory Comment
user User object of type com.axemble.vdoc.sdk.interfaces.IUser. Yes It is possible to use iUser Bookmark.
roleNames… Set of system names of Role(s). Yes Separated by * semicolons*.
return value

The function ISMEMBEROFROLES returns @TRUE if the object was found, otherwise it returns @FALSE.

Examples

Example 1 : check if the logged-in user is in the HumanResources role
1

@ISMEMBEROFROLES(iUser;"HumanResources")

ISMEMBEROFPROFILES / ESTMEMBREDEPROFILS

Since Process17.0.0

Description

This function allows to check whether a user is a member of one or more profiles.

Syntax

1

@ISMEMBEROFPROFILES(user;"scope";"profilNames"...)

the function contains the following arguments :

Parameter Description Mandatory Comment
user User object of type com.axemble.vdoc.sdk.interfaces.IUser. Yes It is possible to use iUser Bookmark.
scope Profile selection filter (see definition table below). Yes
profilNames… Set of Profile(s) system names. Yes Separated by * semicolons*.
Definition of available filters
Filter Description
WORKFLOW workflow-version-level profile
WORKFLOWCONTAINER workflow-level profile
CATALOG catalog-level profile
PROJECT project-level profile
SYSTEM Profile configured at the administration level
return value

The function ISMEMBEROFPROFILES returns @TRUE if the object was found, otherwise it returns @FALSE.

Examples

Example 1 : check if the logged-in user is in the HumanResources profile
1

@ISMEMBEROFPROFILES(iUser;"WORKFLOWCONTAINER";"HumanResources")