Create the YAML File

Using a YAML-aware Editor, create the Zebra YAML script. Apica recommends using a YAML-aware code editor for ease of formatting and readability. Examples from the many such editors: * Atom * Notepad++ * Sublime Text * MS Visual Studio Code

Do not use a word processor such as Microsoft Word as it will add extraneous characters that will prevent proper compiling.

Creating a definition is simple:

  1. Create a new YAML file (for example MyScript.yml)
  2. Add the YAML definition code to that file

The definition consists of these elements:

  1. Configures the base URL for the service ( that will act as a base for the URLs provided later in the script.
    1. I.E. Where do you want to start?
  2. Defines a scenario (mandatory), names it as “MyTest” and establishes a flow.
  3. Organizes a Page Break (“My Start Page”) before we do the first GET request. (Page Breaks separate the script into roughly what actual user actions would be or the larger workflow steps.)
    1. I.E. How to organize the overall flow?
  4. Provides a relative target to access (the path,”/ticket-monster/”)
    1. What URL do you want to issue HTTP commands to?
  5. Specifies a regex pattern to capture everything as the full response

Save the YAML file to your ApicaScriptingYAML definitions directory (“yaml’ in the installation directory): /Users/$USER/Applications/ApicaScriptingTools/ ApicaScriptingYAML/yaml

Create the Script

Once done with the YAML definition, the next step is to turn this definition into a runnable script for either Load Testing or Synthetic Monitoring.

In short, running ./ will package the script into a .zip file.

Creating and packaging the script

  • Open the Terminal
  • Navigate to the ApicaScriptingYAML directory

cd /Users/$USER/Applications/ApicaScriptingTools/ApicaScriptingYAML

  • Start Zebra YAML by running the ASY shell file: ./

You will be provided with a list of .yml files that can be made into scripts.

  • Choose the file you want to use (e.g. MyScript.yml):
  • Type the number next to the file you want to select
  • Press the ENTER key.
  • The terminal will display a number of messages while working