Creating a new entity schema

You can create a new entity schema for a custom application through the Schema Manager of the Control Compliance Suite Console. The entity schema defines the platform, entities, and fields of an asset for which data is to be collected. You can create a new entity schema only when you do not want to use any of the predefined platforms for data collection.

See About platforms.

For a new platform of a custom application, you must create and define the entities through the Create new entity schema wizard. Data of the custom application must be exported to a CSV file and arranged as per the defined CSV file format. The CSV file format requires headers, which are defined based on the entity schema that you create.

See Creating a CSV file .

After you create an entity, you must create the custom asset types, which are later imported into Control Compliance Suite using the Asset Import wizard.

See Creating a new asset type.

Note:

Every custom asset type that you create from a custom entity can scope to Site and the asset type itself when importing assets. The assets are imported using the Asset Import wizard.

To create a new entity schema

  1. Go to Settings > Schema Manager.

  2. Select Create new entity schema to launch the Create New Entity Schema wizard.

  3. In the Select or Create New Platform panel, select either option and click Next.

    Specify the values for the following fields:

    • Create new platform

    • Use existing platform

    See Create New Entity Schema: Select or Create New Platform.

  4. In the Specify Entity Details panel, enter the values for the fields and click Next.

    Specify the values for the following fields:

    • Name

    • Display name

    • Description

    • Extend an existing entity

    • Folder path

    See Create New Entity Schema: Specify Entity Details.

  5. In the Add Fields panel, click Add to add new fields for the entity.

  6. In the Create New Field dialog box, enter the values for the fields and click OK.

    Specify the values for the following fields:

    • Field name

    • Display name

    • Description

    • Type

    • Is case sensitive

    • Is array

    See Create New Entity Schema: Create New Field.

    The added field details are displayed in the Add Fields panel. You must check the option, Is primary key if you want to declare the field as a primary key. Unchecking the option makes the added fields optional.

    If you have extended a predefined entity (in the Specify Entity Details panel), then you must ensure that the number of primary keys for the creating entity is same as that of the extended entity.

  7. In the Add Fields panel, click Next.

  8. In the Specify Entity Name Fields panel, select the primary fields that are listed in the Available fields column and use the Add icon to add them to the Selected fields column.

    The fields that are selected constitute the name of the assets that are created for the entity, which in turn defines the asset type.

    See Create New Entity Schema: Specify Entity Name Fields.

    Click Next.

  9. In the Specify References panel, associate the fields of the entity with a parent entity and click Next.

    Select the Platform, Parent entity, and fields from the drop-down boxes for associating the created entity as a child entity and click Add.

    The panel lets you create relationship between the new entity and an entity of the predefined platform. A parent-child relationship is created between the entity of the predefined platform and the new entity that you are creating. You can associate the primary fields of the new entity with the primary fields of the parent entity to create a parent-child relationship. The parent-child relationship lets you collect data for the parent entity along with the child entity.

    See Create New Entity Schema: Specify References.

    When you extend an entity, you must create a reference with the extended entity. You can also create a reference with the entity with which the extended entity shares a relationship. The relationship between the predefined entities are defined in Control Compliance Suite.

    See About relationships between the predefined entities.

  10. In the Summary panel, review the details of the created entity and click Finish.

    See Create New Entity Schema: Summary.

More Information

Extending an existing entity schema