site Command

A site consists of a set of locations and can be added to a person or group definition to specify location preferences.

For conceptual information on this command, see Locations and Sites.

This page discusses:

User Level

System Administrator

Add Site

Sites are nothing more than a set of locations. A site can be associated with a person or group object. When associated with a person, the site defines the list of locations preferred by a particular person. When associated with a group, the site defines the list of locations preferred by all members of the group.

Syntax

The enovia.ini file for the Studio Modeling Platform or 3DSpace Service could contain the following setting:

MX_SITE_PREFERENCE = SITENAME
  • SITENAME is the name of the site object.

This setting overrides the setting in the person or group definition for the site preference. It is particularly designed for use in the enovia.ini file for the 3DSpace Service, where all Web clients should use the site preference of the 3DSpace Service to ensure optimum performance. Refer to the Installation Guide for more information.

A site is defined with the Add Site command:

add site NAME [ADD_ITEM {ADD_ITEM}]

  • NAME is the name of the site you are defining. All sites must have a name unique in the database. The name can contain spaces. You should assign a name that has meaning to both you and the user. For more information, see About Administrative Object Names.
  • ADD_ITEM is an Add Site clause that provides more information about the site you are creating. The Add Site clauses are:
    [!|not]hidden
    description VALUE
    member location NAME
    property NAME [to ADMINTYPE NAME] [value STRING]
    history STRING

Member Clause

Use this clause to add locations to the site definition. The location named must exist in the database and the spelling and case must match exactly. If the location name contains embedded spaces, use quotation marks. For example:

add site "US Company" member location "Western Division";

History Clause

The history keyword adds a history record marked “custom” to the site that is being added. The STRING argument is a free-text string that allows you to enter some information describing the nature of the addition. For more information, see Adding History to Administrative Objects.

Modify Site

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

modify site NAME [MOD_ITEM {MOD_ITEM}];
  • NAME is the name of the site to modify.
  • MOD_ITEM is the type of modification to make. You only need to specify the fields to be modified.
    Modify Site Clause Specifies
    name NAME The site name is changed to the new name.
    description VALUE The description is changed to the new value specified.
    icon FILENAME The image is changed to the new image in the field specified.
    add location NAME The named location is added to the site definition.
    remove location NAME The named location is removed from the site definition.
    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.
    property NAME [to ADMINTYPE NAME] [value STRING] The existing property is modified according to the values specified.
    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.
    history STRING The history keyword adds a history record marked "custom" to the site 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.

Delete Site

If a site is no longer required, you can delete it. Since deleting a site affects all locations within that site, it is recommended that you make a backup prior to deletion. This protects you if you need access to files from that site at a later date. You might need to involve the DBA in the backup and restore process (if a restore is necessary).

To delete a site, use the Delete Site command:

delete site NAME;
  • NAME is the name of the site to be deleted.

This command searches the list of defined sites. If the name is not found, an error message is displayed. If the name is found, the site is deleted.