FCP Report definition schema > typeFCP Report definition schema > versionFCP Report definition schema > nameFCP Report definition schema > revisionFCP Report definition schema > transportFCP Report definition schema > smtp
FCP Report definition schema > smtp > serverFCP Report definition schema > smtp > protocolFCP Report definition schema > smtp > authFCP Report definition schema > smtp > userFCP Report definition schema > smtp > passwordFCP Report definition schema > smtp > fromFCP Report definition schema > smtp > encryptFCP Report definition schema > zendto
FCP Report definition schema > zendto > urlFCP Report definition schema > zendto > encryptFCP Report definition schema > zendto > senderorgFCP Report definition schema > zendto > senderemailFCP Report definition schema > zendto > userFCP Report definition schema > zendto > passwordFCP Report definition schema > sendFCP Report definition schema > errors_toFCP Report definition schema > prepare
FCP Report definition schema > prepare > prepare items > nameFCP Report definition schema > prepare > prepare items > continue_on_errorFCP Report definition schema > prepare > prepare items > disabledFCP Report definition schema > prepare > prepare items > groupidFCP Report definition schema > prepare > prepare items > optionsFCP Report definition schema > prepare > prepare items > send_toFCP Report definition schema > prepare > prepare items > errors_toFCP Report definition schema > prepare > prepare items > copyFCP Report definition schema > prepare > prepare items > fcpc
FCP Report definition schema > prepare > prepare items > tag
FCP Report definition schema > prepare > prepare items > untag
FCP Report definition schema > prepare > prepare items > job
FCP Report definition schema > prepare > prepare items > search
FCP Report definition schema > prepare > prepare items > search > queryFCP Report definition schema > prepare > prepare items > search > uniqueFCP Report definition schema > prepare > prepare items > search > outputFCP Report definition schema > prepare > prepare items > search > output_typeFCP Report definition schema > prepare > prepare items > search > output_formatFCP Report definition schema > prepare > prepare items > search > columnsFCP Report definition schema > prepare > prepare items > view
FCP Report definition schema > items
FCP Report definition schema > items > items items > disabledFCP Report definition schema > items > items items > send_toFCP Report definition schema > items > items items > errors_toFCP Report definition schema > items > items items > fcpc
FCP Report definition schema > items > items items > view
FCP Report definition schema > items > items items > view > nameFCP Report definition schema > items > items items > view > actionFCP Report definition schema > items > items items > view > output_formatFCP Report definition schema > items > items items > view > columnsFCP Report definition schema > items > items items > template
FCP Report definition schema > items > items items > search
FCP Report definition schema > items > items items > search > queryFCP Report definition schema > items > items items > search > outputFCP Report definition schema > items > items items > search > output_typeFCP Report definition schema > items > items items > search > output_formatFCP Report definition schema > items > items items > search > columnsFCP Report definition schema > subreports
FCP Report definition schema > subreports > subreports items > disabledFCP Report definition schema > subreports > subreports items > nameFCP Report definition schema > subreports > subreports items > groups
FCP Report definition schema > subreports > subreports items > groups > input_csvFCP Report definition schema > subreports > subreports items > groups > output_csvFCP Report definition schema > subreports > subreports items > groups > tag_prefixFCP Report definition schema > subreports > subreports items > groups > tag_attrFCP Report definition schema > subreports > subreports items > groups > email_attrFCP Report definition schema > subreports > subreports items > groups > dir_attrFCP Report definition schema > subreports > subreports items > groups > name_attrFCP Report definition schema > subreports > subreports items > groups > description_attrFCP Report definition schema > subreports > subreports items > input_directoryFCP Report definition schema > subreports > subreports items > output_directoryFCP Report definition schema > onfinish
Title: FCP Report definition schema
| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
Description: FCP Report definition schema
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - type | No | const | No | - | Type of document. Must be fcpreport |
| + version | No | enum (of string) | No | - | Version of the schema |
| + name | No | string | No | - | Report name |
| - revision | No | string | No | - | Revision of the report |
| - transport | No | enum (of string) | No | - | - |
| - smtp | No | object | No | - | - |
| - zendto | No | object | No | - | - |
| - send | No | object | No | - | - |
| - errors_to | No | array | No | - | Emails to send errors to |
| - prepare | No | array of object | No | - | - |
| + items | No | array of object | No | - | - |
| - subreports | No | array of object | No | - | - |
| - onfinish | No | array of object | No | - | - |
FCP Report definition schema > type| Type | const |
| Required | No |
Description: Type of document. Must be fcpreport
Specific value: "fcpreport"
FCP Report definition schema > version| Type | enum (of string) |
| Required | Yes |
Description: Version of the schema
Must be one of:
FCP Report definition schema > name| Type | string |
| Required | Yes |
Description: Report name
FCP Report definition schema > revision| Type | string |
| Required | No |
Description: Revision of the report
FCP Report definition schema > transport| Type | enum (of string) |
| Required | No |
Must be one of:
FCP Report definition schema > smtp| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + server | No | string | No | - | - |
| + protocol | No | enum (of string) | No | - | - |
| - auth | No | boolean | No | - | - |
| - user | No | string | No | - | - |
| - password | No | string | No | - | - |
| + from | No | string | No | - | - |
| - encrypt | No | string | No | - | - |
FCP Report definition schema > smtp > server| Type | string |
| Required | Yes |
FCP Report definition schema > smtp > protocol| Type | enum (of string) |
| Required | Yes |
Must be one of:
FCP Report definition schema > smtp > auth| Type | boolean |
| Required | No |
FCP Report definition schema > smtp > user| Type | string |
| Required | No |
FCP Report definition schema > smtp > password| Type | string |
| Required | No |
FCP Report definition schema > smtp > from| Type | string |
| Required | Yes |
FCP Report definition schema > smtp > encrypt| Type | string |
| Required | No |
FCP Report definition schema > zendto| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + url | No | string | No | - | - |
| - encrypt | No | string | No | - | - |
| + senderorg | No | string | No | - | - |
| + senderemail | No | string | No | - | - |
| + user | No | string | No | - | - |
| + password | No | string | No | - | - |
FCP Report definition schema > zendto > url| Type | string |
| Required | Yes |
FCP Report definition schema > zendto > encrypt| Type | string |
| Required | No |
FCP Report definition schema > zendto > senderorg| Type | string |
| Required | Yes |
FCP Report definition schema > zendto > senderemail| Type | string |
| Required | Yes |
FCP Report definition schema > zendto > user| Type | string |
| Required | Yes |
FCP Report definition schema > zendto > password| Type | string |
| Required | Yes |
FCP Report definition schema > send| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
FCP Report definition schema > errors_to| Type | array |
| Required | No |
Description: Emails to send errors to
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare| Type | array of object |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| prepare items | - |
| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - name | No | string | No | - | - |
| - continue_on_error | No | boolean | No | - | - |
| - disabled | No | boolean | No | - | - |
| - groupid | No | string | No | - | - |
| - options | No | array | No | - | Commandline options to use |
| - send_to | No | array | No | - | Emails to send finished report to |
| - errors_to | No | array | No | - | Emails to send errors to |
| - copy | No | array | No | - | - |
| - fcpc | No | object | No | - | - |
| - tag | No | object | No | - | - |
| - untag | No | object | No | - | - |
| - job | No | object | No | - | - |
| - search | No | object | No | - | - |
| - view | No | object | No | - | - |
FCP Report definition schema > prepare > prepare items > name| Type | string |
| Required | No |
FCP Report definition schema > prepare > prepare items > continue_on_error| Type | boolean |
| Required | No |
FCP Report definition schema > prepare > prepare items > disabled| Type | boolean |
| Required | No |
FCP Report definition schema > prepare > prepare items > groupid| Type | string |
| Required | No |
FCP Report definition schema > prepare > prepare items > options| Type | array |
| Required | No |
Description: Commandline options to use
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare > prepare items > send_to| Type | array |
| Required | No |
Description: Emails to send finished report to
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare > prepare items > errors_to| Type | array |
| Required | No |
Description: Emails to send errors to
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare > prepare items > copy| Type | array |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare > prepare items > fcpc| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - cmd | No | array | No | - | Command to run |
FCP Report definition schema > prepare > prepare items > fcpc > cmd| Type | array |
| Required | No |
Description: Command to run
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare > prepare items > tag| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + query | No | string | No | - | - |
| + tag | No | string | No | - | - |
| - also | No | array of enum (of string) | No | - | - |
FCP Report definition schema > prepare > prepare items > tag > query| Type | string |
| Required | Yes |
FCP Report definition schema > prepare > prepare items > tag > tag| Type | string |
| Required | Yes |
FCP Report definition schema > prepare > prepare items > tag > also| Type | array of enum (of string) |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| also items | - |
| Type | enum (of string) |
| Required | No |
Must be one of:
FCP Report definition schema > prepare > prepare items > untag| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + query | No | string | No | - | - |
| + tag | No | string | No | - | - |
FCP Report definition schema > prepare > prepare items > untag > query| Type | string |
| Required | Yes |
FCP Report definition schema > prepare > prepare items > untag > tag| Type | string |
| Required | Yes |
FCP Report definition schema > prepare > prepare items > job| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | - |
| + action | No | enum (of string) | No | - | Action to do with job |
FCP Report definition schema > prepare > prepare items > job > name| Type | string |
| Required | Yes |
FCP Report definition schema > prepare > prepare items > job > action| Type | enum (of string) |
| Required | Yes |
| Default | "execute" |
Description: Action to do with job
Must be one of:
FCP Report definition schema > prepare > prepare items > search| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + query | No | string | No | - | Query to use |
| - unique | No | boolean | No | - | - |
| + output | No | string | No | - | Output file name (relative to output dir) |
| - output_type | No | enum (of string) | No | - | Output type for export |
| + output_format | No | enum (of string) | No | - | Output format for export |
| - columns | No | array | No | - | Columns to be used within report |
FCP Report definition schema > prepare > prepare items > search > query| Type | string |
| Required | Yes |
Description: Query to use
FCP Report definition schema > prepare > prepare items > search > unique| Type | boolean |
| Required | No |
FCP Report definition schema > prepare > prepare items > search > output| Type | string |
| Required | Yes |
Description: Output file name (relative to output dir)
FCP Report definition schema > prepare > prepare items > search > output_type| Type | enum (of string) |
| Required | No |
| Default | "table" |
Description: Output type for export
Must be one of:
FCP Report definition schema > prepare > prepare items > search > output_format| Type | enum (of string) |
| Required | Yes |
Description: Output format for export
Must be one of:
FCP Report definition schema > prepare > prepare items > search > columns| Type | array |
| Required | No |
Description: Columns to be used within report
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > prepare > prepare items > view| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | Views name |
| + action | No | enum (of string) | No | - | Action to do with views |
FCP Report definition schema > prepare > prepare items > view > name| Type | string |
| Required | Yes |
Description: Views name
FCP Report definition schema > prepare > prepare items > view > action| Type | enum (of string) |
| Required | Yes |
| Default | "execute" |
Description: Action to do with views
Must be one of:
FCP Report definition schema > items| Type | array of object |
| Required | Yes |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| items items | - |
| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - disabled | No | boolean | No | - | - |
| - send_to | No | array | No | - | Emails to send finished report to |
| - errors_to | No | array | No | - | Emails to send errors to |
| - fcpc | No | object | No | - | - |
| - view | No | object | No | - | - |
| - template | No | object | No | - | - |
| - search | No | object | No | - | - |
FCP Report definition schema > items > items items > disabled| Type | boolean |
| Required | No |
FCP Report definition schema > items > items items > send_to| Type | array |
| Required | No |
Description: Emails to send finished report to
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > items > items items > errors_to| Type | array |
| Required | No |
Description: Emails to send errors to
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > items > items items > fcpc| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - cmd | No | array | No | - | Command to run |
FCP Report definition schema > items > items items > fcpc > cmd| Type | array |
| Required | No |
Description: Command to run
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > items > items items > view| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | Views name |
| + action | No | enum (of string) | No | - | Action to do with views |
| - output_format | No | enum (of string) | No | - | Output format for export |
| - columns | No | array | No | - | Columns to be used within report |
FCP Report definition schema > items > items items > view > name| Type | string |
| Required | Yes |
Description: Views name
FCP Report definition schema > items > items items > view > action| Type | enum (of string) |
| Required | Yes |
| Default | "export" |
Description: Action to do with views
Must be one of:
FCP Report definition schema > items > items items > view > output_format| Type | enum (of string) |
| Required | No |
Description: Output format for export
Must be one of:
FCP Report definition schema > items > items items > view > columns| Type | array |
| Required | No |
Description: Columns to be used within report
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > items > items items > template| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + file | No | string | No | - | Template file name |
| + output | No | string | No | - | Output file name (relative to output dir) |
| - tag | No | string | No | - | Tag to be used for template processing (--report.tag) |
FCP Report definition schema > items > items items > template > file| Type | string |
| Required | Yes |
Description: Template file name
FCP Report definition schema > items > items items > template > output| Type | string |
| Required | Yes |
Description: Output file name (relative to output dir)
FCP Report definition schema > items > items items > template > tag| Type | string |
| Required | No |
Description: Tag to be used for template processing (--report.tag)
FCP Report definition schema > items > items items > search| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + query | No | string | No | - | Query to use |
| + output | No | string | No | - | Output file name (relative to output dir) |
| - output_type | No | enum (of string) | No | - | Output type for export |
| + output_format | No | enum (of string) | No | - | Output format for export |
| - columns | No | array | No | - | Columns to be used within report |
FCP Report definition schema > items > items items > search > query| Type | string |
| Required | Yes |
Description: Query to use
FCP Report definition schema > items > items items > search > output| Type | string |
| Required | Yes |
Description: Output file name (relative to output dir)
FCP Report definition schema > items > items items > search > output_type| Type | enum (of string) |
| Required | No |
| Default | "table" |
Description: Output type for export
Must be one of:
FCP Report definition schema > items > items items > search > output_format| Type | enum (of string) |
| Required | Yes |
Description: Output format for export
Must be one of:
FCP Report definition schema > items > items items > search > columns| Type | array |
| Required | No |
Description: Columns to be used within report
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
FCP Report definition schema > subreports| Type | array of object |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| subreports items | - |
| Type | object |
| Required | No |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - disabled | No | boolean | No | - | - |
| + name | No | string | No | - | - |
| + groups | No | object | No | - | - |
| + input_directory | No | string | No | - | - |
| + output_directory | No | string | No | - | - |
FCP Report definition schema > subreports > subreports items > disabled| Type | boolean |
| Required | No |
FCP Report definition schema > subreports > subreports items > name| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups| Type | object |
| Required | Yes |
| Additional properties | [Not allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + input_csv | No | string | No | - | - |
| + output_csv | No | string | No | - | - |
| + tag_prefix | No | string | No | - | - |
| + tag_attr | No | string | No | - | - |
| - email_attr | No | string | No | - | - |
| + dir_attr | No | string | No | - | - |
| + name_attr | No | string | No | - | - |
| - description_attr | No | string | No | - | - |
FCP Report definition schema > subreports > subreports items > groups > input_csv| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups > output_csv| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups > tag_prefix| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups > tag_attr| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups > email_attr| Type | string |
| Required | No |
FCP Report definition schema > subreports > subreports items > groups > dir_attr| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups > name_attr| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > groups > description_attr| Type | string |
| Required | No |
FCP Report definition schema > subreports > subreports items > input_directory| Type | string |
| Required | Yes |
FCP Report definition schema > subreports > subreports items > output_directory| Type | string |
| Required | Yes |
FCP Report definition schema > onfinish| Type | array of object |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| onfinish items | - |
| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - copy | No | array | No | - | - |
FCP Report definition schema > onfinish > onfinish items > copy| Type | array |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
Generated using json-schema-for-humans on 2023-01-07 at 19:48:30 +0100