Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add v4.1.0 of event-logging xml schema #56

Closed
wants to merge 13 commits into from
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ An XML Schema standard for describing audit events.

| Pack version | Stroom 5.0.x | Stroom 6.0.x | Stroom 7.0.x |
| --------------------------------------------------------------------------------------------- | ------------ | ------------ | -------------|
| [v4.1.0](https://github.com/gchq/stroom-content/releases/tag/event-logging-xml-schema-v4.1.0) | Y | Y | Y |
| [v4.0.0](https://github.com/gchq/stroom-content/releases/tag/event-logging-xml-schema-v4.0.0) | Y | Y | Y |
| [v3.4.2](https://github.com/gchq/stroom-content/releases/tag/event-logging-xml-schema-v3.4.2) | Y | Y | Y |
| [v3.2.3](https://github.com/gchq/stroom-content/releases/tag/event-logging-xml-schema-v3.2.3) | Y | Y | Y |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=analytic-output v1.0
path=XML Schemas/analytic-output
type=XMLSchema
uuid=d1cf8a3b-fd1d-403d-bbd0-ca5c9150cf98
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=annotation v1.0
path=XML Schemas/analytic-output
type=XMLSchema
uuid=276ff629-1980-4146-8d68-d21967566afc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=detection v1.1
path=XML Schemas/analytic-output
type=XMLSchema
uuid=cce4a385-a3fe-4ab6-9356-90f8057f0ebf
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=analytic-output
path=XML Schemas
type=Folder
uuid=f192cdb7-b6a7-4959-a47e-5e35f618503f
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=data-splitter v3.0
path=XML Schemas/data-splitter
type=XMLSchema
uuid=9e1e2567-ba83-4720-95c0-f882b951bd3e
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=data-splitter
path=XML Schemas
type=Folder
uuid=f192cdb7-b6a7-4959-a47e-5e35f618505f
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
~ Copyright 2016 - 2023 Crown Copyright
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<xs:schema xmlns:doc="index-documents:1" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="index-documents:1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0" id="index-documents-v1.0">
<xs:annotation>
<xs:documentation>This schema describes the allowed element structure for document indexing.</xs:documentation>
</xs:annotation>
<xs:element name="index-documents">
<xs:annotation>
<xs:documentation>The root element that contains multiple document elements.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="document" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A single document that we want to index.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="field" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>This is a field in the document.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="name" type="xs:string" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>The name of the field.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="doc:FieldTypeSimpleType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>The data type of the field. If omitted this defaults to 'Text'.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="analyser" type="doc:AnalyserSimpleType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>How should we analyse this field. This affects how the field can be searched by altering the way the field value is indexed. If omitted this defaults to 'Keyword'.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="indexed" type="xs:boolean" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Is this an indexed field, i.e. can it be searched or is it just for display. If omitted this value is true by default.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="stored" type="xs:boolean" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Should the value of the field be stored in the index? If omitted this value is false by default.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="termPositions" type="xs:boolean" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Should we store term positions (needed for sentence searching). If omitted this value is false by default.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="caseSensitive" type="xs:boolean" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Is the field case sensitive. If omitted this value is false by default.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="value" type="xs:string" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>The value of the field.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="version" type="doc:VersionSimpleType" use="required" />
</xs:complexType>
</xs:element>
<xs:simpleType name="FieldTypeSimpleType">
<xs:restriction base="xs:string">
<xs:enumeration value="Id" />
<xs:enumeration value="Boolean" />
<xs:enumeration value="Integer" />
<xs:enumeration value="Long" />
<xs:enumeration value="Float" />
<xs:enumeration value="Double" />
<xs:enumeration value="Date" />
<xs:enumeration value="Text" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AnalyserSimpleType">
<xs:restriction base="xs:string">
<xs:enumeration value="Keyword" />
<xs:enumeration value="Alpha" />
<xs:enumeration value="Numeric" />
<xs:enumeration value="Alpha numeric" />
<xs:enumeration value="Whitespace" />
<xs:enumeration value="Stop words" />
<xs:enumeration value="Standard" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="VersionSimpleType">
<xs:annotation>
<xs:documentation>Type for specifying the version numbers of XML documents that are supported by this version of the XMLSchema.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="1.0" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=index_documents v1.0
path=XML Schemas/index-documents
type=XMLSchema
uuid=b5c7bd44-ca00-448d-ba64-66b48f926ec4
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.1" encoding="UTF-8"?>
<xmlSchema>
<deprecated>false</deprecated>
<description/>
<name>index-documents v1.0</name>
<namespaceURI>index-documents:1</namespaceURI>
<schemaGroup>INDEX_DOCUMENTS</schemaGroup>
<systemId>file://index-documents-v1.0.xsd</systemId>
<uuid>b5c7bd44-ca00-448d-ba64-66b48f926ec4</uuid>
</xmlSchema>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=index-documents
path=XML Schemas
type=Folder
uuid=a66d8fd3-79ee-4bbd-9845-90cc6b1cad04
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.1" encoding="UTF-8"?>
<folder>
<name>index-documents</name>
<uuid>a66d8fd3-79ee-4bbd-9845-90cc6b1cad04</uuid>
</folder>
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=json
path=XML Schemas
type=Folder
uuid=63091e21-1716-40a0-af5b-961379f4b614
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=json
path=XML Schemas/json
type=XMLSchema
uuid=5dd0956b-2e8b-4d6e-9a3e-8e3756dae746
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=xpath-functions
path=XML Schemas/json
type=XMLSchema
uuid=bdba7b54-7ba1-4ada-9c7f-6ff33d538aaa
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=kafka-records v1.1
path=XML Schemas/kafka-records
type=XMLSchema
uuid=b3c7bd44-ca00-448d-ba64-66b48f926ec4
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=kafka-records
path=XML Schemas
type=Folder
uuid=fa512fd6-441b-4420-a2a3-98527af9f93c
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=records
path=XML Schemas
type=Folder
uuid=c66d8fd3-79ee-4bbd-9845-90cc6b1cad04
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=records v2.0
path=XML Schemas/records
type=XMLSchema
uuid=47f062d9-8191-4535-b35b-74c6f020320f
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=reference-data v2.0.1
path=XML Schemas/reference-data
type=XMLSchema
uuid=848d11d1-381e-4cc8-9f23-acfd68189f62
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=reference-data
path=XML Schemas
type=Folder
uuid=6da6691c-02ac-4a39-971c-881bf6da5c31
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=statistics
path=XML Schemas
type=Folder
uuid=790194ae-91b8-48f0-b76f-d91dad2429fd
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=statistics v2.0
path=XML Schemas/statistics
type=XMLSchema
uuid=82e6393a-b19d-4970-9dae-e095e7a6d4bc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=statistics v3.0
path=XML Schemas/statistics
type=XMLSchema
uuid=207ac11d-e2ce-4e18-af56-5b54ccb726b6
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=statistics v4.0
path=XML Schemas/statistics
type=XMLSchema
uuid=d1b24f3b-a720-46d6-b6ee-fefbd4472ea0
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=XML Schemas
path=
type=Folder
uuid=9e694c1e-1466-4b43-9b34-707befcc17e1
8 changes: 8 additions & 0 deletions source/event-logging-xml-schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ The following represents the folder structure and content that will be imported

* _XML Schemas_
* _event-logging_
* **event-logging v4.1.0** `XMLSchema`

Version 4.1.0 of the event-logging XMLSchema.

* **event-logging v4.0.0** `XMLSchema`

Version 4.0.0 of the event-logging XMLSchema.

* **event-logging v3.4.2** `XMLSchema`

Version 3.4.2 of the event-logging XMLSchema.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=event-logging v3.0.0
path=XML Schemas/event-logging
type=XMLSchema
uuid=4fe14042-770e-4297-8711-d92e607bc4d5
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=event-logging v3.1.1
path=XML Schemas/event-logging
type=XMLSchema
uuid=49b33626-9c71-4709-be56-d3e712d52f6e
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=event-logging v3.1.2
path=XML Schemas/event-logging
type=XMLSchema
uuid=9ccd3485-dbb6-4379-9f5c-f8e059c5e06d
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=event-logging v3.2.3
path=XML Schemas/event-logging
type=XMLSchema
uuid=02f10b89-0b12-400f-9834-89960a61f511
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=event-logging v3.4.2
path=XML Schemas/event-logging
type=XMLSchema
uuid=99a13bb0-61b9-4fad-b6c6-5bba58269303
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name=event-logging v4.0.0
path=XML Schemas/event-logging
type=XMLSchema
uuid=2129f1ed-9554-4bff-8cdc-cec8d1e38133
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.1" encoding="UTF-8"?>
<xmlSchema>
<deprecated>false</deprecated>
<description/>
<name>event-logging v4.0.0</name>
<namespaceURI>event-logging:3</namespaceURI>
<schemaGroup>EVENTS</schemaGroup>
<systemId>file://event-logging-v4.0.0.xsd</systemId>
<uuid>2129f1ed-9554-4bff-8cdc-cec8d1e38133</uuid>
</xmlSchema>
Loading
Loading