$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 data operation.
For a Convert XML to CSV data operation, the value is always "xml-conversion".
| |configuration\_id
type: string
mandatory
|ID of the data operation.
You can pick any name you want, but is has to be unique for this data operation type.
Note that in case of conflict, the newly deployed data operation will overwrite the previous one. To guarantee its uniqueness, the best practice is to name your data operation by concatenating:
environment
type: string
mandatory
|Deployment context.
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. | |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".
| |doc\_md
type: string
optional
| Path to a file containing a detailed description of the data operation. The file must be in Markdown format. | ## :briefcase: Working folder parameters Information related to the input/output working directory in Google Cloud Storage. | Parameter | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |gcp\_project\_id
type: string
mandatory
| Google Cloud Platform project ID for the bucket where the data is going to be converted. | |gcs\_bucket
type: string
mandatory
| Name of the GCS bucket where the data is going to be converted. | |gcs\_working\_directory
type: string
mandatory
| Path in the GCS bucket where the input files will be placed, and the output files generated, e.g. "some/sub/dir". | |gcp\_credentials\_secret
type: dict
mandatory
|Encrypted credentials needed to read and write data in the GCS bucket.
You should have generated credentials when setting up GCP. To learn how to encrypt them, refer to this page.
| ## :currency\_exchange: Conversion parameters Information about the input file to process and the output files generated. | Parameter | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |filename\_templates
type: array
mandatory
| Array containing one or several **filename\_template** parameters (see below). | |filename\_template
type: string
mandatory
|When a file with a name matching the template set here is added to the specified GCS folder, the conversion will be launched automatically.
The following placeholders are currently supported:
Example 1
This template:
"stores\_{{FD\_DATE}}{{FD\_TIME}}.txt"
will allow you to process this type of files:
"stores\_20201116\_124213.txt"
Example 2
This template:
"{{FD\_DATE}}{{FD\_BLOB\_5}}fixedvalue{{FD\_BLOB\_11}}.gz"
will allow you to process this type of files:
"20201116\_12397\_fixedvalue\_12312378934.gz"
| |file\_description
type: string
mandatory
| A short description of the file template entry. | |xsd\_schema\_file
type: string
mandatory
|Name of the XSD file that will be used to validate the XML file before the conversion.
In the current version, only one XSD can be used per XML entry.
The XSD file name must be identical to the corresponding XML file name, excluding suffixes. For example "coupon.xsd" can be used to validate "coupon\_20210404.xml".
output\_suffix\_filters
type: array of string
optional
|Names of the output files to be kept after the conversion.
If the XML file contains many child entities, the conversion will create a lot of CSV files (one for each entity). This filter allows you to prevent unnecessary file upload to the output bucket.
It works by finding an occurrence of the string in the filename. For example, if a file named "coupon\_20210404\_advantage.tsv" is generated and the filter "advantage.tsv" was added, then this file will be kept.
|