Modify Set Command

If you are a Business Administrator with person access, you can modify sets in any person’s workspace (likewise for groups and roles). Other users can modify only their own sets.

You must be a business administrator with group or role access to modify a set owned by a group or role.

To improve performance, it is recommended that you use a list of object IDs or physicalIDs when you add a new set or modify a set to add new objects, instead of using a list of TNR.

The kernel is lenient towards inclusion of invalid or non-existent IDs in the list when adding or modifying sets. The objects when not present or incorrect are not included in the set and there are no errors for invalid or non-existent IDs during the operation.

For example, the following code works without any errors and the set is created or modified, but without any new objects added to it:

add set set_1 member businessobject 00000000000000000000000000000000,11111111111111111111111111111111;

mod set set_1 add businessobject 00000000000000000000000000000000,11111111111111111111111111111111;

Use the following command to show any valid objects:

print set set_1

You can use the Modify Set command to modify any set to add or remove business objects and change set options: 

modify set NAME [user USER_NAME] [MOD_ITEM {MOD_ITEM}];

  • NAME is the name of the set to modify. If you are a business administrator with person access, you can include the User clause to indicate another user’s workspace object.
  • MOD_ITEM is the type of modification to make. Each is specified in a Modify Set clause, as listed in the following table. You need to specify only fields to be modified.
    Modify Set Clause Specifies
    add businessobject TYPE NAME REVISION [in VAULT] The named business object is added to the set.
    add businessobject ID The business object with the specified ID is added to the set.
    remove businessobject TYPE NAME REVISION [in VAULT] The named business object is removed from the set.
    remove businessobject ID The business object with the specified ID is removed from the set.
    hidden The hidden option is changed to specify that the object is hidden.
    nothidden The hidden option is changed to specify that the object is not hidden.
    visible USER_NAME{,USER_NAME}; The object is made visible to the other users listed.
    property NAME [to ADMINTYPE NAME] [value STRING] The named property is modified.
    add property NAME [to ADMINTYPE NAME] [value STRING] The named property is added.
    remove property NAME [to ADMINTYPE NAME] [value STRING] The named property is removed.

Each modification clause is related to the clauses and arguments that define the set.

For example, assume you have a set named “Product Comparison.” You want to add two new business objects and remove an old one. You could write a command similar to the following:

modify set "Product Comparison"
   add businessobject "Scent Formula" "Perfume P39" B;
   add businessobject "Scent Formula" "Perfume P40" A;
   remove businessobject "Scent Formula" "Scent P13" D;

To remove a set entirely, use the Delete Set command. For more information, see Delete Set Command . To change the name of the set, delete the current set and create a new set.