Workflow Components

Conventions:

  • bold port name indicates that it is required
  • (parentheses) indicate data type accepted or emitted
  • all type means the data can be any type
  • bang means the data type is irrelevant only the presence of data matters

Atlas

Compact Dataset

Combine part files within a dataset up to some specified limit

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (AtlasRecord|string) - Atlas record
  • options (object|string) - Compact options
    • handling (object) - Configure how this component will respond to failures
    • max_size (number) - Maximum part file size in bytes
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • done (boolean)
  • error (Error)

Copy Dataset

Copies data from one Atlas record(source) to another(target), across resources if necessary

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • source (AtlasRecord|string) - Atlas record to copy from
  • target (AtlasRecord|string) - Atlas record to copy to
  • options (object|string) - Copy options
    • handling (object) - Configure how this component will respond to failures
    • write_mode (string)
      • values: create, overwrite, overwrite_content, append
    • update_schema (boolean) - Update target with schema from source record
    • validate_schema (boolean) - Validate source and target schema compatibility
    • start_date (string)
    • end_date (string)
    • limit (number) - To limit the copy of number of bytes
    • skip (number) - Skip number of bytes before copying
    • retry (boolean) - Enable retry for certain error types
      • default: true
    • cachedmode (boolean) - To return previous results if possible
    • includeHeader (boolean) - To include header in the target record
    • move (boolean) - Move the source dataset instead of making a copy
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)
  • target (AtlasRecord) - Atlas record copied to

Copy Dataset Multi

Copies data from given set(s) of Atlas records to another, across resources if necessary.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight Context
  • records (Array|string) - List of source/target Atlas Record id pairs
  • options (object|string) - Copy options
    • handling (object) - Configure how this component will respond to failures
    • write_mode (string)
      • values: create, overwrite, overwrite_content, append
    • update_schema (boolean) - Update target with schema from source record
    • validate_schema (boolean) - Validate source and target schema compatibility
    • start_date (string)
    • end_date (string)
    • limit (number) - To limit the copy of number of bytes
    • skip (number) - Skip number of bytes before copying
    • cachedmode (boolean) - To return previous results if possible
    • includeHeader (boolean) - To include header in the target record
    • move (boolean) - Move the source dataset instead of making a copy
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • concurrency (integer) - Number of concurrent copies to perform. Max is 5.
  • wait (any)

Outputs:

  • error (Error)
  • jobs (Array) - List of job objects

Create Atlas Record

Create an atlas record

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (object|string) - Atlas record to create
  • organization (Organization|string) - Organization to create the record under
  • project (Project|string) - Project to create the record under
  • wait (any)

Outputs:

  • error (Error)
  • record (AtlasRecord) - Atlas record

Delete Atlas Record

Delete Atlas record

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (AtlasRecord|string) - Atlas record
  • options (object|string) - Deletion options
    • handling (object) - Configure how this component will respond to failures
    • ignoreRecord (boolean) - Delete the dataset but not the record itself
  • wait (any)

Outputs:

  • done (boolean)
  • error (Error)

Download Structured Data

Download a small amount of structured data from a record in object mode

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (AtlasRecord|string) - Atlas record
  • options (object|string) - Download options
    • handling (object) - Configure how this component will respond to failures
  • limit (integer) - Number of rows to download
  • wait (any)

Outputs:

  • data (Array[object]) - List of row objects
  • error (Error)

Get Atlas Record

Gets an Atlas record by id. Emits error if not found.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - Record id
  • wait (any)

Outputs:

  • error (Error)
  • record (AtlasRecord) - Atlas record

Ingest from Query

Runs a stored query and saves the results into a dataset

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • query (StoredQuery|string) - Stored query ID, or query text
  • target (AtlasRecord|string) - Atlas record to save to
  • resource (Resource|string) - Query resource
  • options (object|string) - Options
    • handling (object) - Configure how this component will respond to failures
    • name (string) - Query name
    • update_schema (boolean) - Update target schema
      • default: true
    • string_mode (boolean) - Retrieve all values as strings regardless of source record schemas
    • include_header (boolean) - To include header in the target record
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)
  • target (string) - Atlas record containing the result data

