Application manifest structure
The manifest is a JSON file that describes to Guardium® the capabilities that the app provides.
The following table describes the fields that you can include in the
manifest.json file.
| Field | Required | Type | Description |
|---|---|---|---|
| description | Yes | String | The user-readable description of the app. If the application is globalized, this field can optionally point at a resource bundle. |
| name | Yes | String | The user-readable name of the app. If the app is globalized this field can optionally point at a resource bundle key. |
| navigation_areas | No | Array of Area Type | One or more objects describing the complete navigation pages of the application to be added to the Guardium UI navigation layout. Area objects are represented as tabs. |
| SDK_version | Yes | String |
A version string for your SDK (based on the Guardium version) structure: <Guardium version>.<SDK version>. Do not change this field. |
| sqlguard_ip | Yes | String | The IP address of the Guardium system that you want your application to communicate with. If not specified, the value of this field defaults to 127.0.0.1. |
| supported_unit_types | No | Array of Strings | Valid values: collector, aggregator, cm. Specify one or more values for this field to limit the ability to install this application on the specified unit types. |
| uuid | Yes | String | An RFC 4122-compliant universally unique identifier for the application. The create command uses the Python UUID package to generate a random 128-bit number for the uuid value. If you do not use the SDK to create the app manifest file, you must manually enter a unique value in the uuid field. |
| version | Yes | String | A version string for the app. You can use any format that you want here. |
The area type field descriptions are described in this table.
| Field | Required | Type | Description |
|---|---|---|---|
| id | Yes | String | A unique (within the application) area id |
| name | yes | String | A short descriptive name of the navigation entry point in the Guardium UI layout |
| description | No | String | An optional description of the area |
| url | Yes | String | A URL to load, relative to the application root. Only URLs that live within the Guardium application can be referenced. |
| default_roles | No | String array | An array of role names which should have access to this navigation area by default. If not specified “admin” is assumed. |