Create Object Variables for storm FLOW

A FLOW object variable stores multiple data values of various types in a structure. Object variables are used to handle data in FLOW workflows, and allow complex data (rather than flat JSON data) to be sent and received. See the FLOW User Guide for more information on FLOW object variables, their structures, and where and how they are used.

The underlying structure of a FLOW object variable is defined in a file outside of storm to the OpenAPI Specification (v.3.0.0 or above) and then imported into storm via STUDIO.

The following is an example of a FLOW object variable definition. (The example provided is in YAML file format, but JSON format is also supported.)

openapi: 3.0.0
asasasas
#################################################
# API Info #
#################################################
info:
title: 'CustomerDetails'
version: '1.8.3'
description: |
## Demonstration - customer information
***

Return a list of customers and their details
---

contact:
name: 'API Developer Portal'

components:

securitySchemes:

ApiKeyAuth:
type: apiKey
name: 'x-api-key'
in: header

###########################################
# Demonstration Parameters #
###########################################
parameters:

x-session-id:
name: "x-session-id"
in: header
description: 'Optional Client Session Id.'
required: false
schema:

type: string
example: "123456789ABC"
style: simple

schemas:

Customer:
type: object
properties:
firstname:
type: string
example: "Peter"
surname:
type: string
example: "Davis"
accountno:
type: string
example: "N879888800"
telephoneno:
type: string
example: "07111111111"
required:
- firstname
- surname
- accountno
- telephoneno

responses:

CustomerDetailsResponse:
description: customer details
content:
application/json:
schema:
$ref: '#/components/schemas/Customer'

security:

- ApiKeyAuth: []

paths:

'/v3/f59c8cf7-d823-42dd-8f68-e945b291514d':

##################################
# Get user information
##################################

get:
tags:
- Customer Information

summary: Return a customer

description: |
Returns customer information

operationId: getCustomerInformation

parameters:
- $ref: '#/components/parameters/x-session-id'

responses:
200:
$ref: '#/components/responses/CustomerDetailsResponse'

The ‘title’ section of the file provides the heading under which the FLOW object variable is listed after it has been imported into storm. The object definitions are derived from the ‘components’ section of the file.

1. From the STUDIO main screen, select Service Configuration > FLOW Objects.

‎

2. The system lists all the FLOW object variables that have been set up on your system already.‎

3. Click the Choose file button, then navigate to the file to be imported and select it.
4. Provided that the file is in an acceptable format, it is imported immediately and placed at the top of the list of FLOW objects.‎

5. Clicking on the object variable name ('CustomerDetails' in the following illustration) reveals the schema name, while clicking on the schema name ('Customer' in the following illustration) reveals the data items in the structure.

‎

Note: once you have created a FLOW object variable, you cannot delete or amend it.