Initialize Dataset

Initialize dataset to be empty

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (AtlasRecord|string) - Atlas record
  • options (object|string) - Init options
    • handling (object) - Configure how this component will respond to failures
    • write_mode (string)
      • values: create, overwrite, overwrite_content
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • done (boolean)
  • error (Error)

AuGR

Submit AuGR Job Multi

Submits multiple AuGR Jobs and waits for them to finish

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • augr_jobs (object|string) - AuGR Job IDs
  • augr_cluster (string) - URL of AuGR Cluster
  • augr_tenant (string) - AuGR tenant
  • secret (string) - ID of Aunsight Secret containing AuGR token
  • ttl (integer) - Maximum time (in seconds) to await completion of AuGR jobs before emitting an error
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)
  • output (object) - AuGR job output

Datamart

Load Datamart

Loads tables in datamart with given write_mode

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • datamart (Datamart|string) - Datamart to load
  • tables (Array[object]|string) - A list of tables to load, datasets to load, and loading options
  • options (object|string) - Load options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)
  • job (TrackerJob) - Datamart Job

Memento

Create Memento

Creates a memento in an existing series.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • series (MementoSeries|string) - Memento series object
  • value (string|number|boolean) - Memento value
  • note (string) - Record id
  • wait (any)

Outputs:

  • error (Error)
  • memento (Memento) - Memento

Get Memento Series

Get Memento series by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - Series id
  • wait (any)

Outputs:

  • error (Error)
  • series (MementoSeries) - Memento series

List Mementos

List mementos matching a query. The query input is a plain object using the <field>__<operator> format for the list-mementos API endpoint.

Note

Although limit allows the user to limit the maximum number of mementos returned, there is a platform-imposed limit of 2,000 mementos for any memento query.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • series (MementoSeries|string) - Memento series object
  • query (object|string) - Query
  • limit (integer) - Limit
  • wait (any)

Outputs:

  • error (Error)
  • mementos (Array) - Mementos from query

Organization

Get Organization

Get organization by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - Organization id
  • wait (any)

Outputs:

  • error (Error)
  • organization (Organization) - Aunsight organization

Get Project

Get project by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • organization (Organization) - Organization id
  • id (string) - Project id
  • wait (any)

Outputs:

  • error (Error)
  • project (Project) - Aunsight project

Send Mail to Group

Sends mail to all members of an organization group. Mail currently means “email” and as such it requires both text and html representations. Other components may be used to generate the mail content.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • group (string) - Group id
  • subject (string) - Mail subject
  • text (string) - Mail text content
  • html (string) - Mail html content
  • wait (any)

Outputs:

  • error (Error)

Send Mail to Member

Send Mail to Organization Member. Mail currently means “email” and as such it requires both text and html representations. Other components may be used to generate the mail content.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • organization (Organization|string) - Aunsight organization
  • member (string) - Member id
  • subject (string) - Mail subject
  • text (string) - Mail text content
  • html (string) - Mail html content
  • wait (any)

Outputs:

  • error (Error)

Send Mail to Role

Sends mail to all members of an organization role. Mail currently means “email” and as such it requires both text and html representations. Other components may be used to generate the mail content.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • organization (Organization|string) - Aunsight organization (DEPRECATED)
  • role (string) - Role id
  • subject (string) - Mail subject
  • text (string) - Mail text content
  • html (string) - Mail html content
  • wait (any)

Outputs:

  • error (Error)

Send SMS to Member

Sends an SMS message to an organization member. There is a maximum limit of 1600 characters. Exceeding this limit will cause an error. Aunsight may prepend a short prefix to the message which also contributes to the total.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • organization (Organization|string) - Aunsight organization
  • member (string) - Member id
  • message (string) - SMS message
  • wait (any)

Outputs:

  • error (Error)

Send SMS to Role

Sends an SMS message to all members of an organization role. There is a maximum limit of 1600 characters. Exceeding this limit will cause an error. Aunsight may prepend a short prefix to the message which also contributes to the total.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • organization (Organization|string) - Aunsight organization
  • role (string) - Role id
  • message (string) - SMS message
  • wait (any)

