AvePoint Learn
Request article
Contact support
Request article
Contact support
English

    Home > Appendices > Appendix F - Supported Variable Roles

    Export to PDF

    Appendix F - Supported Variable Roles

    AvePoint Cloud Governance supports setting variable roles when you select users in approval processes, site collection policies, services, renewal profiles, etc.

    Note the following:

    - When you specify a user role as the primary contact or secondary contact, one of the group or team owners will be randomly chosen as the primary or secondary contact. - In the role name, the character **$** and the punctuation **()** and **""** must be entered under the English input method, regardless of whether you select which language as the AvePoint Cloud Governance display language.

    The following roles are available, but the roles vary when specifying roles in different fields.

    Role NameDescription
    $Primary site collection contactThe primary site collection contact that is configured in AvePoint Cloud Governance.
    $Manager of primary site collection contactThe manager of the primary site collection contact. The manager is configured in Microsoft Entra.
    $Secondary site collection contactThe secondary site collection contact that is configured in AvePoint Cloud Governance.
    $Manager of secondary site collection contactThe manager of the secondary site collection contact. The manager is configured in Microsoft Entra.
    $Primary site collection administratorThe primary site collection administrator that is configured in AvePoint Cloud Governance or SharePoint.
    $Additional site collection administratorsThe users or groups within the SharePoint Site Collection Administrators group, except for the primary site collection administrator.
    $New site collection contactThe user that takes over the role of site collection contact.
    $Site collection owners groupThe users or groups within the SharePoint Site Collection Owners group.
    $Users with the Full Control permissionThe users who have the Full Control permission to the site collection.
    $Users with the Edit permissionThe users who have the Edit permission to the site collection.
    $Primary site contactThe primary site contact that is configured in AvePoint Cloud Governance.
    $Secondary site contactThe secondary site contact that is configured in AvePoint Cloud Governance.
    $Primary site contact of sourceThe primary site contact of the source node.
    $Secondary site contact of sourceThe secondary site contact of the source node.
    $Primary site contact of targetThe primary site contact of the target node.
    $Secondary site contact of targetThe secondary site contact of the target node.
    $New site contactThe user that takes over the role of site contact.
    $Primary group/team/community/shared mailbox/resource mailbox/Power Platform object contactThe primary contact of a Microsoft 365 Group, Microsoft Team, Viva Engage community, shared mailbox, resource mailbox, Power App, Power Automate flow, Power BI workspace, or Power Platform environment; it is configured in AvePoint Cloud Governance.
    $Manager of primary group contactThe manager of the primary group contact or primary team contact. The manager is configured in Microsoft Entra.
    $Secondary group/team/community/shared mailbox/resource mailbox/Power Platform object contactThe secondary contact of a Microsoft 365 Group, Microsoft Team, or Viva Engage community, shared mailbox, resource mailbox, Power App, Power Automate flow, Power BI workspace, or Power Platform environment; it is configured in AvePoint Cloud Governance.
    $Manager of secondary group contactThe manager of the secondary group contact or secondary team contact. The manager is configured in Microsoft Entra.
    $New group/team/community contactThe user that takes over the role of the Microsoft 365 Group contact, Microsoft Team contact, or Viva Engage community contact.
    $Group/Team/Power App/Power Automate flow owner or community adminThe owner of a Microsoft 365 Group/Microsoft Team/Power Automate flow, admin of a Viva Engage community, or owner and co-owner of a Power App; they are configured in Microsoft 365, Microsoft Teams, Viva Engage, or AvePoint Cloud Governance.
    $Primary community contactThe primary contact of a Viva Engage community; it is configured in AvePoint Cloud Governance.
    $Secondary community contactThe secondary contact of a Viva Engage community; it is configured in AvePoint Cloud Governance.
    $Primary contactThe primary contact of an object; it is configured in AvePoint Cloud Governance.
    $Secondary contactThe secondary contact of an object; it is configured in AvePoint Cloud Governance.
    $Community adminsThe administrator of a Viva Engage community; it is configured in Viva Engage or AvePoint Cloud Governance.
    $Source userThe user from whom the permissions will be cloned or transferred.
    $Manager of source userThe manager of the user from whom the permissions will be cloned or transferred.
    $Target userThe user to whom the permissions will be cloned or transferred.
    $Manager of target userThe manager of the user to whom the permissions will be cloned or transferred.
    $Primary guest contactThe primary contact of a guest user; it is configured in AvePoint Cloud Governance.
    $Secondary guest contactThe secondary contact of a guest user; it is configured in AvePoint Cloud Governance.
    $Manager of task approverThe manager of the task approver.
    $Manager of previous stage approverThe manager of the previous stage’s approver.This role is only available to the second or third stage of approval in an approval process.
    $RequesterThe user who submits a request.
    $Manager of requesterThe manager of the requester. The manager is configured in Microsoft Entra.
    $Administrator contactThe administrator contact of a service.
    $Service metadata ("Metadata name")The Person or group/User Profile Property/Microsoft Entra property metadata that is added to the service with the approval process applied. Make sure the Allow a variable role reference to this metadata in the approval process option enabled on the metadata. The users or groups as the metadata value will be retrieved.Replace Metadata Name with the metadata name.
    $Object metadata ("Metadata name")The Person or group/Microsoft Entra property/Lookup metadata that is applied to the object. Make sure the Allow a variable role reference to this metadata in the approval process option is enabled on the metadata. The users or groups as the metadata value will be retrieved.
    $New object metadata ("Metadata name")The Person or group/Microsoft Entra property/Lookup metadata that is applied to the object. Make sure the Allow a variable role reference to this metadata in the approval process option is enabled on the metadata. The users or groups as the newly added/changed metadata value will be retrieved.
    $Site collection metadata ("Metadata name")The Person or group/User Profile Property/Microsoft Entra property metadata that is applied to the site collection. Make sure the Allow a variable role reference to this metadata in the approval process option is enabled on the metadata. The users or groups as the metadata value will be retrieved.Replace Metadata Name with the metadata name.
    $Group/Team/Community metadata ("Metadata name")The Person or group/User Profile Property/Microsoft Entra property metadata that is applied to the group, team, or community. Make sure the Allow a variable role reference to this metadata in the approval process option is enabled on the metadata. The users or groups as the metadata value will be retrieved.Replace Metadata Name with the metadata name.
    $SharePoint Online Group ("$SiteName Group Name Suffix")The custom SharePoint Online group. For site-specific groups, use the following format: $SiteName Group Name Suffix. Replace Group Name Suffix with your desired value (i.e. Owners). SiteName will be automatically replaced with the appropriate site title.
    $Guest inviterThe user who invited the guest user to the tenant.
    $Task assigneeThe users who are specified as the assignees to complete the task.
    $Task approverThe user who has approved/rejected the task.
    $Site property ("Property name")The property value of a site, and it’s specified in AvePoint Cloud Governance or ServiceNow. Replace the Property name with the property name in your site property bag.
    $Private channel ownerThe owner of a private channel. It is configured in AvePoint Cloud Governance.
    $Shared channel ownerThe owner of a shared channel. It is configured in AvePoint Cloud Governance.
    $Team ownerThe owner of a Microsoft Team.
    $Team contactThe contact of a Microsoft Team.
    $Group ownerThe owner of a distribution group, security group, or mail-enabled security group.
    $Shared mailbox memberThe members of a shared mailbox.
    $Manager of primary contactThe manager of a site collection, Microsoft 365 Group, Microsoft Team, Viva Engage community’s primary contact. This role is only available in the modern Cloud Governance admin center.
    $Manager of secondary contactThe manager of a site collection, Microsoft 365 Group, Microsoft Team, Viva Engage community’s secondary contact. This role is only available in the modern Cloud Governance admin center.
    $Power App co-ownerThe co-owner of a Power App.
    $Power App ownerThe owner of a Power App.
    $Power BI workspace memberThe member of a Power BI workspace.
    $Environment contactThe primary/secondary contact of the environment that Power Automate flow or Power App belongs to.
    $Environment admin of Power Automate flow or Power AppThe environment admin of a Power Automate flow or Power App.
    $Object creatorThe creator of a Microsoft 365 Group, team, Power App, Power Automate flow, or Power Platform environment.
    $Manage of object creatorThe manager of the role $Object creator when the object admin is a user.
    $Object adminThe team owner, group owner, community admin, site administrator, Power App owner, Power Automate flow owner, Power BI workspace admin, environment admin, or environment system administrator.
    $Manager of object adminThe manager of the role $Object admin when the object admin is a user.
    $Manager of original active contactThe manager of the primary or secondary contact who is no longer active.