Context configuration file

This is the description of the JSON configuration file for a Context data operation.

The configuration file is in JSON format. It contains the following sections:

• Global parameters: General information about the data operation.

• Constant parameters: Information related to the constants to set.

👁️‍🗨️ Example

Here is an example of Context configuration file:

{
	"$schema": "http://jsonschema.tailer.ai/schema/context-veditor",
	"configuration_type": "context",
	"configuration_id": "context_dev",
	"environment": "DEV",
	"account": "000099",
	"doc_md": "readme.md",
	"gcp_project_id": "fd-io-jarvis-demo-dlk",
	"activated": true,
	"archived": false,
	"parameters": {
		"test_integer": {
			"value": 123456,
			"type": "integer",
			"resource": "value",
			"description": "Some random value"
		},
		"test_float": {
			"value": 123456.78910,
			"type": "float",
			"resource": "value",
			"description": "Some random value"
		},
		"test_boolean": {
			"value": true,
			"type": "boolean",
			"resource": "value",
			"description": "Some random value"
		},
		"gcp_project_id_exc": {
			"value": "fd-io-jarvis-demo-exc",
			"type": "string",
			"resource": "gcp_project_id",
			"description": "The Default Exchange GCP Project ID"
		},

		"gcs_source_bucket_n_in": {
			"value": "fd-io-exc-demo-n-in",
			"type": "string",
			"resource": "gcs_bucket",
			"description": "The Default Exchange Source IN Bucket ID"
		},

		"gcp_credentials_secret_source_n_in": {
			"value": {
				"cipher_aes": "xxx",
				"ciphertext": "xxx",
				"enc_session_key": "xxx",
				"tag": "xxx"
			},
			"type": "object",
			"resource": "gcp_credentials_secret",
			"description": "The GCP Credentials used to load data from the gcp_credentials_secret_source_n_in bucket"
		},

		"gcp_project_id_dlk": {
			"value": "fd-io-jarvis-demo-dlk",
			"type": "string",
			"resource": "gcp_project_id",
			"description": "The Default Exchange GCP Project ID"
		},

		"gcs_mirror_bucket_n_in": {
			"value": "mirror-fd-io-demo-n-in",
			"type": "string",
			"resource": "gcs_bucket",
			"description": "The Default Exchange Mirror IN Bucket ID"
		},

		"gcp_credentials_secret_mirror_n_in": {
			"value": {
				"cipher_aes": "xxx",
				"ciphertext": "xxx",
				"enc_session_key": "xxx",
				"tag": "xxx"
			},
			"type": "object",
			"resource": "gcp_credentials_secret",
			"description": "The GCP Credentials used to store data in the gcp_credentials_secret_mirror_n_in bucket"
		},

		"gcp_credentials_secret_bigquery_dlk": {
			"value": {
				"cipher_aes": "xxx",
				"ciphertext": "xxx",
				"enc_session_key": "xxx",
				"tag": "xxx"
			},
			"type": "object",
			"resource": "gcp_credentials_secret",
			"description": "The GCP Credentials used to load data in the gcp_project_id_dlk Bigquery"
		}
	}
}

🌐 Global parameters

General information about the configuration.

Parameter	Description
$schema type: string optional	The url of the json-schema that contains the properties that your configuration must verify. Most Code Editor can use that to validate your configuration, display help boxes and enlighten issues.
configuration_type type: string mandatory	Type of configuration. For an Context configuration, the value is always "context".
configuration_id type: string mandatory	ID of the configuration. You can pick any name you want, but is has to be unique for this configuration type in your account. For this configuration, the account is added as a prefix to your configuration_id to generate the definitive configuration id that will be displayed in Tailer Studio. Note that in case of conflict, the newly deployed configuration will overwrite the previous one.
environment type: string mandatory	Deployment environment. Values: PROD, PREPROD, STAGING, DEV.
account type: string mandatory	Your account ID is a 6-digit number assigned to you by your Tailer Platform administrator.
doc_md type: string mandatory	Path to a file containing a detailed description of the data operation. The file must be in Markdown format.
gcp_project_id type: string mandatory	Main Google Cloud Platform project ID for this configuration. A same Context can be used for several GCP projects so this gcp project ID is not limitative. If not specified, then you'll be asked to provide it at the deployment.
activated type: boolean optional	Flag used to enable/disable the execution of the data operation. If not specified, the default value will be "true".
archived type: boolean optional	Flag used to enable/disable the visibility of the data operation's configuration and runs in Tailer Studio. If not specified, the default value will be "false".

🔣 Constant parameters

Information related to the constants to set.

Parameter	Description
parameters type: array mandatory	Array containing a list of constants, all of them including a name, and the parameters listed below.
value type: string mandatory	Value that will be used to replace the placeholder in data operation configuration files.
type type: string mandatory	Type of constant. Possible values: integer string float object
resource type: string mandatory	Type of resource. Possible values: value gcp_project_id gcs_bucket gcp_credentials_secret
description type: string mandatory	Description of the constant.