Security metadata schema

The security metadata schema is used to create property fields which appear in the security metadata of collectionsA collection is a container for storing and organising ingested files and documents. Only the textual content is stored in collections, not the original files and documents. and networksA network is a visual summary, generated by Sintelix, of the information in one or more documents..

Security metadata is assigned by entering values into these property fields.

Multiple property fields can be created in the security metadata schema.

Child element tags

Table 1: Child element tags in the security metadata schema

Tag

Description

<property>

Property fields are created in the security model's security metadata schema with the <property> tag.

The <property> tag (when used in the security metadata schema) has six attributes:

 

class

Accepts a value of string or enumeration.

string is used for normal property fields that can accept any user created value.

enumeration is used to create a property field with selectable values.

Selectable values are defined within additional <value> tags.

 

name

Accepts any continuous text value.

This is the value that gets referenced when security model rules are created.

 

label

Accepts any continuous text value.

This is the display name of the property field in the Sintelix user interface.

 

min-occurs

Defines the minimum number of values a property field can accept.

Normally set to zero or one.

 

max-occurs

Defines the maximum number of values a property field can accept.

If there is no limit, this should be to zero.

 

merge-type

Accepts a value of HIGHEST or INTERSECTION.

HIGHEST assigns the highest security clearance value to a new Collection or Network which is created from a combination of content with different security clearance values (normally used when the <property> tag class is string).

INTERSECTION assigns the shared security clearance values to a new Collection or Network which is created from a combination of content with different security clearance values (normally used when the <property> tag class is enumeration).

<value>

<value> tags are used to define a selection of values that can be entered in a property field.

Code examples

Table 2: Code examples for common implementations of the security metadata schema

Task

Code example and Sintelix UI output

Create a Security Metadata property field that accepts unlimited values

<security-metadata-schema>

<property class="string" min-occurs="0" max-occurs="0" name="access" label="Access" />merge-type="INTERSECTION" />

Sintelix UI output on Collections > Collection >Collection Configuration > Security Metadata pane:

Create a Security Metadata property field that accepts a maximum of one value

<security-metadata-schema>

<property class="string" min-occurs="0" max-occurs="1" name="access" label="Access" merge-type="INTERSECTION" />

</security-metadata-schema>

Sintelix UI output as shown above.

Create a Security Metadata property field that must have exactly one value

<security-metadata-schema>

<property class="string" min-occurs="1" max-occurs="1" name="access" label="Access" merge-type="INTERSECTION" />

</security-metadata-schema>

Sintelix UI output as shown above.

Create a Security Metadata property field that must have one value from a selection of predefined options

<security-metadata-schema>

<property name="classification" class="enumeration" label="Security Classification"
min-occurs="1" max-occurs="1" merge-type="HIGHEST"><value>UNCLASSIFIED</value><value>PROTECTED</value>
<value>CONFIDENTIAL</value><value>SECRET</value><value>TOP SECRET</value></property>

</security-metadata-schema>

Sintelix UI output:

 

fontfontfont