IDOL 24.1

# Text Commands

Command | Description | Usage | Example
--- | --- | --- | ---
`INITIALIZE` | Initializes flags in the datastore so that deletions can be performed using the `#FINALIZE` command. | Used only with `action=import`. Must be the first command, if used. | `#INITIALIZE`
`USER` | Define a new user or select an existing user for the following commands. | Can appear anywhere. Ends any previous selection. | `#USER NewUser`
`GROUP` | Define a new group or select an existing group for the following commands. | Can appear anywhere. Ends any previous selection. | `#GROUP NewGroup`
`ALTUSERNAME` | Define an alternative name for a new user. | Must follow USER. |
    #USER NewUser
    #ALTUSERNAME AltName
`MEMBERGROUP` | Add a group as a member of the selected group. | Must follow GROUP. | `#GROUP Group3 #MEMBERGROUP Group4 //Group 4 is added as a member of Group 3`
`MEMBEROF` | Specifies that the selected user or group is a member of a group. | Must follow USER or GROUP. |
    #USER NewUser
    #MEMBEROF Group5
    //NewUser becomes a member of Group5
`MEMBER` | Adds a user or group to the selected group. | Must follow GROUP. | `#GROUP Group5,Group6 #MEMBER User5,User6,User7 //User5, User6, and User7 become members of Group5 and Group6`
`DELETEUSER` | Deletes a user. | Can appear anywhere. Ends any previous selection. | `#DELETEUSER User4`
`DELETEALTUSERNAME` | Removes an alternative name from a user. | Must follow USER. | `#USER User2 #DELETEALTUSERNAME AltName`
`DELETEGROUP` | Delete a group. | Can appear anywhere. Ends any previous selection. | `#DELETEGROUP Group5`
`DELETEMEMBERGROUP` | Remove a group from being a member of the selected group. | Must follow GROUP. |
    #GROUP Group3
    #DELETEMEMBERGROUP Group4
    //Group4 is no longer a member of Group3
`DELETEMEMBEROF` | Remove the selected user from being a member of a group. | Must follow USER. | `#USER User1 #DELETEMEMBEROF Group2 //User1 is no longer a member of Group2`
`DELETEMEMBER` | Remove a user or group from being a member of the selected. | Must follow GROUP. | `#GROUP Group3 #DELETEMEMBER User3 //User3 is no longer a member of Group3`
`FIELD` | Adds a field to the selected user. You can add multiple values to a single field (see the example). | Must follow USER. | `#USER User8 #FIELD MyField=Value1,MyField=Value2`
`DELETEFIELD` | Delete a field from the selected user. | Must follow USER. | `#USER User8 #DELETEFIELD MyField`
`NESTEDGROUPS` | Processes nested groups. For example, if `Group1` is a member of `Group2`, and `Group2` is a member of `Group3`, OmniGroupServer can consider `Group1` and a member of `Group3`. | Used only with `action=import`. Typically the last command (except for FINALIZE, if used). | `#NESTEDGROUPS`
`FINALIZE` | Deletes any existing memberships that have not be updated since the last `#INITIALIZE`. | Used only with `action=import`. Must be the last command, if used. | `#FINALIZE`

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL 24.1

Topic Title: Text Commands