Share via

Area Security Configuration Structure and Files

  • Article

The file config\master_security_config.xml specifies ASP files that define the specific security definitions for various security areas. These ASP files provide security definitions for their corresponding areas by returning XML in the structure defined in this topic. Commerce Server 2002 includes two such files: config\bd_catalog_security_config.asp and config\bd_users_security_config.asp, which define the security definitions for the security areas "catalog" and "profile", respectively. Refer to these files as models for creating similar files for any new security areas you define.

XML Structure

<config>
  <areadisplayname>
    <entities/>
      <entitydisplay_name id >
        <elements>
          <elementdisplay_name id />
          . . .
        </elements>
        <rights>
          <rightdisplay_nameid />
          . . .
        </rights>
      </entity>
      . . .
    </entities>
    . . .
  </area>
</config>

config

This required element contains the security configuration information for a particular security area.

  • Parent Element
    None (document root).
  • Required Child Elements
    area (at least one).
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

None.

Return to XML Structure

area

This required element defines a Business Desk security area and contains all the elements and rights for that area.

  • Parent Element
    None (document root).
  • Required Child Elements
    entities
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

Attribute Description
displayname Specifies a display name for this security area.

Required.

Legal values: Valid strings.

Default value: None.

This display name will be used in the Business Desk Security module.

Return to XML Structure

entities

This required element contains the definitions of the security entities for this security area.

  • Parent Element
    area
  • Required Child Elements
    entity (at least one is required).
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

None.

Remarks

Security entities are conceptual categories of things that can be secured. For example, in the Business Desk Framework the built-in entities are "bdfw_category", "bdfw_module", and a dynamically-named entity for each task on an action page.

Return to XML Structure

entity

This required element contains the definitions of the security elements and rights for this entity.

  • Parent Element
    entities
  • Required Child Elements
    elements, rights (one of each)
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

Attribute Description
displayname Specifies a display name for this security entity.

Required.

Legal values: Valid strings.

Default value: None.

This display name will be used in the Business Desk Security module.
id Specifies an internal identifier for this security entity.

Required.

Legal values: Valid strings.

Default value: None.

This identifier must be unique across all entities, regardless of the security area for which it is defined. This is why the Business Desk Framework, Profiling System, and the Product Catalog System all of define entities with a prefix that will make them unique: for instance the Product Catalog System defines “catalog_properties” instead of just “properties”.

This identifier will be returned as the Entity field in Recordset objects returned by the methods of the BizDeskSecurity object.

Remarks

A security entity is a conceptual category of things that can be secured. For example, the catalog "area" pre-defines the entities "property" and "catalog".

Return to XML Structure

elements

This required element contains the security elements defined for a particular security entity.

  • Parent Element
    entity
  • Required Child Elements
    element (at least one is required).
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

None.

Remarks

Security elements are particular instances of a particular kind of security entity. For example, in the Business Desk Framework each of the modules defined in the module configuration files are security elements associated with the security entity "module".

Return to XML Structure

element

This required element specifies a particular security element for a particular security entity.

  • Parent Element
    elements
  • Required Child Elements
    None.
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

Attribute Description
displayname Specifies a display name for a security element associated with a particular security entity.

Required.

Legal values: Valid strings.

Default value: None.

This display name will be used in the Business Desk Security module.
id Specifies an internal identifier for this security element.

Required.

Legal values: Valid strings.

Default value: None.

This identifier will be returned as the Element field in Recordset objects returned by the methods of the BizDeskSecurity object.

Remarks

A security element is a particular instance of a particular kind of security entity. For example, the catalog "area" pre-defines the element "SKU" for its "property" entity.

Return to XML Structure

rights

This required element contains the security rights defined for a particular security entity.

  • Parent Element
    entity
  • Required Child Elements
    right (at least one is required).
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

None.

Remarks

Security rights represent the various actions that are subject to being allowed or denied for a particular kind of security entity. For example, the catalog "area" only defines a single type of right, "edit", for both of its entities.

Return to XML Structure

This required element defines a type of action that will be allowed or denied for a particular security element of a particular security entity.

  • Parent Element
    rights
  • Required Child Elements
    None.
  • Optional Child Elements
    None.
  • Data
    None.

Attributes

Attribute Description
displayname Specifies a display name for a security right associated with a particular security element of a particular security entity.

Required.

Legal values: Valid strings.

Default value: None.

This display name will be used in the Business Desk Security module.
id Specifies an internal identifier for this security right.

Required.

Legal values: Valid strings.

Default value: None.

This identifier will be returned as the Right field in Recordset objects returned by the methods of the BizDeskSecurity object.

Remarks

Because security rights define actions that can be allowed or denied, their display names are most commonly expressed as verbs, such as "edit" or "read".

Return to XML Structure

Copyright © 2005 Microsoft Corporation.
All rights reserved.