Updating User Groups in the XML Import File - System Administration - Cloud - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

Cloud System Administration

Platform
OnBase
Product
System Administration - Cloud
Release
Foundation 23.1
License
Standard
Premier
Essential

OnBase User Groups are added or updated using the group element: <group id="Password Administrators" if-exists="update">.

The value of the id attribute is replaced with the name of an existing or new User Group. The value of the if-exists attribute must be one of the following values:

  • update: Change the existing User Group as configured in the XML import file.

  • ignore: Do not make any changes to the existing User Group.

  • error: Return an error for the import process and do not make any changes to the existing User Group.

Note:

If the User Group defined by the id attribute does not exist in OnBase, it is created as part of the import process.

Within the group element, users can be added to or removed from the User Group by including the users child element: <users mode="add">, where the value of the mode attribute is either add or remove. This element is not required.

Within the users element, individual user elements are included for each user account to perform the add or remove action on: <user id="jsmith"/>, where the id attribute is the account user name in OnBase. One or more user elements are required if the users element is included.

For example, to add users jsmith, aslattery, and jrobbins to the Password Administrators User Group, and to remove rbarson from the same User Group, include this group element in the XML import file:

<user-group-import institution="0">
<group id="Password Administrators" if-exists="update">
    <users mode="add">
        <user id="jsmith"/>
        <user id="aslattery"/>
        <user id="jrobbins"/>
    </users>
    <users mode="remove">
        <user id="rbarson"/>
    </users>
</group>
</user-group-import>