Outputs:

  • error (Error)

Peeper

Peeper Run Peeper

Run a peeper job

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (AtlasRecord|string) - Atlas record lib-aunsight model object
  • resource (Resource|string) - Resource id
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)
  • report (PeeperJob) - Peeper job lib-aunsight model object

Peeper View Report

View a Peeper Report

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • record (AtlasRecord|string) - Atlas record lib-aunsight model object
  • wait (any)

Outputs:

  • error (Error)
  • report (PeeperJob) - Last successful peeper job for record

Process

Get Process Version

Get process version by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • process (Process|string) - Process id
  • version (ProcessVersion|string) - Version id
  • wait (any)

Outputs:

  • error (Error)
  • version (ProcessVersion) - Process version

Run Process Version

Submits a process version to be run. Will wait for the process to finish before emitting output. If the job’s error field is present and ends in a failure state will emit the error from that field.

Inputs:

  • default_context (any) - Aunsight context
  • process (string) - Process
  • version (ProcessVersion|string) - Process version
  • resource (Resource|string) - Process resource
  • arguments (object|string) - Job Arguments
  • env (object|string) - Job Environment
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • token (string) - Authentication to communicate with Aunsight
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Process name
    • env (array) - Environment variables
    • memory (number) - Size in bytes of memory to allocate to the process. Cannot exceed resource max
    • cpu (number)
    • ttl (object) - Maximum lifetime for a job relative to some timestamp field
    • capabilities (object)
  • wait (any)

Outputs:

  • error (Error)
  • job (ProcessJob) - Process job

Run Process Version multiple times

Run a Process Version multiple times for given environment variable sets

Inputs:

  • default_context (any) - Aunsight context
  • version (ProcessVersion|string) - Process version
  • resource (Resource|string) - Process resource
  • envs (Array[object]|string) - List of env vars used per process version submission
  • process (string) - Process
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • token (string) - Authentication to communicate with Aunsight
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Process name
    • env (array) - Environment variables
    • memory (number) - Size in bytes of memory to allocate to the process. Cannot exceed resource max
    • cpu (number)
    • ttl (object) - Maximum lifetime for a job relative to some timestamp field
    • capabilities (object)
  • concurrency (integer) - Number of concurrent runs to perform. Max is 5.
  • wait (any)

Outputs:

  • error (Error)
  • jobs (Array) - List of Process job objects

Resource

Get Resource

Get resource by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - Resource id
  • organization (Organization|string) - Organization object or id
  • wait (any)

Outputs:

  • error (Error)
  • resource (Resource) - Aunsight resource

Rule

Evaluate Rule

Evaluates Rule (AuQL Script) and returns from true or false output depending on Rule output.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • rule (AuQLScript|string) - Aunsight rule
  • parameters (object|string) - parameters object
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Rule name
    • parameters (object) - Provide required rule parameters (if any) as KVPs
  • wait (any)

Outputs:

  • error (Error)
  • job (AuQLScriptJob) - Rule job

Get Rule

Get rule by id

Inputs:

  • id (string) - Rule id
  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • wait (any)

Outputs:

  • error (Error)
  • rule (AuQLScript) - Aunsight rule

Script

Evaluate Rule

Evaluates Rule (AuQL Script) and returns from true or false port depending on Rule output.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • rule (AuQLScript|string) - AuQL Rule
  • parameters (object|string) - parameters object
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Rule name
  • wait (any)

Outputs:

  • error (Error)
  • false (boolean) - Rule evaluates as False
  • job (AuQLScriptJob) - Rule job
  • true (boolean) - Rule evaluates as True

Evaluate Script

Evaluates AuQL Script and returns output.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • script (AuQLScript|string) - AuQL script
  • parameters (object|string) - parameters object
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Script name
    • path (string) - Extract this path from the output object if present
  • wait (any)

Outputs:

  • error (Error)
  • job (AuQLScriptJob) - Script job
  • output (any) - Stringified script output

Get Script

Get AuQL Script by id.

Inputs:

  • id (string) - Script id
  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • wait (any)

Outputs:

  • error (Error)
  • script (AuQLScript) - AuQL Script

