Deploying a gateway schema

You can develop the gateway schema and associated charting schemes by following the instructions in Developing schemas in your configuration development environment.

Note: If your deployment does not contain an Information or Chart Store, you must still provide a schema.xml file in the configuration. This can be an empty schema when you provide a gateway schema for any connectors to use.

After you develop the schemes, complete the following steps to deploy them with your configuration:

1. Copy the schema and charting scheme files to the /gateway-schemas directory.
   To define the short name of the gateway schema, the prefix of the file name is used. The convention is defined as: <short>-<name>-schema.xml and <short>-<name>-schema-charting-scheme.xml.
   For example, files with the names law-enforcement-schema.xml and law-enforcement-charting-schemes.xml have the short name law-enforcement.

2. Add the short name of your schema to the configs/<config_name>/configuration/connector-references.json file in the gatewaySchemas array.
   For example, to add a gateway schema with the short name law-enforcement, the file contains the following gatewaySchemas array:

   {
       ...
       ],
       "gatewaySchemas": [
           {
               "shortName": "law-enforcement"
           }
       ]
   }
   

   Note: If you are not using any gateway schemas, do not remove the gatewaySchemas key from the file.

3. Set the short name of your schema in the <connector_name>/connector-definition.json as the value for the gatewaySchema key of the connector that will use the gateway schema.