PPA Tools PPA Tools: Inputs & Outputs

Summary

Each plugin uses a set of dictionaries to store data.

These are used by plugin actions as both inputs and outputs.

This page will cover:

  • The dictionaries used in this plugin
  • The information each dictionary contains

Dictionary Types

Date

  • Contains date & time information

  • Used as an output from now

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
display: Tue Aug 25 08:10:45 2020
date: 25/08/2020
time: '08:10:45'
day: 25
day_name: Tuesday
month: 8
month_name: August
year: 2020
hour: 8
minutes: 10
seconds: 45

Date Keys

display: The day, month, date, time, & year displayed together

date: The date in dd/mm/yyyy format

time: The time in hh:mm:ss format

day: The day as a number

day_name: The name of the day

month: The month as a number

month_name: The name of the month

year: The year as a number

hour: The hour as a number

minutes: The minutes as a number

seconds: The seconds as a number

Filter

  • Contains a dictionary key, test value, & filter type.

  • Supplied in a list to the filter_from_list dictionary action.

Required Keys

  • key: The dictionary key whose value should be tested.
  • type: A filter type (see below for more information).
  • value: The value to test against the dictionary value.

Valid Filters

All filters & the types of value they support:

  • equal (string or integer)
  • not_equal (string or integer)
  • contains (string)
  • starts_with (string)
  • ends_with (string)
  • greater_than (integer)
  • less_than (integer)
  • is (null)
  • not (null)

NamedGroup

  • Contains a name & regular expression used to extract data from some text

  • Used as an input to extract_values

  • The example below shows the dictionary structure in YAML

  • See the required keys underneath the example

Example

1
2
name: username
value: your username is (\w+)

Required Keys

name: The name to give the extracted value.

expression: A regular expression used to find the value in the text.