Modify Person

After a person is defined, you can change the definition with the Modify Person command. This command lets you add or remove defining clauses and change the value of clause arguments.

modify person NAME [MOD_ITEM {MOD_ITEM}];
  • NAME is the name of the person to modify.
  • MOD_ITEM is the type of modification to make. Each is specified in a Modify Person clause, as listed in the following table. You need to specify only fields to be modified.
    Modify Person Clause Specifies
    part1 site PARTNER_SITE;
    Important: If you use this clause, you must modify the person again as listed in the next row.

    Recommendation: Use the Members Control Center app to update a person's site or location instead of the MQL modify person command.

    Assigns the PARTNER site to the P&O User from 3DSpace side.

    mod connection bus Person part1 - from 'Computing Environment' OnPremise - relationship 'Has Members' 'User Location' PARTNER_SITE;If you use the above clause, you must modify the person again with this clause to update the location of that person to the PARTNER site in the Members Control Center in 3DDashboard.

    Recommendation: Use the Members Control Center app to update a person's site or location instead of the MQL modify person command.

    access ACCESS_MASK {,ACCESS_MASK} The person is restricted to the listed access. Values for ACCESS_MASK can be found in the table in MQL Concepts: Access Privilege Definitions.
    add property NAME [to ADMINTYPE NAME] [value STRING] The named property is added.
    address VALUE The address to associate with the person is changed to the value entered. This address could be the person's street address.
    admin ADMIN_ACCESS_MASK {,ADMIN_ACCESS_MASK} The Business or System Administrator is restricted to the listed access. For the list of values for ADMIN_ACCESS_MASK, see Access Clause for the Add Person Command.
    application APPLICATION_NAME The person is assigned the named application. In case the person already has an owning application, the old application is replaced by the named application.
    assign [group GROUP_NAME] [role ROLE_NAME] The person is associated with the listed group or role.
    assign all The person is assigned to all groups and roles.
    comment VALUE The current comment, if any, is changed to the value entered.
    disable email Incoming messages are not sent to the email address.
    disable iconmail Incoming messages are not sent to IconMail.
    disable password Access can be set to the person only from a system where the O/S user is the same as the 3DEXPERIENCE platform user.
    email VALUE A valid electronic mail address is set for the person. This address must be in a form understood by the user's email utility.
    enable email Incoming messages are sent to the email address specified with the Email clause.
    enable iconmail Incoming messages are sent to IconMail.
    fax VALUE The person's fax number is changed or is set to the value entered.
    fullname VALUE The full name of the person is changed or is set to the value entered.
    icon FILENAMEThe specified icon is associated with the person.
    hidden The hidden option is changed to specify that the object is hidden.
    icon FILENAME The image is changed to the new image in the field specified.
    name VALUE The current person name is changed to the new name
    no password When setting context, there is no password required to access this person's context.
    nothidden The hidden option is changed to specify that the object is not hidden.
    password VALUE When setting context, the password is changed to the value entered.
    passwordexpired When setting context, a person must define a new password.
    neverexpire The person's password does not expire regardless of the password expires system setting.
    !neverexpire The neverexpire setting is removed and the person uses the system setting.
    phone VALUE The person's phone number is changed or is set to the value entered.
    property NAME [to ADMINTYPE NAME] [value STRING] The named property is modified.
    remove assign all The person is removed from all groups and roles. Any links the person has with any groups or roles is dissolved.
    remove assign [group GROUP_NAME] [role ROLE_NAME] The person is removed from the specified group or role.
    remove property NAME [to ADMINTYPE NAME] [value STRING] The named property is removed.
    type TYPE_ITEM {, TYPE_ITEM} The person is assigned or denied the privileges associated with the listed user types. For a list of the values for TYPE_ITEM, see Type Clause for the Add Person Command.
    vault vault_NAME The current vault is changed to the new vault.
    history STRING Adds a history record marked "custom" to the person that is being modified. The STRING argument is a free-text string that allows you to enter some information describing the nature of the modification. For more information, see Adding History to Administrative Objects.

Each modification clause is related to the clauses and arguments that define the person. For example, assume you want to alter the address and phone number of a person who moved. You could do so by writing a Modify Person command similar to the following:

modify person roosevelt
  address “White House, Pennsylvania Ave, Washington”
  phone “Unlisted”;

This command changes the address to that of the White House and designates the current phone number as “Unlisted.”

When modifying a person:

  • The roles or groups that you assign to the person must already be defined within the database. If they are not, an error will display when you try to assign them.
  • Access privileges are shared between roles and groups. Although a person is restricted access because of the group assignment, the user might have access via his/her role assignment. To restrict a user that has access or increase a person’s access, you will have to determine the best method for giving that access.

Remember that altering the group or role access affects everyone associated with that group or role. If it is a singular case of special access, you might want to assign that person to the policy directly or define a role that is exclusively used by the person in question.