YAML Files

What is a YAML file?

A YAML file is a form of structured data. It is visually similar to a JSON tree, however is less strict with syntax. Think of it as key, value set for your integration.

When pushing an integration for public release, your YAML file must follow certain structural requirements in order to work properly. In this section we will review the various parts of the Cortex XSOAR YAML file.

Common Fields

The Common Fields section contains information that the Cortex XSOAR server will use to identify your integration. See the example below:

commonfields:
id: New Integration
version: -1

This section accepts the following information:

NameDescription
idA unique identifier for your integration
versionSetting the value to -1 will lock the integration from being modified

Basic Information

Observe the following:

name: MaxMind GeoIP2
display: MaxMind GeoIP2
category: Data Enrichment & Threat Intelligence
image: data:image/png;base64,**Base64 of Image Here**
description: Enriches IP addresses
detaileddescription: 'The MaxMind GeoIP2 integration allows you to query the MaxMind
API service and retrieve a JSON of all details. '

The following is an explanation of these fields:

NameDescription
nameThe name of your integration. This may be different than the display name
displayThis is the display name for your integration
categoryThe applicable category
imageThe Icon that will be used for the integration. Please note that this image must be in Base64. Ask the design team to provide you with a compatible image
descriptionA brief description of what your integration will do
detaileddescriptionThis description should go into more detail about how your integration works as well as requirements for the integration to work

Configuration

In this section, we specify the configuration requirements that are necessary for the integration to operate.

configuration:
- display: API Key
name: apikey
defaultvalue: ""
type: 0
required: true
- display: Use system proxy
name: proxy
defaultvalue: ""
type: 8
required: false

An explanation of these fields is as follows:

NameDescription
displayThe display name for the field.
nameThe parameter which is used within the integration
defaultvalueIf there is a default for the field, it should be located here
typeAn Integer that represents the type for the field.
Type 0 - Short text field
Type 4 - Encrypted text field
Type 8 - Boolean checkbox
Type 9 - Authentication text - allows switching to credentials
Type 12 - Long text block
Type 13 - special use - automatically added - Incident type single select dropdown
Type 15 - Single select dropdown
Type 16 - Multiple select dropdown
requiredBoolean value to indicate that the parameter is required

Script

This section is where your code will reside. Review the example below:

script:
script: |
import requests
import collections
def explain_yaml():
if user.understands is False:
re_read_documentation()
type: python
subtype: python3
dockerimage: demisto/python3:3.7.5.3066

Type indicates the language your integration is written in. Cortex XSOAR currently supports Python and JavaScript. When using Python specifying subtype field is required (either: python2 or python3). Additionally, when using Python dockerimage should be specified. If dockerimage is not specified a default Python 2 image will be used.

Commands

The command section tells Cortex XSOAR what arguments are required for your command as well as what the outputs are.

commands:
- name: command-name
arguments:
- name: command-argument
required: true
default: false
isArray: false
description: This is a description for the argument
outputs:
- contextPath: Example.Sample.Name
description: The name of the sample
type: string
- contextPath: Example.Sample.ID
description: The ID for the sample
type: string
description: Sample description for the command-name function
runonce: false

An explanation of these fields is as follows:

NameDescription
nameThe name of the command
arguments: nameThe name of the argument
arguments: requiredBoolean for if the argument is required
arguments: defaultBoolean for if the argument is the one chosen when argument values are passed to a command without specifying the command argument's name. Note that only one command argument can be set as the default per command
arguments: isArrayBoolean for if the argument accepts a CSV list of input values
arguments: descriptionA description of the argument
outputs: contextPathThe dot notation representation of the context
outputs: descriptionDescription of the context item
outputs: typeThe type which the context item will be formatted
descriptionA description for the command
runonceBoolean to indicate if the function runs repeatedly

Version and Tests

The last section of the YAML file provides Cortex XSOAR with information regarding what version is supported and tests. See the example below:

fromversion: 4.1.0
tests:
- Sample Integration Test

From version indicates the server version that is supported with the integration. If the server version is below the fromversion, the integration will not display in the Settings area.

Tests instructs the Cortex XSOAR CircleCI tool which test to run to verify that the integration is working.

If you want to run all of the tests you will need to add to the tests section Run all tests as the test you would like to run.


If you want to live a life of shame and disappoint your team, you can opt to not run any tests by adding No test - <reason> as a test you would like to run. You can attempt to earn back the respect of your team by writing a reason for skipping the test and we may consider it.


Please take into consideration that both the automatic and the manual mechanisms are working side by side and don't override each other, and don't worry it will not cause the same test to run more than once.

Entry Types

IDNameDetails
1NoteA note is a text entry in the war room.
2Download AgentInternal use only
3FileA file and it's metadata will be displayed
4ErrorObserved with a red background, this indicates that a command did not run successfully.
5PinnedInternal use only
6User ManagementInternal use only
7ImageAn image will be displayed in the war room.
8Playground ErrorAn error has occurred in the playground
9Entry Info FileUsed in the FileResult function in ServerCommon. This is similar to the file entry type.
10-14ReservedThis is for future entry types
15MapPosts a map location in the war room. Please note: This will require an API key from Google maps.
Last updated on