Sightglass

Create Release

Creates a release. throw_on_failure - Whether to emit an error if the job ends in a failure state (KILLED, FAILED, SUSPENDED). Default is false to emit the job regardless of final state for subsequent handling.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • app (SightglassApp|string) - SightglassApp object
  • source (string) - Sightglass data source id
  • record (AtlasRecord|string) - Atlas record
  • resource (Resource|string) - Task resource
  • token (string) - Token for the task to use (DEPRECATED)
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)
  • release (SightglassAppSourceRelease) - Sightglass data source release

Get Sightglass app

Get Sightglass app by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - app id
  • wait (any)

Outputs:

  • app (SightglassApp) - Sightglass app
  • error (Error)

Publish App

Publish an app

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • app (SightglassApp|string) - SightglassApp object
  • wait (any)

Outputs:

  • app (SightglassApp) - Sightglass app
  • error (Error)

Send Insight

Send an Insight

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • app (SightglassApp|string) - SightglassApp object
  • type (string) - Insight type
  • title (string) - Insight title
  • detail (string) - Insight detail
  • extended_detail (string) - Insight extended detail
  • actions (string) - Insight actions (in stringified JSON)
  • users (Array) - Array of app user ids
  • groups (Array) - Array of app user group ids
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
  • wait (any)

Outputs:

  • error (Error)

Set Current Release

Set the current source release

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • app (SightglassApp|string) - SightglassApp object
  • source (string) - Sightglass data source id
  • release (SightglassAppSourceRelease|string) - Sightglass data source release
  • wait (any)

Outputs:

  • app (SightglassAppSourceRelease) - Sightglass app
  • error (Error)

Tokamak

Create Dynamic Outputs

Create new Atlas records for any dynamic outputs.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • dataflow (TokamakDataflow|string) - Tokamak dataflow
  • resource (Resource|string) - Storage resource
  • wait (any)

Outputs:

  • dataflow (TokamakDataflow) - Tokamak dataflow
  • error (Error)
  • records (Array) - List of new Atlas records

Get Dataflow

Get Tokamak dataflow by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - Dataflow id
  • wait (any)

Outputs:

  • dataflow (TokamakDataflow) - Tokamak dataflow
  • error (Error)

Get Dataflow Job

Get Tokamak job by id

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • id (string) - Tokamak job id
  • wait (any)

Outputs:

  • error (Error)
  • job (TokamakJob) - Tokamak Job

Get Dataflow Job Output By Name

Gets the Atlas record for an output of the job by name. Emits error if not found in the job or in Aunsight.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • name (string) - Atlas record name
  • job (TokamakJob|string) - Tokamak job
  • wait (any)

Outputs:

  • error (Error)
  • record (AtlasRecord) - Atlas record

Run Dataflow

Submits a Tokamak dataflow to run on the specified resource. Waits for the job to finish before emitting output.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • dataflow (TokamakDataflow|string) - Tokamak dataflow
  • resource (Resource|string) - Aunsight resource
  • parameters (object|string) - To overwrite the dataflow defaults on submission
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Dataflow job name
    • overwrite (boolean) - To overwrite existing output records
      • default: true
    • cleanup (boolean) - To clean up the job artifacts
      • default: true
    • parameters (array) - To overwrite the dataflow defaults on submission in key-value pairs
    • execution_options (object)
    • cachedmode (boolean) - To return previous results if possible
  • wait (any)

Outputs:

  • error (Error)
  • job (TokamakJob) - Tokamak job

Run Dataflow multiple times

Run a Tokamak dataflow on a specified resource for multiple parameter sets. Same options as for Tokamak_RunDataflow. The parameters input is a list of plain objects which are each a set of valid dataflow parameters. The provided dataflow will be submitted once for each parameter set. If there is an error during submission, or if the throw_on_failure option is set and there is an error during execution, the first error encountered will be emitted from the error port. The error will not be emitted until all the jobs have succeeded or failed. If throw_on_failure is not set and a job fails, an error will not be thrown, but the individual jobs can be inspected subsequently to find any errors.

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • dataflow (TokamakDataflow|string) - Tokamak dataflow
  • resource (Resource|string) - Aunsight resource
  • parameters (Array|string) - List of input parameters
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Dataflow job name
    • overwrite (boolean) - To overwrite existing output records
    • cleanup (boolean) - To clean up the job artifacts
      • default: true
    • execution_options (object)
    • cachedmode (boolean) - To return previous results if possible
    • concurrency (integer) - Number of dataflows to run simultaneously. Max is 5.
  • wait (any)

