key: headline

description: A brief and snappy introduction to the content, designed to catch the reader's attention. nar:headline


key: slugline

description: A human-readable identifier for the item. (Added in version 1.2 from issue #4.). nar:slugline

type: string


key: located

description: The name of the location from which the content originates. nar:located


key: charcount

description: The total character count in the article excluding figure captions. (Added in version 1.2 according to issue #27.). nar:charcount

type: number


key: wordcount

description: The total number of words in the article excluding figure captions. (Added in version 1.2 according to issue #27.). nar:wordcount


key: renditions

description: Wrapper for different renditions of the news object. nar:remoteContent

type: object

format: uri


description: A specific rendition of the content of the news object. (Description changed in version 1.2 according to issue #17.)


key: href

description: The URL for accessing the rendition as a resource. nar:remoteContent@ref


key: mimetype

description: A MIME type which applies to the rendition. nar:remoteContent@contenttype


key: title

description: A title for the link to the rendition resource


key: height

description: For still and moving images: the height of the display area measured in pixels. nar:remoteContent@height


key: width

description: For still and moving images: the width of the display area measured in pixels. nar:remoteContent@width


key: sizeinbytes

description: The size of the rendition resource in bytes


key: duration

description: The total time duration of the content in seconds. (Added in version 1.2. Issue #18). nar:remoteContent@duration


key: format

description: Binary format name. (Added in version 1.2. Issue #18). nar:remoteContent@format


key: associations

description: Content of news objects which are associated with this news object. nar:link


key: altids

description: Alternative identifiers of the item. It is up to the individual provider to name and set type on the alternative identifiers they like to use. nar:altId issue #3. (Added in version 1.3)


key: trustindicator

description: An array of objects to allow links to documents about trust indicators. (nar:link) issue #44. (Added in version 1.3)

type: array


key: scheme

description: The identifier of a scheme (= controlled vocabulary) which includes a code for the trust indicator


key: code

description: The code for the trust indicator in a scheme (= controlled vocabulary) which is identified by the scheme property


description: The title of the resource being referenced.


description: The URL for accessing the trust indicator resource.


key: $standard

description: An object with information about standard, version and schema this instance is valid against. nar:standard, nar:standardversion and xml:schema issue #43. (Added in version 1.3)


key: name

description: For example ninjs. nar:standard


key: version

description: For example 1.3. nar:standardversion


key: schema

description: The uri of the json schema to use for validation.


key: genre

description: A nature, intellectual or journalistic form of the content. nar:genre. (Added in version 1.3)


description: The name of the genre


description: The identifier of a scheme (= controlled vocabulary) which includes a code for the genre. Normally  http://cv.iptc.org/newscodes/genre/


description: The code for the genre in a scheme (= controlled vocabulary) which is identified by the scheme property


description: JSON Schema for Starlake Data Pipeline

const: string

const: long

const: int

const: short

const: double

const: boolean

const: byte

const: date

const: timestamp

const: decimal

const: struct

const: text

const: keyword

const: integer

const: float

const: binary

const: ip

const: completion

const: object

const: array

const: OVERWRITE

const: APPEND

const: IGNORE

const: SA

const: USER

const: GROUP

const: LEFT

const: RIGHT

const: BOTH

const: TABLE

const: VIEW

const: SYSTEM TABLE

const: GLOBAL TEMPORARY

const: LOCAL TEMPORARY

const: ALIAS

const: SYNONYM

required: name pattern primitiveType

required: first last

required: name grants

required: role grants

const: DSV

const: POSITION

const: JSON

const: XML


key: PrimitiveType

description: Any string that match the '.*' regex

const: string


description:
Any whole number that match the '[-|+|0-9][0-9]*' regex.
ints are mapped to as 'int' in some database whereas 'longs are mapped as 'bigint' and shorts as 'smallint'

const: long


const: int


const: short


description: Any decimal number that match the '[-+]?\d*\.?\d+[Ee]?[-+]?\d*' regex

const: double


description:
Any string that match the '(?i)true|yes|[y1]<-TF->(?i)false|no|[n0]' regex,
where the value on the left of '<-T' represent true and values on the right of 'F->' represent the false

const: boolean


description: Any single char

const: byte


description: Any date that match the 'yyyy-MM-dd' regex (2023-12-31)

const: date


description: Any date that match the 'yyyyMMdd' regex (20231231)


description: Timestamp based on `ISO Date with offset` pattern (2023-12-31+02:00)


description: Timestamp based on `ISO Date with or without offset` pattern (2011-12-03+02:00)


description: Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30)


description: Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30+01:00)


description: Timestamp based on `ISO Zoned Date Time`pattern (2023-12-31T10:15:30+01:00[Europe/Paris])


description: Timestamp based on `ISO Date and time with ZoneId` pattern (2011-12-03T10:15:30+01:00[Europe/Paris])


description: Timestamp based on `year and day of year` pattern (2023-337)


description: Timestamp based on `Year and Week` pattern (2012-W48-6)


description: Timestamp based on `Date and Time of an Instant` pattern - UTC only - (2023-12-31T10:15:30Z)


description: Timestamp based on `RFC 1123 / RFC 822` patterns (Tue, 3 Jun 2008 11:05:30 GMT)


description:
date/time that match the 'yyyy-MM-dd HH:mm:ss' regex s (2019-12-31 23:59:02).
For epoch timestamp, set pattern attribute to 'epoch_second' or 'epoch_milli'

const: timestamp


description: Any floating value that match the '-?\d*\.{0,1}\d+' regex

const: decimal


description: Any attribute that has children. Set the array to true if this attribute is made of a list of attributes

const: struct


key: WriteMode

description: Append to or overwrite existing data

const: OVERWRITE

const: APPEND

const: IGNORE


description: That data will overwrite the existing data or create it if it does not exist


description: Append the data to an existing table or create it if it does not exist


description: Fail if teh table already exist


description: Do not save at all. Useful in interactive / test mode.


key: UserType

description: Service account

const: SA


description: End user

const: USER


description: Group of users / service accounts

const: GROUP


key: Trim

description: Remove all leading space chars from the input

const: LEFT


description: Remove all trailing spaces from the input

const: RIGHT


description: Remove all leading and trailing spaces from the input

const: BOTH


description: Do not remove leading or trailing spaces from the input


key: TableDdl

description: DDL used to create a table


key: createSql

description: SQL CREATE DDL statement


key: pingSql

description:
How to test if the table exist.
Use the following statement by default: 'select count(*) from tableName where 1=0'


key: TableType

description: Table types supported by the Extract module

const: TABLE

const: VIEW

const: SYSTEM TABLE

const: GLOBAL TEMPORARY

const: LOCAL TEMPORARY

const: ALIAS

const: SYNONYM


description: SQl Table


description: SQl View


description: Database specific system table


description: Table alias


description: Table synonym


key: Type

description: Custom type definition. Custom types are defined in the types/types.comet.yml file


description: unique id for this type


key: primitiveType

description:
To what primitive type should this type be mapped.
 This is the memory representation of the type, When saving, this primitive type is mapped to the database specific type


key: pattern

description: Regex used to validate the input field


key: zone

description:
useful when parsing specific string:
 - double: To parse a french decimal (comma as decimal separator) set it to fr_FR locale.
- decimal: to set the precision and scale of this number, '38,9' by default.
-


key: sample

description: This field makes sure that the pattern matches the value you want to match. This will be checked on startup


key: comment

description: Describes this type


key: indexMapping

description: How this type is indexed in your datawarehouse


key: ddlMapping

description: Configure here the type mapping for each datawarehouse.\nWill be used when inferring DDL from schema.


key: Partition

description: Partition columns, no partitioning by default


key: sampling

description: 0.0 means no sampling, > 0  && < 1 means sample dataset, >=1 absolute number of partitions. Used exclusively on Hadoop & databricks warehouses


key: items

description: Attributes used to partition de dataset.


key: first

description: Zero based position of the first character for this attribute


key: last

description: Zero based position of the last character to include in this attribute


key: Connection

description: Connection


key: type

description: aka jdbc, bigquery, snowflake, redshift ...


key: sparkFormat

description: Set only if you want to use the Spark engine


key: mode

description: Used for JDBC connections only. Write mode, APPEND by default


key: options

description: Connection options


key: RowLevelSecurity

description: Row level security policy to apply to the output data.


key: name

description: This Row Level Security unique name


key: description

description: Description for this access policy


key: predicate

description: The condition that goes to the WHERE clause and limit the visible rows.


key: grants

description:
user / groups / service accounts to which this security level is applied.
ex : user:me@mycompany.com,group:group@mycompany.com,serviceAccount:mysa@google-accounts.com


key: AccessControlEntry

description: Column level security policy to apply to the attribute.


key: role

description: This role to give to the granted users


key: key

description: list of attributes to join an existing and incoming dataset. Use renamed columns if any here.


key: delete

description: Optional valid delete condition on the incoming dataset. Use renamed column here.


key: timestamp

description: Timestamp column used to identify last version, if not specified currently ingested row is considered the last


key: queryFilter

description:
Useful when you want to merge only on a subset of the existing partitions, thus improving performance and reducing costs.
You may use here:
- Any SQL condition
- latest which will be translated to the last existing partition
- column in last(10) which will apply the merge on the last 10 partitions of your dataset.
 last and latest assume that your table is partitioned by day.


key: Format

description: DSV by default. Supported file formats are :\n- DSV : Delimiter-separated values file. Delimiter value is specified in the "separator" field.\n- POSITION : FIXED format file where values are located at an exact position in each line.\n- SIMPLE_JSON : For optimisation purpose, we differentiate JSON with top level values from JSON\n  with deep level fields. SIMPLE_JSON are JSON files with top level fields only.\n- JSON :  Deep JSON file. Use only when your json documents contain sub-documents, otherwise prefer to\n  use SIMPLE_JSON since it is much faster.\n- XML : XML files

const: DSV

const: POSITION

const: JSON

const: XML


description: any single or multiple character delimited file. Separator is specified in the separator field


description: any fixed position file. Positions are specified in the position field


description:
any deep json file.
To improve performance, prefer the SIMPLE_JSON format if your json documents are flat


description: any json file containing an array of json objects.


description:
any flat json file.
To improve performance, prefer this format if your json documents are flat


description: any xml file. Use the metadata.xml.rowTag field to specify the root tag of your xml file


key: MapString

description: Map of string


key: MapConnection

description: Map of connections


key: MapJdbcEngine

description: Map of jdbc engines


key: MapTableDdl

description: Map of table ddl


key: JdbcEngine

description: Jdbc engine


key: tables

description:
List of all SQL create statements used to create audit tables for this JDBC engine.
Tables are created only if the execution of the pingSQL statement fails


key: options

description:
Privacy strategies. The following default strategies are defined by default:
- none: Leave the data as is
- hide: replace the data with an empty string
- hideX("s", n): replace the string with n occurrences of the string 's'
- md5: Redact the data using the MD5 algorithm
- sha1: Redact the data using the SHA1 algorithm
- sha256: Redact the data using the SHA256 algorithm
 - sha512: Redact the data using the SHA512 algorithm
- initials: keep only the first char of each word in the data


key: Internal

description: configure Spark internal options

type: boolean


key: cacheStorageLevel

description:
How the RDD are cached. Default is MEMORY_AND_DISK_SER.
Available options are (https://spark.apache.org/docs/latest/api/java/index.html?org/apache/spark/storage/StorageLevel.html):
- MEMORY_ONLY
- MEMORY_AND_DISK
- MEMORY_ONLY_SER
- MEMORY_AND_DISK_SER
- DISK_ONLY
- OFF_HEAP


key: intermediateBigqueryFormat

description:
May be parquet or ORC. Default is parquet. Used for BigQuery intermediate storage. Use ORC for for JSON files to keep the original data structure.
https://stackoverflow.com/questions/53674838/spark-writing-parquet-arraystring-converts-to-a-different-datatype-when-loadin


key: temporaryGcsBucket

description: The GCS bucket that temporarily holds the data before it is loaded to BigQuery.


key: substituteVars

description: Internal use. Do not modify.


key: apply

description: Should access policies be enforced ?


key: location

description: GCP project location. Required if apply is true.


key: database

description: GCP Project id. Required if apply is true.


key: taxonomy

description: Taxonomy name. Required if apply is true.


key: maxJobs

description: Max number of Spark jobs to run in parallel, default is 1

type: integer


key: poolName

description: Pool name to use for Spark jobs, default is 'default'


key: mode

description: This can be FIFO or FAIR, to control whether jobs within the pool queue up behind each other (the default) or share the pool’s resources fairly.


key: file

description: Scheduler filename in the metadata folder. If not set, defaults to fairscheduler.xml.


key: path

description: When using filesystem storage, the path to the expectations file


key: active

description: should expectations be executed ?


description: When using filesystem storage, the path to the metrics file


key: discreteMaxCardinality

description: Max number of unique values accepted for a discrete column. Default is 10


description: Should metrics be computed ?


key: options

description: spark  options to use


key: id

description: ES: Attribute to use as id of the document. Generated by Elasticsearch if not specified.


key: timestamp

description: ES or BQ: The timestamp column to use for table partitioning if any. No partitioning by default\nES:Timestamp field format as expected by Elasticsearch ("{beginTs|yyyy.MM.dd}" for example).


description: BQ: Database location (EU, US, ...)


key: clustering

description: FS or BQ: List of attributes to use for clustering


key: days

description: BQ: Number of days before this table is set as expired and deleted. Never by default.


key: requirePartitionFilter

description: BQ: Should be require a partition filter on every request ? No by default.


key: materializedView

description: BQ: Should we materialize as a table or as a view when saving the results ? false by default.


key: enableRefresh

description: BQ: Enable automatic refresh of materialized view ? false by default.


key: refreshIntervalMs

description: BQ: Refresh interval in milliseconds. Default to BigQuery default value


key: format

description: FS: File format


key: extension

description: FS: File extension


key: partition

description: FS or BQ: List of partition attributes


key: connectionRef

description: JDBC: Connection String


key: coalesce

description: When outputting files, should we coalesce it to a single file. Useful when CSV is the output format.


key: encoding

description: UTF-8 if not specified.


key: multiline

description: are json objects on a single line or multiple line ? Single by default.  false means single. false also means faster


key: array

description: Is the json stored as a single object array ? false by default. This means that by default we have on json document per line.


key: withHeader

description: does the dataset has a header ? true bu default


key: separator

description: the values delimiter,  ';' by default value may be a multichar string starting from Spark3


key: quote

description: The String quote char, '"' by default


key: escape

description: escaping char '\' by default


key: write

description: Write mode, APPEND by default


key: ignore

description: Pattern to ignore or UDF to apply to ignore some lines


key: xml

description: com.databricks.spark.xml options to use (eq. rowTag)


key: directory

description:
Folder on the local filesystem where incoming files are stored.
 Typically, this folder will be scanned periodically to move the dataset to the cluster for ingestion.
                     Files located in this folder are moved to the pending folder for ingestion by the "import" command.


key: extensions

description:
recognized filename extensions. json, csv, dsv, psv are recognized by default.
Only files with these extensions will be moved to the pending folder.


key: ack

description:
Ack extension used for each file. ".ack" if not specified.
Files are moved to the pending folder only once a file with the same name as the source file and with this extension is present.
To move a file without requiring an ack file to be present, set explicitly this property to the empty string value "".


key: options

description: Options to add to the spark reader


key: validator

description: Validator to use, 'spark' or 'native'. Default to 'spark' of SL_VALIDATOR env variable is set to 'native'


key: emptyIsNull

description: Treat empty columns as null in DSV files. Default to false


key: nullValue

description: Treat a specific input string as a null value indicator


key: freshness

description: Configure freshness checks on this dataset


key: schedule

description: Cron expression to use for this domain/table


key: dagRef


key: name

description: Schema in JDBC Database / Snowflake / Redshift or Dataset in BigQuery


key: tables

description: Tables to scan in this domain


key: endpoint

description: DAG reference


key: ingest


key: database

description: Database name of Project id in BigQuery


key: external

description: List of domains to scan


key: pending

description: Files recognized by the extensions property are moved to this folder for ingestion by the "import" command.


key: unresolved

description: Files that cannot be ingested (do not match by any table pattern) are moved to this folder.


key: archive

description: Files that have been ingested are moved to this folder if SL_ARCHIVE is set to true.


key: ingesting

description: Files that are being ingested are moved to this folder.


key: accepted

description: When filesystem storage is used, successfully ingested stored in this this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.


key: rejected

description: When filesystem storage is used, rejected records are stored in this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.


key: replay

description: Invalid records are stored in this folder in source format when SL_SINK_REPLAY_TO_FILE is set to true.


key: warn

description: How old may be teh data before a warning is raised. Use syntax like '3 day' or '2 hour' or '30 minute'


key: error

description: How old may be teh data before an error is raised. Use syntax like '3 day' or '2 hour' or '30 minute'


description:
Schema name, must be unique among all the schemas belonging to the same domain.
  *                     Will become the hive table name On Premise or BigQuery Table name on GCP.


key: rename

description: If present, the table is renamed with this name. Useful when use in conjunction with the 'extract' module


key: pattern

description:
filename pattern to which this schema must be applied.
  *                     This instructs the framework to use this schema to parse any file with a filename that match this pattern.


key: attributes

description: Attributes parsing rules.


key: metadata

description: Dataset metadata


key: comment

description: free text


key: presql

description: Reserved for future use.


key: postsql

description: Reserved for future use.


key: tags

description: Set of string to attach to this Schema


key: rls

description: Row level security on this schema.


key: expectations

description: Expectations to check after Load / Transform has succeeded


key: primaryKey

description: List of columns that make up the primary key


key: acl

description: Map of rolename -> List[Users].


key: sample

description: Store here a couple of records illustrating the table data.


key: filter

description: remove all records that do not match this condition


key: patternSample

description: Sample of filename matching this schema


key: name

description: Attribute name as defined in the source dataset and as received in the file


key: type

description: semantic type of the attribute


key: array

description: Is it an array ?


key: required

description: Should this attribute always be present in the source


key: privacy

description: Should this attribute be applied a privacy transformation at ingestion time


description: free text for attribute description


key: rename

description: If present, the attribute is renamed with this name


key: metricType

description: If present, what kind of stat should be computed for this field


key: attributes

description: List of sub-attributes (valid for JSON and XML files only)


key: default

description: Default value for this attribute when it is not present.


key: tags

description: Tags associated with this attribute


key: script

description: Scripted field : SQL request on renamed column


key: foreignKey

description: If this attribute is a foreign key, reference to [domain.]table[.attribute]


key: ignore

description: Should this attribute be ignored on ingestion. Default to false


key: accessPolicy

description: Policy tag to assign to this attribute. Used for column level security


key: sql

description: Main SQL request to execute (do not forget to prefix table names with the database name to avoid conflicts)


key: database

description: Output Database (refer to a project id in BigQuery). Default to SL_DATABASE env var if set.


key: domain

description: Output domain in output Area (Will be the Database name in Hive or Dataset in BigQuery)


key: table

description: Dataset Name in output Area (Will be the Table name in Hive & BigQuery)


key: partition

description: List of columns used for partitioning the output.


key: presql

description: List of SQL requests to executed before the main SQL request is run


key: postsql

description: List of SQL requests to executed after the main SQL request is run


key: expectations

description: Expectations to check after Load / Transform has succeeded


key: acl

description: Map of rolename -> List[Users].


key: comment

description: Output table description


key: freshness

description: Configure freshness checks on the output table


key: attributesDesc

description: Attributes comments and access policies


key: python

description: Python script URI to execute instead of the SQL request


key: tags

description: Set of string to attach to the output table


key: schedule

description: Cron expression to use for this task


key: dagRef

description: Cron expression to use for this domain/table


key: path

description: Name of the lock


key: timeout

description: Name of the lock


key: pollTime

description: Name of the lock


key: refreshTime

description: Name of the lock


key: sink


key: maxErrors


key: database


key: active

description: Output table description


key: name

description: Column name


description: Column description


key: accessPolicy

description: Access policy to apply to this column


key: Domain

description: A schema in JDBC database or a folder in HDFS or a dataset in BigQuery.


description:
Domain name. Make sure you use a name that may be used as a folder name on the target storage.
                   - When using HDFS or Cloud Storage,  files once ingested are stored in a sub-directory named after the domain name.
                   - When used with BigQuery, files are ingested and sorted in tables under a dataset named after the domain name.


key: rename

description: If present, the attribute is renamed with this name


key: tables

description:
List of schemas for each dataset in this domain.
A domain usually contains multiple schemas. Each schema defining how the contents of the input file should be parsed.
See Schema for more details.


key: comment

description: Domain Description (free text)


key: tags

description: Set of string to attach to this domain


description: Optional name. If not specified, the name of the file without the extension is used.


key: default

description: Default task properties to apply to all tasks defined in tasks section and in included files


key: items

description: List of transform tasks to execute


description: table name. Set to '*' to extract all tables


key: columns

description: List of columns to extract. All columns by default.


key: catalog

description: Optional catalog name in the source database


key: schema

description: Database schema where source tables are located


key: template

description: Metadata to use for the generated YAML file.


description: List of tables to extract


key: tableTypes

description: One or many of the predefined table types


key: jdbcSchemas

description: List database connections to use to extract the data


key: connectionRef

description: Connection name as defined in the connections section of the application.conf file


key: connection

description: JDBC connection options: url, user, password ...


key: RefInput

description: Input for ref object


key: database

description: Database pattern to match, none if any database


key: domain

description: Domain pattern to match, none if any domain match


key: table

description: Table pattern to match


key: RefOutput

description: Output for ref object

required: table domain database


key: Ref

description: Describe how to resolve a reference in a transform task

required: input output


key: input

description: The input table to resolve


key: output

description: The output table resolved with the domain and database


key: env

description: Default environment to use. May be also set using the SL_ENV environment variable


key: datasets

description: When using filesystem storage, default path to store the datasets


key: metadata

description: default metadata folder name. May be also set using the SL_METADATA environment variable


key: validateOnLoad

description: Validate the YAML file when loading it. If set to true fails on any error


key: archive

description: Should ingested files be archived after ingestion ?


key: sinkReplayToFile

description: Should invalid records be stored in a replay file ?


key: defaultFormat

description: Default write format in Spark. parquet is the default


key: defaultRejectedWriteFormat

description: Default write format in Spark for rejected records. parquet is the default


key: defaultAuditWriteFormat

description: Default write format in Spark for audit records. parquet is the default


key: csvOutput

description: output files in CSV format ? Default is false


key: csvOutputExt

description: CSV file extension when csvOutput is true. Default is .csv


key: privacyOnly

description: Only generate privacy tasks. Reserved for internal use


key: emptyIsNull

description: Should empty strings be considered as null values ?


key: validator

description: Default validator to use when none is specified in the schema. Valid values are 'spark' or 'native'. Default is 'spark'


key: loadStrategyClass

description: In what order should the files for a same table be loaded ? By time (default) or by or name ?


key: analyze

description: Should we analyze the result and generate HIVE statistics ? (useful for Spark / Databricks)


key: hive

description: Should we create the table in Hive ? (useful for Spark / Databricks)


key: grouped

description: Should we load of the files to be stored in the same table in a single task or one by one ?


key: groupedMax

description: Maximum number of files to be stored in the same table in a single task


key: mergeForceDistinct

description: Should we force a distinct on the merge ?


key: mergeOptimizePartitionWrite

description: Should we optimize the partition write on the merge ?


key: area

description: pending, accepted ... areas configuration


key: airflow

description: Airflow endpoint configuration when using Airflow Launcher


key: hadoop

description: Hadoop configuration if applicable


key: connections

description: Connection configurations


key: jdbcEngines

description: JDBC engine configurations


key: privacy

description: Privacy algorithms


key: root

description: Root folder for the application. May be also set using the SL_ROOT environment variable


key: internal

description: Internal configuration


key: accessPolicies

description: Access policies configuration


key: scheduling

description: Spark Job scheduling configuration


key: udfs

description: Coma separated list of UDF to register in Spark jobs. May be also set using the SL_UDFS environment variable


key: expectations

description: Expectations configuration


key: sqlParameterPattern

description: Pattern to use to replace parameters in SQL queries in addition to the jinja syntax {{param}}. Default is ${param}


key: rejectAllOnError

description: Should we reject all records when an error occurs ? Default is false


key: rejectMaxRecords

description: Maximum number of records to reject when an error occurs. Default is 100


key: dsvOptions

description: DSV ingestion extra options


key: forceViewPattern

description: reserved


key: forceDomainPattern

description: reserved


key: forceTablePattern

description: reserved


key: forceJobPattern

description: reserved


key: forceTaskPattern

description: reserved


key: useLocalFileSystem

description: reserved


key: sessionDurationServe

description: reserved


key: database

description: Default target database (projectId in GCP). May be also set using the SL_DATABASE environment variable


key: tenant

description: reserved


key: connectionRef

description: Default connection to use when loading / transforming data


description: Expectations library defined as a map name(params) -> sql request that should return 0 record


description: Schema for imageoptimizer.json files


key: optimizations

description: An array of optimization rules


key: includes

description: An array of globbing patterns of files/folders to include in the optimization


key: excludes

description: An array of globbing patterns of files/folders to exclude in the optimization


key: lossy

description: When set to true, images are compressed a lot more but with a slight quality loss that may not be visible to the human eye.


key: script

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

type: string array


key: bundleExclude

description: List of files to exclude from publish output (kpm bundle).


key: code

description: Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "Folder1\*.cs", "Folder2\*.cs" ]


key: configurations

description: Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.


key: copyright

description: Copyright details for the package


key: iconUrl

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.


key: licenseUrl

description: A link to the license that the package is under


key: requireLicenseAcceptance

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.


key: projectUrl

description: A URL for the home page of the package


key: summary

description: A short description of the package


key: title

description: The human-friendly title of the package


key: releaseNotes

description: A description of the changes made in each release of the package.


key: language

description: The locale ID for the package, such as en-us.


key: description

description: The description of the application


key: exclude

description: Glob pattern to indicate all the code files to be excluded from compilation. (data type: string or array with glob pattern(s)).


key: namedResource

description: Overrides the generated resource names with custom ones.


key: preprocess

description: Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).


key: repository

description: Contains information about the repository where the project is stored.

default: git


key: resources

description: Glob pattern to indicate all the files that need to be compiled as resources.


key: scripts

description: Scripts to execute during the various stages.


key: shared

description: Glob pattern to specify the code files to share with dependent projects. Example: [ "Folder1\*.cs", "Folder2\*.cs" ]


key: version

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*


key: webroot

description: Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.


key: appAssets

description: Set this object to co-deploy native apps along with your app.

required: alias src version


key: alias

description: Name of the asset. The name will be used in launchExternalProcess to launch the asset.


key: args

description: The default command line arguments for the aforementioned target.


key: src

description: URL to a zip file containing the package files (executables, dlls, etc…).


key: target

description: Specifies default executable to launch. This option can be overridden in launchExternalProcess.


description: Version of the package. To force new updates, increment the version.


description: If an application specifies a valid "assetsUrl", then that "assetsUrl" will be used as the base portion of the URL instead of the OpenFin default, https://developer.openfin.co/release/.


description: You can access the Chromium development tools by navigating to the selected port, i.e.: http://localhost:9090.


key: dialogSettings

description: An optional object to customize the appearance of the RVM progress dialog.


key: bgColor

description: Determines the color of the dialog. Color value is a decimal representation of a 32 bit number (A,R,G,B). For instance : FF00FF00 or 4278255360 is fully opaque green.


key: logo

description: Determines the logo or image in the progress dialog. The logo should be a semi-transparent PNG. 100×25 pixels.


key: progressBarBgColor

description: Determines the background color of the area where the progress bar is displayed.


key: progressBarBorderColor

description: Determines the border color of the progress bar.


key: progressBarFillColor

description: Determines the color of the progress bar.


key: textColor

description: Determines the color of the text displayed above the progress bar location.


key: licenseKey

description: A string used as a licensing identifier for each customer/contract (RVM 2.7+). The OpenFin team will generate this for your production app.


key: runtime

description: Determines which runtime version the app will use.

enum: alpha beta canary stable staging


key: arguments

description: Command line arguments to set when launching the runtime. The OpenFin Runtime supports Chromium command line switches e.g.: "– –disable-accelerated-compositing – –enable-threaded-compositing" for a complete list of values please refer to current Chromium switches.


key: fallbackVersion

description: The RVM will fallback to this version if it fails to retrieve the desired Runtime version, assuming this version is already installed. (RVM 2.8+)


key: forceLatest

description: If true, forces the runtime to always get the latest runtime version before launching (prevents background installs).


key: version

description: Specifies what version of the runtime the app should use. The value can either be a specific version or a release channel (e.g. alpha).


key: shortcut

description: Settings for the app's desktop shortcut

required: company icon name

enum: automatic-start-up desktop start-menu


key: company

description: Company name for the application shortcut.


key: description

description: A short description of the application shortcut. Will be shown when hovering over the shortcut icon.


key: force

description: If set to true, a desktop icon is always created on application start-up (even when user has deleted it). If set to false, a desktop icon is created on initial application launch but not created on subsequent application launches.


key: icon

description: Location for the icon image to be used when installing the application shortcut.


key: name

description: Name of the application to display with the shortcut.


key: startMenuRootFolder

description: Set this value with a folder path (e.g. foo/bar) and the RVM will create the start menu shortcut under RootFolder/Company/App.


key: target

description: Locations for where the application shortcut is added on the desktop owner's machine. Available options are "desktop", "start-menu" and "automatic-start-up". The default is start-menu and desktop.


key: uninstall-shortcut

description: Removes the Start menu uninstall shortcut.


key: splashScreenImage

description: You can specify an image to display while the runtime is loading. It takes any image file (including semi-transparent PNGs).


description: Specifies the application level configuration.

required: name url uuid

enum: maximized minimized normal

default: normal


key: accelerator

description: The name of this builder instance, which can be specified in the only/except property of a provisioner.


key: devtools

description: If true, allows the Dev Tools to be opened with the keyboard shortcut: Ctrl+Shift+i.


key: reload

description: If true, allows a window to reload with the keyboard shortcuts: Ctrl+r or F5.


key: reloadIgnoreCache

description: If true, allows a window to reload while ignoring the cache with the keyboard shortcuts: Ctrl+Shift or Shift+F5.


key: zoom

description: If true, enables the Zoom keyboard shortcuts: Ctrl+ (Zoom in), Ctrl- (Zoom out) and Ctrl+0 (Restore to 100%).


key: alwaysOnTop

description: A flag to always position the window at the top of the window stack.


key: applicationIcon

description: A URL for the icon to be shown in the window title bar.


key: autoShow

description: A flag to automatically show the Window when it is created.


key: childWindowAutoAuth

description: Allow non API created child windows, such as window.open, to authenticate.


key: clearChildSubscriptionsOnReload

description: Clear InterApplication subscriptions of all child windows when main window is reloaded.


key: contextMenu

description: A flag to show the context menu when right-clicking on a window. Gives access to the Developer Console for the Window.


key: cornerRounding

description: This defines and applies rounded corners for the window.


key: height


key: width


key: defaultCentered

description: Specifies that the window will be positioned in the center of the primary monitor when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the position from before the window was closed is used.


key: defaultHeight

description: The default height of the window. Specifies the height of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the height is taken to be the last height of the window before it was closed.


key: defaultLeft

description: The default left position of the window. Specifies the position of the left of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the value of left is taken to be the last value before the window was closed.


key: defaultTop

description: The default top position of the window. Specifies the position of the top of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the value of top is taken to be the last value before the window was closed.


key: defaultWidth

description: The default width of the window. Specifies the width of the window when loaded for the first time on a machine. When the window corresponding to that id is loaded again, the width is taken to be the last width of the window before it was closed.


key: description

description: The name for the window which must be unique within the context of the invoking Application.


key: frame

description: A flag to show the frame.


key: icon


key: maxHeight

description: The maximum height of a window. Will default to the OS defined value if set to -1.


key: maximizable

description: A flag that lets the window be maximized.


key: maxWidth

description: The maximum width of a window. Will default to the OS defined value if set to -1.


key: minHeight

description: The minimum height of a window.


key: minWidth

description: The minimum width of a window.


key: name


key: nonPersistent

description: A flag to configure the application as a non persistent. Runtime exits if there are no persistent apps running.


key: opacity

description: A flag that specifies how transparent the window will be. This value is clamped between 0.0 and 1.0.


key: permissions

description: Enable secured APIs


key: preloadScripts

description: An array of scripts to download and run before other scripts in the page.


key: url

description: URL from which to fetch the script.


key: resizable

description: A flag to drop to allow the user to resize the window.


key: resizeRegion

description: Define the attributes of the window's resize region.


key: bottomRightCorner

description: Defines a region in pixels of an additional square at the bottom right corner of a frameless window.


key: size

description: Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.


key: saveWindowState

description: A flag to cache the location of the window or not.


key: showTaskbarIcon

description: A flag to show the Window's icon in the taskbar.


key: state

description: A string that sets the window to be "minimized", "maximized", or "normal" on creation.


key: taskbarIcon

description: The URL of an icon to be shown on the desktop. Support formats: Portable Network Graphic (PNG); Size: 256 x 256.


key: taskbarIconGroup

description: Group your OpenFin apps in the Taskbar. v5.0+


description: The URL of the window.


key: uuid

description: The UUID of the application, unique within the set of all other Applications running in OpenFin Runtime.


key: waitForPageLoad

description: When set to false, the page will render before the "load" event is fired on the window. Caution, when false you will see an initial empty white window.


key: supportInformation

description: An optional object to customize error messages.

required: company email product


key: company

description: Displays the company name in the title bar for the support error dialog that appears when an application fails to load.


key: email

description: Displays the email to contact in the support error dialog that appears when an application fails to load.


key: enableErrorReporting

description: To disable the error reporting feature, set this value to false.


key: forwardErrorReports

description: When set to true, prompts end users with a dialog when a deployment error occurs from within the RVM and enables them send along log files from their machine. Error reports are delivered to your email address set in supportInformation.


key: product

description: Displays the product name or application name in the support error dialog that appears when an application fails to load.


description: A GitHub app that closes abandoned issues and pull requests

type: integer boolean

default: wontfix

type: string boolean

default: This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

enum: issues pulls


key: daysUntilStale

description: Number of days of inactivity before an Issue or Pull Request becomes stale.


key: daysUntilClose

description: Number of days of inactivity before an Issue or Pull Request with the stale label is closed.


key: onlyLabels

description: Only issues or pull requests with all of these labels are check if stale.


key: exemptLabels

description: Issues or Pull Requests with these labels will never be considered stale.


key: exemptProjects

description: Set to true to ignore issues in a milestone.


key: exemptAssignees

description: Set to true to ignore issues with an assignee.


key: staleLabel

description: Label to use when marking as stale.


key: markComment

description: Comment to post when marking as stale.


key: unmarkComment

description: Comment to post when removing the stale label.


key: closeComment

description: Comment to post when closing a stale issue or pull request.


key: limitPerRun

description: Limit the number of actions per hour.


key: only

description: Limit to only issues or pulls requests.


key: pulls

description: Specify configuration settings that are specific to pull requests.


key: issues

description: Specify configuration settings that are specific to issues.


key: name

description:
A workflow template name
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow


key: description

description:
A workflow template description
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow


key: iconName

description:
A workflow template icon
Must be the name of an SVG file, without the file name extension, stored in the workflow-templates directory
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow


key: categories

description:
A workflow category
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow

enum:
1C Enterprise
4D
ABAP CDS
ABAP
ABNF
AFDKO
AGS Script
AIDL
AL
AMPL
ANTLR
API Blueprint
APL
ASL
ASN.1
ASP.NET
ATS
ActionScript
Ada
Alloy
Alpine Abuild
Altium Designer
AngelScript
Ant Build System
ApacheConf
Apex
Apollo Guidance Computer
AppleScript
Arc
AsciiDoc
AspectJ
Assembly
Astro
Asymptote
Augeas
AutoHotkey
AutoIt
AutoIt3
AutoItScript
Avro IDL
Awk
BASIC
Ballerina
Batchfile
Beef
Befunge
BibTeX
Bicep
Bison
BitBake
Blade
BlitzBasic
BlitzMax
Boo
Boogie
Brainfuck
Brightscript
Browserslist
C
C#
C++
C-ObjDump
C2hs Haskell
CIL
CLIPS
CMake
COBOL
CODEOWNERS
COLLADA
CSON
CSS
CSV
CUE
CWeb
Cabal Config
Cabal
Cap'n Proto
Carto
CartoCSS
Ceylon
Chapel
Charity
ChucK
Cirru
Clarion
Classic ASP
Clean
Click
Clojure
Closure Templates
Cloud Firestore Security Rules
CoNLL
CoNLL-U
CoNLL-X
ColdFusion CFC
ColdFusion
Common Lisp
Common Workflow Language
Component Pascal
Containerfile
Cool
Coq
Cpp-ObjDump
Crystal
Csound Document
Csound Score
Csound
Cuda
Cue Sheet
Cycript
Cython
D-ObjDump
DIGITAL Command Language
DM
DTrace
Dafny
Darcs Patch
Dart
DataWeave
Dhall
Diff
Dlang
Dockerfile
Dogescript
Dylan
E
E-mail
EBNF
ECL
ECLiPSe
EJS
EQ
Eagle
Earthly
Easybuild
Ecere Projects
EditorConfig
Eiffel
Elixir
Elm
Emacs Lisp
EmberScript
Erlang
F#
F*
FIGfont
FIGlet Font
FLUX
Factor
Fancy
Fantom
Faust
Fennel
Filebench WML
Filterscript
Fluent
Formatted
Forth
Fortran Free Form
Fortran
FreeBasic
Frege
Futhark
G-code
GAML
GAMS
GAP
GCC Machine Description
GDB
GDScript
GEDCOM
GLSL
GN
Game Maker Language
Gemfile.lock
Genie
Genshi
Gentoo Eclass
Gerber Image
Gettext Catalog
Gherkin
Git Config
Glyph Bitmap Distribution Format
Glyph
Gnuplot
Go Checksums
Go Module
Go
Golo
Gosu
Grace
Gradle
Grammatical Framework
Graph Modeling Language
GraphQL
Graphviz (DOT)
Groovy Server Pages
Groovy
HAProxy
HCL
HTML
HTML+ECR
HTML+EEX
HTML+ERB
HTML+PHP
HTML+Razor
HTTP
HXML
Hack
Haml
Handlebars
Harbour
HashiCorp Configuration Language
Haskell
Haxe
HiveQL
HolyC
Hy
IDL
IGOR Pro
IPython Notebook
Idris
Ignore List
ImageJ Macro
Inform 7
Io
Ioke
Isabelle ROOT
Isabelle
J
JAR Manifest
JFlex
JSON with Comments
JSON
JSON5
JSONLD
JSONiq
Jasmin
Java Properties
Java Server Pages
Java
JavaScript
JavaScript+ERB
Jest Snapshot
Jinja
Jison Lex
Jison
Jolie
Jsonnet
Julia
Jupyter Notebook
Kaitai Struct
KakouneScript
KiCad Layout
KiCad Legacy Layout
KiCad Schematic
Kit
Kotlin
Kusto
LFE
LLVM
LOLCODE
LSL
LTspice Symbol
LabVIEW
Lark
Lasso
Lean
Less
Lex
LilyPond
Limbo
Linker Script
Linux Kernel Module
Liquid
Literate Agda
Literate CoffeeScript
Literate Haskell
LiveScript
Logos
Logtalk
LookML
LoomScript
Lua
M
M4
M4Sugar
MATLAB
MAXScript
MLIR
MQL4
MQL5
MTML
MUF
Macaulay2
Makefile
Mako
Markdown
Marko
Mathematica
Max
Mercury
Meson
Metal
Microsoft Developer Studio Project
Microsoft Visual Studio Solution
MiniD
Mirah
Modelica
Modula-2
Modula-3
Module Management System
Monkey
Moocode
MoonScript
Motoko
Motorola 68K Assembly
Muse
Myghty
NASL
NCL
NEON
NPM Config
NSIS
NWScript
Nearley
Nemerle
NeoSnippet
NetLinx
NetLinx+ERB
NetLogo
NewLisp
Nextflow
Nginx
Ninja
Nit
Nix
NumPy
Nunjucks
ObjDump
Object Data Instance Notation
ObjectScript
Objective-C
Objective-C++
Objective-J
Odin
Omgrofl
Opa
Opal
Open Policy Agent
OpenCL
OpenEdge ABL
OpenQASM
OpenRC runscript
OpenSCAD
OpenStep Property List
OpenType Feature File
Org
Ox
Oxygene
Oz
P4
PEG.js
PHP
PLpgSQL
POV-Ray SDL
Pan
Papyrus
Parrot Assembly
Parrot Internal Representation
Parrot
Pascal
Pawn
Pep8
Perl
Pickle
PicoLisp
PigLatin
Pike
PlantUML
Pod 6
Pod
PogoScript
Pony
PostCSS
PostScript
PowerShell
Prisma
Processing
Proguard
Prolog
Promela
Propeller Spin
Protocol Buffer
Protocol Buffers
Public Key
Pug
Puppet
Pure Data
PureBasic
PureScript
Python
Q#
QMake
Qt Script
Quake
R
RAML
RDoc
REALbasic
REXX
RMarkdown
RPC
RPM Spec
Racket
Ragel
Raw token data
ReScript
Readline Config
Reason
Rebol
Record Jar
Red
Redirect Rules
Regular Expression
RenderScript
Rich Text Format
Ring
Riot
RobotFramework
Roff
Rouge
Rscript
Ruby
Rust
SAS
SCSS
SELinux Kernel Policy Language
SELinux Policy
SMT
SPARQL
SQF
SQL
SQLPL
SRecode Template
SSH Config
STON
SVG
SWIG
Sage
SaltStack
Sass
Scala
Scaml
Scheme
Scilab
Self
ShaderLab
Shell
ShellCheck Config
Sieve
Singularity
Slash
Slice
Slim
SmPL
Smalltalk
SnipMate
Solidity
Soong
SourcePawn
Spline Font Database
Squirrel
Stan
Standard ML
Starlark
StringTemplate
Stylus
SubRip Text
SugarSS
SuperCollider
Svelte
Swift
SystemVerilog
TI Program
TLA
TOML
TSQL
TSV
TSX
TXL
Tcl
Tcsh
TeX
Tea
Terra
Texinfo
Text
TextMate Properties
Textile
Thrift
Turing
Turtle
Twig
Type Language
TypeScript
UltiSnip
UltiSnips
Unified Parallel C
Unity3D Asset
Unix Assembly
Uno
UnrealScript
Ur
Ur/Web
UrWeb
V
VBA
VCL
VHDL
Vala
Valve Data Format
Verilog
Vim Help File
Vim Script
Vim Snippet
Visual Basic .NET
Vue
Wavefront Material
Wavefront Object
Web Ontology Language
WebAssembly
WebVTT
Wget Config
Wikitext
Windows Registry Entries
Wollok
World of Warcraft Addon Data
X BitMap
X Font Directory Index
X PixMap
X10
XC
XCompose
XML Property List
XML
XPages
XProc
XQuery
XS
XSLT
Xojo
Xonsh
Xtend
YAML
YANG
YARA
YASnippet
Yacc
ZAP
ZIL
Zeek
ZenScript
Zephir
Zig
Zimpl
abl
abuild
acfm
aconf
actionscript 3
actionscript3
ada2005
ada95
adobe composite font metrics
adobe multiple font metrics
advpl
ags
ahk
altium
amfm
amusewiki
apache
apkbuild
arexx
as3
asm
asp
aspx
aspx-vb
ats2
au3
autoconf
b3d
bash session
bash
bat
batch
bazel
blitz3d
blitzplus
bmax
bplus
bro
bsdmake
byond
bzl
c++-objdump
c2hs
cURL Config
cake
cakescript
cfc
cfm
cfml
chpl
clipper
coccinelle
coffee
coffee-script
coldfusion html
console
cperl
cpp
csharp
csound-csd
csound-orc
csound-sco
cucumber
curlrc
cwl
dcl
delphi
desktop
dircolors
django
dosbatch
dosini
dpatch
dtrace-script
eC
ecr
editor-config
edn
eeschema schematic
eex
elisp
emacs muse
emacs
email
eml
erb
fb
fish
flex
foxpro
fsharp
fstar
ftl
fundamental
gf
git-ignore
gitattributes
gitconfig
gitignore
gitmodules
go mod
go sum
go.mod
go.sum
golang
groff
gsp
hbs
heex
help
html+django
html+jinja
html+ruby
htmlbars
htmldjango
hylang
i7
ignore
igor
igorpro
ijm
inc
inform7
inputrc
irc logs
irc
java server page
jq
jruby
js
jsonc
jsp
kak
kakscript
keyvalues
ksy
lassoscript
latex
leex
lhaskell
lhs
lisp
litcoffee
live-script
ls
m2
m68k
mIRC Script
macruby
mail
make
man page
man
man-page
manpage
markojs
max/msp
maxmsp
mbox
mcfunction
mdoc
mediawiki
mf
mma
mumps
mupad
nanorc
nasm
ne-on
nesC
nette object notation
nginx configuration file
nixos
njk
node
npmrc
nroff
nush
nvim
obj-c
obj-c++
obj-j
objc
objc++
objectivec
objectivec++
objectivej
objectpascal
objj
octave
odin-lang
odinlang
oncrpc
ooc
openedge
openrc
osascript
pandoc
pasm
pcbnew
perl-6
perl6
pir
plain text
posh
postscr
pot
pov-ray
povray
progress
protobuf
pwsh
pycon
pyrex
python3
q
ql
qsharp
ragel-rb
ragel-ruby
rake
raw
razor
rb
rbx
reStructuredText
readline
red/system
redirects
regex
regexp
renpy
rhtml
robots txt
robots
robots.txt
rpcgen
rs
rs-274x
rss
rst
rusthon
salt
saltstate
sed
sepolicy
sh
shell-script
shellcheckrc
sml
snippet
sourcemod
soy
specfile
splus
squeak
terraform
tl
tm-properties
troff
ts
udiff
vb .net
vb.net
vb6
vbnet
vdf
vim
vimhelp
viml
visual basic 6
visual basic for applications
visual basic
vlang
wasm
wast
wdl
wgetrc
wiki
winbatch
wisp
wl
wolfram lang
wolfram language
wolfram
wsdl
xBase
xbm
xdr
xhtml
xml+genshi
xml+kid
xpm
xsd
xsl
xten
yas
yml
zsh


key: filePatterns

description:
A file name pattern to match against repository to enable this workflow when match is succeed
https://docs.github.com/en/actions/using-workflows/creating-starter-workflows-for-your-organization#creating-a-starter-workflow


description: A particle for a Minecraft resource pack config schema


description: A trim material for a Minecraft data pack config schema


description: Documentation: https://aka.ms/swa/config-schema

enum: GET HEAD POST PUT DELETE PATCH CONNECT OPTIONS TRACE

examples: anonymous authenticated

required: openIdIssuer clientSecretSettingName

required: registration login

route: /example

route: /login

.config: application/xml


key: route

description: Request route pattern to match. May contain valid wildcards. See documentation: https://aka.ms/swa/config-schema


key: methods

description: Request method(s) to match


key: allowedRoles

description: Roles that are allowed to access this route. If not empty, only role(s) listed are authorized to access the route. Roles are only used for authorization; they are not used to evaluate whether the route matches the request.


key: headers

description: Override any matching global headers


key: redirect

description: Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301.


key: statusCode

description: Status code override


key: rewrite

description: A path to rewrite the request route to


key: rolesSource

description: Route to API function for assigning roles. For example, "/api/GetRoles". See https://aka.ms/swa-roles-function


key: enabled

description: <false> if the azureActiveDirectory provider is not enabled, <true> otherwise


key: openIdIssuer

description: The endpoint for the OpenID configuration of the AAD tenant


key: clientIdSettingName

description: The name of the application setting containing the Application (client) ID for the Azure AD app registration


key: clientSecretSettingName

description: The name of the application setting containing the client secret for the Azure AD app registration


key: userDetailsClaim

description: The name of the claim from which we should read user details


description: <false> if the apple provider is not enabled, <true> otherwise


description: The name of the application setting containing the Client ID


description: The name of the application setting containing the Client Secret


description: <false> if the facebook provider is not enabled, <true> otherwise


key: appIdSettingName

description: The name of the application setting containing the App ID


key: appSecretSettingName

description: The name of the application setting containing the App Secret


description: <false> if the gitHub provider is not enabled, <true> otherwise


description: <false> if the google provider is not enabled, <true> otherwise


description: <false> if the twitter provider is not enabled, <true> otherwise


key: consumerKeySettingName

description: The name of the application setting containing the Consumer Key


key: consumerSecretSettingName

description: The name of the application setting containing the Consumer Secret


description: <false> if the custom OpenID Connect provider is not enabled, <true> otherwise


key: authorizationEndpoint

description: The path to the authorization endpoint


key: tokenEndpoint

description: The path to the token endpoint


key: issuer

description: The path to the issuer endpoint


key: certificationUri

description: The path to the jwks uri


key: wellKnownOpenIdConfiguration

description: The path to the well known configuration endpoint


key: routes

description: Route definitions to modify routing behavior


key: navigationFallback

description: A default file to return if the request does not match a resource


key: rewrite

description: The default file to return if the request does not match a resource


key: exclude

description: Paths to exclude from the fallback route. May use valid wildcards. https://aka.ms/swa/config-schema


key: responseOverrides

description: Custom error pages or redirects


key: redirect

description: Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301.


key: statusCode

description: Status code


description: A path to rewrite the request route to


key: mimeTypes

description: Custom mime types configuration


key: globalHeaders

description: Default headers to set on all responses


key: networking

description: Networking configuration


key: allowedIpRanges

description: Restrict access to one or more IPv4 ranges. Supports CIDR notation (e.g., "192.168.100.14/24")


key: forwardingGateway

description: Forwarding gateway configuration


key: allowedForwardedHosts

description: The value of `X-Forwarded-Host` to allow to be used when generating redirect URLs


key: requiredHeaders

description: HTTP header name/value pairs that are required for access


key: platform

description: Platform configuration


key: apiRuntime

description: Language runtime for the managed functions API


key: trailingSlash

description: Trailing slash configuration

enum: always never auto


key: $schema

description: JSON schema


description:
JSON schema for the deployed cli config file.

See also: https://hyhello.github.io/deployed

type: string object

required: mode name host port username localPath remotePath

required: projectName modeList


key: privateKey

description: Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).


key: passphrase

description: For an encrypted privateKey, this is the passphrase used to decrypt it.


key: script

description: Execute script commands.


key: backupName

description: Old version backup name.


key: removeLocalDir

description: Delete localpath after deployment.


key: clearRemoteDir

description: Empty the old version before deploying the new version.


key: projectName

description: Name of project to be released.


key: cluster

description: Alias collection of environment to be deployed.


key: mode

description: Deployment environment alias.


key: name

description: Deployment environment name.


key: host

description: Hostname or IP address of the server.


key: port

description: Port number of the server.


key: username

description: Username for authentication.


key: password

description: Password for password-based user authentication.


key: remotePath

description: Deployment path.


key: localPath

description: Local upload path.


key: backupPath

description: Backup path.


key: plugin

description: List of plugins to load and use.


key: items

description: The name of the plugin.


description: The options of the plugin.


key: $schema

description: JSON Schema for deployed.


key: poetry-author-pattern

description: Pattern that matches `Name <email>` like 'King Arthur' or 'Miss Islington <miss-islington@python.org>'.


key: poetry-authors

description: List of authors that contributed to the package. This is typically the main maintainers, not the full list.


key: poetry-maintainers

description: List of maintainers, other than the original author(s), that upkeep the package.


key: poetry-include-path

description: Path to file or directory to include.


key: poetry-package-format

description: A Python packaging format.

enum: sdist wheel


key: poetry-package-formats

description: The format(s) for which the package must be included.


description: A version constraint. Validates against the PEP 440's version pattern.


key: python

description: The python versions for which the dependency should be installed.


key: platform

description: The platform(s) for which the dependency should be installed.


key: markers

description: The PEP 508 compliant environment markers for which the dependency should be installed.


key: allow-prereleases

description: Whether the dependency allows prereleases or not.


key: allows-prereleases


key: optional

description: Whether the dependency is optional or not.


key: extras

description: The required extras for this dependency.


key: source

description: The exclusive source used to search for this dependency.


key: git

description: The url of the git repository.


key: branch

description: The branch to checkout.


key: tag

description: The tag to checkout.


key: rev

description: The revision to checkout.


key: subdirectory

description: The relative path to the directory where the package is located.


key: develop

description: Whether to install the dependency in development mode.


key: file

description: The path to the file.


key: path

description: The path to the dependency.


key: url

description: The url to the file.


key: python


key: platform


key: markers


key: poetry-script-legacy

description: A simple script pointing to a callable object.


key: poetry-extra-scripts

description: Either a console entry point or a script file that'll be included in the distribution package.

enum: file console

required: reference type


key: reference

description: If type is file this is the relative path of the script file, if console it is the module name.


key: type

description: Value can be either file or console.


key: extras

description: The required extras for this script. Only applicable if type is console.


key: poetry-extra-script-legacy

description: A script that should be installed only if extras are activated.


key: callable

description: The entry point of the script. Deprecated in favour of reference.


description: The required extras for this script.


key: poetry-build-script

description: The python script file used to build extensions.


key: poetry-build-config

description: Build specific configurations.


key: generate-setup-file

description: Generate and include a setup.py file in sdist.


key: BuildSystem

description: Build-related data.


key: requires

description: A list of strings representing [PEP 508](https://www.python.org/dev/peps/pep-0508) dependencies required to execute the build system.


key: build-backend

description: Python path to project's build backend


key: backend-path

description: paths to prepend to 'sys.path' when loading the build backend, relative to project root


key: tool

description:
A table for tool configurations.

Every tool that is used by the project can have its own sub-table for its configuration.

required: name version description authors

profile: black


key: name

description: Package name.


key: version

description: Version of the package. It should follow semantic versioning, but it is not enforced.


key: description

description: Short package description.


key: items

description: A tag/keyword that this package relates to.


key: homepage

description: Homepage URL for the project.


key: repository

description: Repository URL for the project.


key: documentation

description: Documentation URL for the project.


key: license

description: License name.


key: readme

description: The path to the README file.


description: A list of paths to the readme files.


key: classifiers

description: A list of trove classifers.


key: packages

description: A list of packages to include in the final distribution.


description: Information about where the package resides.


key: from

description: Where the source directory of the package resides.


key: include

description: A list of files and folders to include.


key: exclude

description: A list of files and folders to exclude.


key: dependencies

description: This is a hash of package name (keys) and version constraints (values) that are required to run this package.


key: python

description: The Python versions the package is compatible with.


key: dev-dependencies

description: This is a hash of package name (keys) and version constraints (values) that this package requires for developing it (testing tools and such).


key: group

description: This represents groups of dependencies


description: This represents a single dependency group


key: optional

description: Whether the dependency group is optional or not


description: The dependencies of this dependency group


key: scripts

description: A hash of scripts to be installed.


key: plugins

description: A hash of hashes representing plugins


description: The full url of the custom url.


description: AKA the README

content-type: text/plain

text:
# Example project

An example project

content-type: text/markdown


key: content-type

description: RFC 1341 compliant content-type (with optional charset, defaulting to UTF-8)


description: A SPDX license identifier


key: optional-dependencies

description: keys are extra names


description: The OSS-Review-Toolkit (ORT) provides a possibility to resolve issues, rule violations and security vulnerabilities in a resolutions file. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-resolutions-yml.md.

required: message reason

required: id reason


description: JSON schema for zapp.json and zapp.yaml files. Version 1.0.0 -- Licensed Materials - Property of IBM - (c) Copyright IBM Corporation 2022. All Rights Reserved.

enum: cobol pl1 hlasm rexx jcl

required: name type locations

default: syslib

examples: syslib currencylib

enum: mvs local

default: local

examples: local mvs

type: object string

format: email

required: name type

enum: dbb rseapi debug

default: dbb

examples: dbb rseapi

required: name type settings

const: dbb

const: rseapi

required: application command

enum: text binary


key: name

description: The name of the Z Project.


key: description

description: This helps people understand your project as it would be used by tools.


key: version

description: Version is a string and it must be parsable for managing dependencies.


key: groupId

description: Defines a group name that is shared for each application part in case of applications composed of multiple parts. Allows to uniquely identify the parts by concatenating with the artifact id. For example a groupId `com.ibm.wazi` with an artifactId `service` would create the unique application identifier `com.ibm.wazi.service`.


key: artifactId

description: Define id of the application artifact. Use it in combination with a groupId for multi-part applications.


key: parentId

description: In case of a multi-part application defines the name of the parent application part. This zapp will inherit properties such as propertyGroups defined in the parent.


key: keywords

description: This helps people discover your project.


key: homepage

description: The url to the project homepage.


key: license

description: You should specify a license for your package so that people know how they are permitted to use it and any restrictions you're placing on it.


key: contributors

description: A list of people who contributed to this package.


key: maintainers

description: A list of people who maintain this package.


key: propertyGroups

description: A list properties defining path names for resolving dependencies.


key: profiles

description: Profiles are additional groups of properties that should only should become valid under specific conditions such as running in a build job or as part of a debug session.


description: The name of the property group, which is used in hovers and error messages.


key: language

description: Limits the property group to one specific language.


key: compilerOptions

description: Global compiler options separated by a comma that impact the parsing of the programs for the editor. Requires that you specify a language. If there are multiple Property Groups for a language with compiler option then they will be concatenated.


key: libraries

description: An array of potential library locations defining the search order for include files. Libraries with the name 'syslib' will be handled as default include locations. The list can contain many entries of the type 'local' or 'mvs'. It can contain items of the same type twice in case, for example, you want to search in remote locations first, then some local location, and if still not found more remote locations.


description: Name of the library. The default name should be `syslib` if using unamed libraries.


key: type

description: The type of the property group defining where dependencies should be located. Allowed values are 'local' for using a local workspace and 'mvs' for dependencies located in MVS Datasets.


key: locations

description: An array of include file locations. For 'local' libraries values can be absolute and relative filename paths using GLOB patterns. For 'mvs' libraries value can be data set names. GLOB patterns for dat sets are currently not supported.


key: person

description: A person who has been involved in creating or maintaining this package


key: profile


key: name

description: The name of the profile.


description: The type of the profile.


key: settings

description: Settings objects specific to the type specified for the profile.


key: dbbSettingsItem

description: DBB build script properties for running User Build on remote host.


key: application

description: Defines the name of the application to build. Will be used to create a folder on USS to upload all files to.


key: command

description: Command that the build script is executed with such as the path to groovyz and it's parameters.


key: buildScriptPath

description: The full path of build script on the remote host that should be used with the command.


key: buildScriptArgs

description: A list of strings that are the parameters for the build script. Check the documentation for built-in variables, such as the name of the program to build, that can be used here.


key: additionalDependencies

description: Lists of GLOB patterns that define the files that should be uploaded to USS for a build. Relative path names are interpreted relative to the location of the ZAPP file that is being used for the build, which is a ZAPP file in the same workspace as the program to be build.


key: logFilePatterns

description: Lists of GLOB patterns that define the files that should be downloaded from USS after the build. Relative path names are interpreted relative to the DBB log directory user setting. If not provided then all files of the user setting location will be downloaded.


key: rseapiSettingsItem

description: RSE API client settings for interactions with a z/OS remote host running an RSE API server.


key: mappings

description: A list of mapping objects that map local file extensions to transfer modes and encodings to MVS datasets that can be specified using wildcards.


description: The encoding to be used when no mapping can be found. If not provided then either the user or server default will be used.


key: rseapiSettingsItemMapping

description: One mapping that contains at least transfer and resource values.


key: extension

description: A local file extension such as cbl or pl1.


key: transfer

description: The transfer mode to be used. Can be 'text' or 'binary'.


key: resource

description: The data set name to be mapped to. Can use a wildcard such as '**CPY'.


key: encoding

description: The encoding to be used for text transfer. See the RSE API documentation for the values allowed.


key: memberMappings

description: A nested mappings array with resource mappings to members of the data sets that were mapped by the parent mapping.


key: items

description: One member mapping that contains at least transfer and resource values.


description: The data set member name to be mapped to. Can use a wildcard such as '**CPY'.


description:
Settings of the current site
https://madness.dannyb.co/#configuration-file

default: true

default: false

default: Page Source

enum: top bottom

default: bottom

default: Restricted Documentation


key: path

description:
A path to the documentation root of the current site
https://madness.dannyb.co/#configuration-file


key: port

description:
A server port of the current site
https://madness.dannyb.co/#configuration-file


key: bind

description:
A server listen address of the current site
https://madness.dannyb.co/#configuration-file


description:
A server root path of the current site
https://madness.dannyb.co/#configuration-file


key: sidebar

description:
Whether to enable sidebar of the current site
https://madness.dannyb.co/#configuration-file


description:
Whether to add H1 title to files that do not have one of the current site
https://madness.dannyb.co/#configuration-file


description:
Whether to append navigation to directory READMEs of the current site
https://madness.dannyb.co/#configuration-file


description:
Whether to enable table of contents of the current site
https://madness.dannyb.co/#configuration-file


key: highlighter

description:
Whether to enable syntax highlighter for code snippets of the current site
https://madness.dannyb.co/#configuration-file


description:
Whether to enable the copy to clipboard icon for code snippets of the current site
https://madness.dannyb.co/#configuration-file


key: shortlinks

description:
Whether to convert [[Links]] to [Links](Links) of the current site
https://madness.dannyb.co/#configuration-file


key: toc

description:
Whether to generate a table of contents file with this name of the current site
https://madness.dannyb.co/#configuration-file


key: theme

description:
A theme directory of the current site
https://madness.dannyb.co/#configuration-file


description:
A link to the page source of the current site
https://madness.dannyb.co/#configuration-file


description:
A link of page source label of the current site
https://madness.dannyb.co/#configuration-file


description:
A link of page source position of the current site
https://madness.dannyb.co/#configuration-file


key: open

description:
Whether to open the server URL in the browser of the current site
https://madness.dannyb.co/#configuration-file


key: auth

description:
Whether to provide user:password for basic authentication of the current site
https://madness.dannyb.co/#configuration-file


description:
An auth realm name of the current site
https://madness.dannyb.co/#configuration-file


description:
Whether to show files with these extensions in the navigation and search of the current site
https://madness.dannyb.co/#configuration-file


key: exclude

description:
Excluded directories of the current site
https://madness.dannyb.co/#configuration-file


description:
An excluded directory of the current site
https://madness.dannyb.co/#configuration-file


description: NetinDS device configuration template, defines the drivers used to collect the datapoints and the transformations and alarms to be applied to these datapoints

errorMessage: Not valid version string, for more information see : https://semver.org/

errorMessage: origin should be a string. Maximum size of 80 alphanumerical characters or symbol: -_.

errorMessage: templateId should be a string. Maximum size of 80 alphanumerical characters or symbol: -_

errorMessage: templateVersion should be a valid version string. For more information see : https://semver.org/

errorMessage: description should be a string of at least one character and maximum 800 characters

errorMessage: DeviceID should be a string

errorMessage: vendorID should be a string

label: PROFINET based

label: SNMP based

errorMessage: Should be a string and follow the pattern: alphanumerical characters and - symbol, maximum length 80

label: PROFINET Driver

originType: netin-ds-drv-pnio

label: SNMP Driver

originType: netin-ds-drv-snmp

readCommunity: public

writeCommunity: private

privacyAlgorithm: DES

label: ICMP Driver

originType: netin-ds-drv-icmp

label: S7 Driver

label: MQTT Broker Driver

originType: netin-ds-drv-mqtt

topicName: MyTopic

datapointSet: MyDatapointSet

strategyId: property

property: MyProperty

operationMode: extract

label: MODBUS Driver

originType: netin-ds-drv-modbus-tcp

enum: map tableStatic tableDynamic

errorMessage: datapointSetType should be a string. DatapointSet type is datapointSetType, and should be one of: map, tableStatic, tableDynamic

errorMessage: DatapointSet identification must be alphanumeric string [1-40], "-" & "_" are also allowed

errorMessage: rootAddress should be a string [0-240]

errorMessage: Indexes must be an array of datapoint identification strings

errorMessage: Broadcast flag should be a boolean

errorMessage: Should be a string of less than 80 characters

errorMessage: DataType should be one of: BYTE, INTEGER, LONG, FLOAT, DOUBLE, STRING, BOOLEAN, DATE, ARRAY, INTEGER_ARRAY, STRING_ARRAY, DOUBLE_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, LONG_ARRAY, OBJECT

errorMessage: Driver side data type should follow the pattern: alphanumerical string +"-" and "_", size [1-80]

errorMessage: Datapoint address should be an alphanumerical string [1-80] and [_&#:$.-]

enum: read-only write-only read-write not-accessible

errorMessage: Datapoint access type should be a string and one of: read-only, write-only, read-write, not-accessible

enum: polling singleQuery subscription

errorMessage: Receive mode should be a string and one of: polling, singleQuery, subscription

errorMessage: Polling group should be a string and one of: 5s, 10s, 30s, 1m, 5m, 10m, 15m, 30m, 1h, 4h, 6h, 12h, 1d

enum: SIMPLE TIMEPOINT DATAPOINT @DATAPOINT @TIMEPOINT #DATAPOINT #TIMEPOINT

errorMessage: DatapointType must be one of: SIMPLE, TIMEPOINT, DATAPOINT, @DATAPOINT, @TIMEPOINT, #DATAPOINT, #TIMEPOINT

errorMessage: Should be a string and follow the pattern: alphanumerical and symbols #&_- with less than 41 characters

errorMessage: Should be a string of at least one characters and less than 40 characters

errorMessage: Should be a string of at least one character and less than 800 characters

required: expression symbol

errorMessage: Should be a number greater than -1 and lower than 1001

errorMessage: Should be a number greater than 200 and lower than 1001

errorMessage: Should be a number greater than 0 and lower than 201

errorMessage: Should be a string of at least one character and less than 500 characters

errorMessage: Should be boolean

errorMessage: Should be a number in the range [-1, 255]

errorMessage: Should be a string of at least one character and less than 80 characters

required: expressions logic severity text textHelp onStartup audited hidden broadcast facility

examples:
Packets errors
Partner

errorMessage: Should be a string of at least one character and less than 1200 characters

required: datapointId datapointType

required: dataType originType originDataType originAddress originAccessType receiveMode pollingGroup

required: isDefault rawValue value

required: isDefault value

required: isDefault rawValue

errorMessage: Should be a string of at least one characters and less than 80 characters

errorMessage: Should be an array of datapoint configuration objects. There should be at least one datapoint in a datapointSet

required: alias datapoints datapointSetId datapointSetType description

errorMessage: Data should be an string of device[datapointSetId] or device[datapointSetId.datapointId]

errorMessage: First row should be a number greater than 1

errorMessage: First column should be a number between 1 and 8

errorMessage: Widget width should be a number between 1 and 8

errorMessage: Widget height should be a number greater than 1

errorMessage: Widget type should be one of the following options: map, table, metric, gauge

errorMessage: Widget title should be a string of at least one character and maximum 800 characters

required: firstRow firstColumn widgetWidth widgetHeight widgetType widgetTitle

errorMessage: Should be a array and have at least one entry

errorMessage: Representation should be a array and have at least one entry

required: origin templateId templateVersion description datapointSets


key: schemaVersionDef

description: Fixed value designating the version of the template schema

errorMessage: Not valid version string, for more information see : https://semver.org/


key: originDef

description: Monitored system, subsystem, device or ... source of the datapoint

errorMessage: origin should be a string. Maximum size of 80 alphanumerical characters or symbol: -_.


key: templateIdDef

description: Template identification string

errorMessage: templateId should be a string. Maximum size of 80 alphanumerical characters or symbol: -_


key: templateVersionDef

description: SemVer style template version

errorMessage: templateVersion should be a valid version string. For more information see : https://semver.org/


key: descriptionDef

description: Detailed information about the device or system to be monitored by this device

errorMessage: description should be a string of at least one character and maximum 800 characters


key: rangerFilterDef

description: Tags used by Ranger to match discoverd devices with their respective templates

errorMessage: DeviceID should be a string

errorMessage: vendorID should be a string


key: deviceID

description: Regular expression for PROFINET device identification field in hexadecimal format


key: vendorID

description: Regular expression for PROFINET manufacturer identification field in hexadecimal format


key: description

description: Regular expression for SNMP sysDescr OID (1.3.6.1.2.1.1.1) device description


key: defaultSnippets

description: Ranger filter for a PROFINET device


description: Ranger filter for a SNMP device


key: body

description: SIMATIC NET


key: originTypeDef

description: Driver (Origin type) identification string for the driver

errorMessage: Should be a string and follow the pattern: alphanumerical characters and - symbol, maximum length 80


key: originTypeConfigDef

description: Driver (Origin type) configuration object. Check the specific documentation for each driver


description: Basic PROFINET Driver configuration


description: Basic SNMP Driver configuration


description: Basic ICMP configuration


description: Basic S7 configuration


description: Basic MQTT Broker configuration


description: Basic MODBUS Broker configuration


key: datapointSetTypeDef

description: Define the data structure of this datapointSet, check the documentation for more information

errorMessage: datapointSetType should be a string. DatapointSet type is datapointSetType, and should be one of: map, tableStatic, tableDynamic


key: datapointSetIdDef

description: DatapointSet identification string

errorMessage: DatapointSet identification must be alphanumeric string [1-40], "-" & "_" are also allowed


key: tableAddressDef

description: Specific configuration for tabled based datapointSets

errorMessage: rootAddress should be a string [0-240]

errorMessage: Indexes must be an array of datapoint identification strings


key: rootAddress

description: Main address for the table, this information is specific for each kind of driver


key: indexes

description: Array of datapointIds that will act as table indexes, this means columns that acts as keys of the table


key: items

description: One of the datapointId of the table type datapointSet


key: broadcastDef

description: Flag to indicate that the alarm/datapointSet will be broadcasted to NetinHUB channels

errorMessage: Broadcast flag should be a boolean


key: topic

description: Define the topic that should be used to transport the data

errorMessage: Should be a string of less than 80 characters


key: service

description: Define the service that should consume the information


key: serviceConfig

description: Object to define the specific configuration of the service


key: dataTypeDef

description: Define the type of the data in the NetinDS context, this means how NetinDS will manage the data before the conversions

errorMessage: DataType should be one of: BYTE, INTEGER, LONG, FLOAT, DOUBLE, STRING, BOOLEAN, DATE, ARRAY, INTEGER_ARRAY, STRING_ARRAY, DOUBLE_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, LONG_ARRAY, OBJECT


key: originDataTypeDef

description: Define the type of the data in the driver context, this means how the type of data that driver expect to collect

errorMessage: Driver side data type should follow the pattern: alphanumerical string +"-" and "_", size [1-80]


key: originAddressDef

description: Define the address of this datapoint. This is specific for each driver

errorMessage: Datapoint address should be an alphanumerical string [1-80] and [_&#:$.-]


key: originAccessTypeDef

description: Access level to the datapoint. This is specific for each driver

errorMessage: Datapoint access type should be a string and one of: read-only, write-only, read-write, not-accessible


key: receiveModeDef

description: Define how the driver should get the value of this datapoint. This is specific for each driver

errorMessage: Receive mode should be a string and one of: polling, singleQuery, subscription


key: pollingGroupDef

description: Frequency in which the driver should update the value of this datapoint. This is specific for each driver

errorMessage: Polling group should be a string and one of: 5s, 10s, 30s, 1m, 5m, 10m, 15m, 30m, 1h, 4h, 6h, 12h, 1d


key: datapointTypeDef

description: Define the kind of information types, within NetinDS context, that the driver/zavod instances will generate for this datapoint

errorMessage: DatapointType must be one of: SIMPLE, TIMEPOINT, DATAPOINT, @DATAPOINT, @TIMEPOINT, #DATAPOINT, #TIMEPOINT


key: datapointIdDef

description: Datapoint identification string

errorMessage: Should be a string and follow the pattern: alphanumerical and symbols #&_- with less than 41 characters


key: symbolDef

description: Identification string for logic expression

errorMessage: Should be a string of at least one characters and less than 40 characters


key: expressionDef

description: Expression to be evaluated by NetinDS-Zavod

errorMessage: Should be a string of at least one character and less than 800 characters


key: expressionLogicObjectDef

description: Expressions that will be checked in this evaluation


key: severityDef

description: Level of criticality of the alarm

errorMessage: Should be a number greater than -1 and lower than 1001


key: severityForAlarmsDef

description: Level of criticality of the alarm

errorMessage: Should be a number greater than 200 and lower than 1001


key: severityForLogsDef

description: Level of criticality of the log

errorMessage: Should be a number greater than 0 and lower than 201


key: textDef

description: Alarm/event descriptive text

errorMessage: Should be a string of at least one character and less than 500 characters


key: auditedDef

description: Flag indication for audit process

errorMessage: Should be boolean


key: hiddenDef

description: Flag to indicate that the alarm is hidden by user request


key: facilityDef

description: Ident number for the resource group

errorMessage: Should be a number in the range [-1, 255]


key: logicDef

description: Logic operation to be applied between all the expressions

errorMessage: Should be a string of at least one character and less than 80 characters


key: evaluationForLogsDef

description: Array with all the evaluations that will be checked


key: expressions

description: Array of logical expression than should return a boolean value


key: text

description: Alarm/event descriptive text


key: textHelp

description: Descriptive information that help to understand the alarm


key: onStartup

description: Indicates wether the alert must be sent when the conditions are met from the beginning


key: evaluationForAlarmsDef


key: valueDef

description: Value or rawValue of a datapoint


key: commonConfigDef

description: Datapoint common configuration object

errorMessage: Should be a string of at least one character and less than 1200 characters


key: alias

description: Alias name for the datapoint, used as representation label


key: description

description: Detailed information about the datapoint

examples:
Number of packets dropped for error
Name of the partner


key: syntaxInfo

description: Description about the syntax of this datapoints values


key: addressConfigDef

description: Datapoint address configuration object


key: alertConfigDef

description: Allows to configure trigger of alarms and events depending on the datapoint values


key: calcConfig

description: Allows to create new datapoints based on an expression


key: convConfigDef

description: Allows to apply enrichment expressions on the value field


key: defaultValueConfigDef

description: Allows to apply default values to a datapoint when the value or rawValue is null


key: isDefault

description: Flag to indicate that the value is used as substitution value


key: rawValue

description: Value to be assigned to rawValue field


key: value

description: Value to be assigned to value field


key: rowFilterConfigDef

description: Allows row filtering in table based datapointSets


key: expressions


key: unitsConfigDef

description: Allows converts between measure units

examples: m g

required: from to

required: toBest exclude

required: from toBest


key: from

description: Actual measure units


key: to

description: Desired measure units


key: toBest

description: Select the measure unit that best fit


key: exclude

description: Array of excluded measure units, when toBest is enabled


key: items

description: Exclude measure unit


key: units

description: Flag to indicate that the unit of measure must indicated


key: valueMapConfigDef

description: Allows converts rawValue to value based in a key/value map


key: map

description: Key/Value map with the conversion options


description: Entry in the key/value map


key: key

description: Entry key


description: Entry value


key: datapointConfigDef

description: Object that define a complete datapoint configuration

const: #TIMEPOINT

required: commonConfig addressConfig

required: commonConfig calcConfig

required: commonConfig defaultValueConfig

required: addressConfig calcConfig


key: datapointSetConfigDef

description: DatapointSet configuration object

errorMessage: Should be a string of at least one characters and less than 80 characters

errorMessage: Should be an array of datapoint configuration objects. There should be at least one datapoint in a datapointSet

enum: tableStatic tableDynamic


key: alias

description: Alias name for the datapointSet, used as representation label


key: description

description: Detailed information about the datapoint set

examples: Information and statistics about the ethernet interfaces

errorMessage: Should be a string of at least one characters and less than 1200 characters


key: datapoints

description: Array of datapoints for this datapoint set


key: representationDataDef

description: Datapoints that widget will use for representation

errorMessage: Data should be an string of device[datapointSetId] or device[datapointSetId.datapointId]


key: representationMapConfigDef

description: Specific configuration for map widget representation

examples: Name Type Netmask

enum: string boolean numeric date severity

required: order datapoint alias


key: format

description: Representation for each row


description: Row configuration


key: order

description: Number of the row


description: Text to display


key: fieldType

description: Format for row value


key: utc

description: Format date to UTC time


key: representationTableConfigDef

description: Specific configuration for Table widget representation

enum: basic advanced

enum: xs s m l


description: Representation for each column


key: items

description: column configuration


description: Number of the column


description: Format for column value


key: fieldGroup

description: Indicates if the column should be shown on basic or advance mode


key: filterable

description: Indicates if the column is filterable


key: filterType

description: Format for column filter


key: width

description: Column initial width


key: minScreenSize

description: Column minimun screen size


key: pageSize

description: Rows number for each page


description: Indicates if the columns should have filters


key: representationMetricConfigDef

description: Specific configuration for metric widget representation


key: url

description: Define url to opened on click event


key: titleEnabled

description: Indicate if tittle should be shown


key: urlEnabled

description: Indicate if event click must be enable


key: lastUpdateEnabled

description: Indicate if timestamp should be shown


key: representationGaugeConfigDef

description: Specific configuration for gauge widget representation

examples: Mb/s % m/s

required: from to severity

required: format maxValue minValue


key: format

description: Representation for each gauge value


description: value configuration


key: color

description: Color to display the value


key: units

description: Color to display the value


key: maxValue

description: Define the gauge maximum value


key: minValue

description: Define the gauge minimum value


key: ranges

description: Value ranges representation


key: items

description: Gauge range definition


key: from

description: First value of the range


key: to

description: Last value of the range


key: severity

description: Severity of the range


key: representationCommonConfigDef

description: Common fields for grid representation

errorMessage: First row should be a number greater than 1

errorMessage: First column should be a number between 1 and 8

errorMessage: Widget width should be a number between 1 and 8

errorMessage: Widget height should be a number greater than 1

enum: map table metric gauge

examples: map table

errorMessage: Widget type should be one of the following options: map, table, metric, gauge

examples:
Device Info
PNIO-Fault

errorMessage: Widget title should be a string of at least one character and maximum 800 characters


key: firstRow

description: Define de position of the widget, first row


key: firstColumn

description: Define de position of the widget, first column


key: widgetWidth

description: Define de size of the widget, width


key: widgetHeight

description: Define de size of the widget, height


key: widgetType

description: Select widget type


key: widgetTitle

description: Text for widget title


key: representationDef

description: What, where and how information show in device view

const: map

required: data commonConfig specificConfig

const: table

const: metric

const: gauge


key: alias

description: Alias name for the template

examples:
SCALANCE XC-200
SCALANCE X-200


key: originTypes

description: Origin types (drivers)

errorMessage: Should be a array and have at least one entry


description: codeship-steps.yml is where you configure each step to run in your CI/CD builds with CodeShip.

default: latest

const: run

const: push

const: serial

const: parallel

const: manual


key: ExternalStep

description: The definition of a step


key: name

description: The name of the step. Can be omitted.


key: type

description: The type of the step. If omitted, defaults to 'run'


key: tag

description: A pattern matching tags or branches this step and any of its children should be run against. Defaults to always running.


key: exclude

description: A pattern matching tags or branches on which this step should NOT be run. Defaults to empty.


key: service

description: The service name defined in codeship-services.yml this step will run on


key: services

description: A list of service names defined in codeship-services.yml that will be used for this step.


key: command

description: The command to be run in this step. Required with and can only be used with the 'run' type or no specified type


key: steps

description: A list of steps to run within this step or on_fail group. Cannot be used with 'run', 'push', or 'load' steps