Outputs:

  • error (Error)
  • jobs (Array) - List of Tokamak job objects

Utility

Array First Item

Get first item from an array or throw error if empty.

Inputs:

  • array (Array) - Input array

Outputs:

  • error (Error)
  • item (any) - First item

Array Ordered Concat

Concatenate up to 5 arrays in order

Inputs:

  • data1 (Array)
  • data2 (Array)
  • data3 (Array)
  • data4 (Array)
  • data5 (Array)

Outputs:

  • data (Array)
  • error (Error)

Array Ordered Create

Create an array of 2-5 inputs in order

Inputs:

  • data1 (any) - First required input
  • data2 (any) - Second required input
  • data3 (any) - Third input
  • data4 (any) - Fourth input
  • data5 (any) - Fifth input

Outputs:

  • data (Array) - Resulting array
  • error (Error)

Array Unordered Concat

Concatenate multiple arrays in the order they are received

Inputs:

  • data (Array)

Outputs:

  • done (Array)
  • error (Error)

Build Aunsight Context

Build Aunsight context for use in other processes

Inputs:

  • rest_host (string) - Aunsight API REST address
  • socketio_host (string) - Aunsight API SocketIO address
  • token (string) - User token
  • facts (object) - Information about the workflow

Outputs:

  • context (object) - Aunsight context
  • error (Error)

Console Log

Log input to the console

Inputs:

  • in (any)

Outputs:

Delay

Delay for an amount of time after receiving input data

Inputs:

  • delay (integer)
  • in (any)

Outputs:

  • out (any)

Hash SHA-1

Compute SHA-1 hash of input string

Inputs:

  • input (string) - String to hash

Outputs:

  • error (Error)
  • hash (string) - Resulting hash

Is Equal

Check the equality of two things

Inputs:

  • value (any) - First thing to compare
  • other (any) - Second thing to compare
  • paths (Array|string) - Path(s) on both things to compare

Outputs:

  • error (Error)
  • no (boolean)
  • yes (boolean)

Call Object Method

Calls the specified method of an object. Emits error if the method is not found, is not a function or produces an error.

Inputs:

  • object (object) - Object to call on
  • method (string) - Method name to call
  • arguments (Array|string) - Array of arguments to apply
  • options (object|string)
    • handling (object) - Configure how this component will respond to failures

Outputs:

  • error (Error)
  • result (any) - Method return value

Get Object Path

Gets a value at a path in an object. Paths can use dot notation (a.b) to get nested values. If the path does not exist, the default is emitted or an error is emitted if a default is not specified.

Inputs:

  • object (object) - Object to get from
  • path (string) - Path to get
  • default (any) - Default if path nonexistent

Outputs:

  • error (Error)
  • value (any) - Path value or default

Extend Object Ordered

Extend an object with given objects in order

Inputs:

  • object_1 (object) - Object to extend
  • object_2 (object) - Object
  • object_3 (object) - Object
  • object_4 (object) - Object
  • object_5 (object) - Object

Outputs:

  • error (Error)
  • object (object) - Resulting object

Merge Object Ordered

Merge an object with given objects in order

Inputs:

  • object_1 (object) - Object to merge into
  • object_2 (object) - Object
  • object_3 (object) - Object
  • object_4 (object) - Object
  • object_5 (object) - Object

Outputs:

  • error (Error)
  • object (object) - Resulting object

Pick Object Paths

Returns an object composed of values at the specified paths. Paths can use dot notation (a.b) to get nested values. If all is true, will emit error if any paths do not exist.

Inputs:

  • object (object) - Object to pick from
  • paths (Array|string) - Array of paths to pick
  • all (boolean) - Whether all must exist

Outputs:

  • error (Error)
  • value (object) - Resulting object

Set Object Path

Set a value at a path in an object

Inputs:

  • object (object|string) - Object to set on
  • path (string) - Path to set
  • value (any) - Value to set

Outputs:

  • error (Error)
  • object (object) - Resulting object

Extend Object Unordered

Extend an object with given objects in the order received

Inputs:

  • objects (Array)

Outputs:

  • done (object)
  • error (Error)

Object Unordered Merge

Merge multiple objects in the order they are received

Inputs:

  • objects (Array)

Outputs:

  • error (Error)
  • object (object)

Objects Array To Key Groups Distinct

Transform array of objects to object of arrays with distinct values

Inputs:

  • array (Array) - Array of objects

Outputs:

  • error (Error)
  • object (object) - Object of arrays

Parse JSON

Parse a JSON string into a plain object

Inputs:

  • json (string|object) - JSON string to parse

Outputs:

  • error (Error)
  • object (object) - Resulting object

Pick Objects Array

Pick object fields by key(s) from objects in array

Inputs:

  • array (Array) - Array of objects to pick from
  • paths (Array|string) - Array of paths to pick
  • all (boolean) - Whether all must exist

Outputs:

  • array (Array) - Filtered array of objects composed of only paths
  • error (Error)

Render Error Mail

Render an error into a mail message

Inputs:

  • error (Error) - Error to render

Outputs:

  • html (string) - Mail html content
  • text (string) - Mail text content

Rethrow Error

Rethrow an error

Inputs:

  • error (Error) - The error to rethrow

Outputs:

  • error (Error)

Some

Wait for at least one input to be delivered

Inputs:

  • dependencies (any) - Dependencies to be awaited

Outputs:

  • done (boolean)

Stringify JSON

Stringify a plain object into a JSON string

Inputs:

  • object (object|string) - Plain object to stringify

Outputs:

  • error (Error)
  • json (string) - Resulting string

Throw Error

Throw a custom error

Inputs:

  • name (string) - Error name
  • message (string) - Error message
  • wait (any)

Outputs:

  • error (Error)

Wait

Wait for all inputs to be delivered

Inputs:

  • dependencies (any) - Dependencies to be awaited

Outputs:

  • done (boolean)

Workflow Parameters

Merges submission parameters with defaults. There can only be 0 or 1 processes of this type in a workflow. If not present and parameters are provided on submission, they will be ignored.

Inputs:

  • defaults (object|string) - JSON default parameters to use
  • parameters (object|string) - Submission parameters

Outputs:

  • error (Error)
  • parameters (object) - Merged parameters & defaults

Workflow

Get Workflow

Get workflow by id

Inputs:

  • id (string) - Workflow id
  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • wait (any)

Outputs:

  • error (Error)
  • workflow (Workflow) - Aunsight workflow

Run Workflow

Run workflow

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • workflow (Workflow|string) - Aunsight workflow
  • parameters (object|string) - To overwrite the workflow defaults on submission
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • token (string) - Token is used for execution
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Workflow name
    • parameters (array) - To overwrite the workflow defaults on submission in key-value pairs
  • wait (any)

Outputs:

  • error (Error)
  • job (WorkflowJob) - Workflow job

Run Workflow Multi

Run a workflow multiple times

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • workflow (Workflow|string) - Aunsight workflow to run multiple times
  • parameters (Array|string) - List of input parameters
  • options (object|string) - Submission options
    • handling (object) - Configure how this component will respond to failures
    • token (string) - Token is used for execution
    • throw_on_failure (string) - Whether or not to emit an error if a job fails
      • values: true, false
      • default: true
    • name (string) - Workflow name
    • concurrency (integer) - Number of workflows to run simultaneously. Max is 5.
  • wait (any)

Outputs:

  • error (Error)
  • jobs (Array) - Aunsight Workflow jobs

Update Workflow Status

Update current workflow status

Inputs:

  • default_context (any) - Aunsight context
  • context (object) - Aunsight context
  • status (string) - Status string
  • structured_status (object|string|Array) - Structured Status
  • wait (any)

Outputs:

  • error (Error)