Contents

What's New
Installation
Installing the Extension
Product Overview
User Guide
App Development
Creating and Managing a Flogo App
Creating a Flogo App
Validating Your App Flow
Editing an App
Renaming an App
Editing the Version of an App
Using Notes
Deleting an App
Creating Flows and Triggers
Flows
Creating a Flow
Starting with a Trigger
Creating a Flow Attached to a REST (Receive HTTP Message) Trigger
Creating a Flow Attached to Other Triggers
Creating a Blank Flow (Flow without a Trigger)
Flow Input & Output Tab
Attaching a Flow to One or More Triggers
Catching Errors
Creating An Error Handler Flow
Viewing Errors and Warnings
Using Subflows
Creating Subflows
Creating a Flow Execution Branch
Types of Branch Conditions
Order in which Branches Get Executed
Setting Branch Conditions
Deleting a Branch
Editing a Flow
Deleting a Flow
Adding an Activity
Searching for a Category or Activity
Configuring an Activity
Duplicating an Activity
Using the Loop Feature in an Activity
Accumulating the Activity Output for All Iterations
Accessing the Activity Outputs in Repeat While True Loop
Using the Retry On Error Feature in an Activity
Deleting an Activity
Triggers
Deleting a Trigger
Playing a Test Case Once
Synchronizing a Schema Between Trigger and Flow
Data Mappings
Data Mappings Interface
Mapping Data from the Data Mappings Interface
Scopes in Data Mappings
Data Types
Reserved Keywords to be Avoided in Schemas
Mapping Different Types of Data
Mapping an ENUM value
Mapping a Single Element of Primitive Data Type
Mapping an Object
Mapping Arrays
Mapping an Array of Primitive Data Types
Mapping Complex Arrays
Mapping of unmapped arrays
Add Items to Array
Mapping Identical Arrays of Objects
Mapping Array Child Elements to Non-Array Elements or to an Element in a Non-Matching Array
Mapping Nested Arrays
Mapping Child Elements within a Nested Array Scope
Mapping a Nested Array Child Element outside the Nested Array Scope
Mapping an Element from a Parent Array to a Child Element in a Nested Array within the Parent
Filtering Array Elements to Map Based on a Condition
Mapping JSON Data with the json.path() Function
Constructing the any, param, or object Data Type in Mapper
Coercing of Activity Input, Output, and Trigger Reply Fields
Clear Mapping of Child Elements in Objects and Arrays
Ignoring Missing Object Properties when Mapping Objects
Mapping Data by Using if/else Conditions
Using Functions
Using Expressions
Combining Schemas Using Keywords
Supported Operators
General Category Triggers, Activities, and Connections
Triggers
Timer Trigger
REST Trigger - ReceiveHTTPMessage
GraphQL Trigger
gRPC Trigger
Receive Lambda Invocation
App Startup Trigger
App Shutdown Trigger
Activities
ConfigureHTTPResponse
Run JavaScript
gRPC Invoke
InvokeLambdaFunction
InvokeRESTService
Using SSL
LogMessage
Mapper
ParseJSON
ReplyToTrigger
ProtobufToJSON
No-Op
SendMail
SharedData
Sleep
Throw Error
JSON to XML
XML to JSON
Connections
HTTP Client Authorization Configuration
File Category Trigger and Activities
File Poller Trigger
Create File
Read File
List Files
Write File
Copy File
Rename File
Remove File
Archive Files
Unarchive Files
Developing APIs
Using an OpenAPI Specification
Configuring the REST Reply
Using GraphQL Schema
Using App Properties, Schemas, and Specs
App Properties
Creating App Properties
App Properties Tab
Creating a Standalone App Property
Creating a Group
Deleting a Group or Property
Using App Properties in a Flow
Using App Properties in the Mapper
Unlinking an App Property from a Field Value
Using App Properties in Connections
Editing an App Property
Changing the Default Value of a Property from the App Properties Tab
Changing the Default Value of a Property in the Environment Controls Tab
Changing the Name or Data Type of an App Property after Using It
Exporting App Properties to a File
Overriding an App Property Locally
App Schemas
Defining an App-Level Schema
Editing an App-Level Schema
Deleting an App-Level Schema
Using an App-Level Schema
Flow Input & Output Tab
Input or Output Settings Tab of an Activity
Output or Reply Settings Tab of a Trigger
App Specs
Importing App Specs
Using App Specs
Updating App Specs
Deleting App Specs
Using Connectors
Supported Flogo Connectors
Prerequisites for Connectors
Creating Connections
Editing Connections
Deleting Connections
Developing for Lambda
Creating a Connection with the AWS Connector
AWS Connection Details
Creating a Flow with Receive Lambda Invocation Trigger
Deploying a Flow as a Lambda Function on AWS
Receive Lambda Invocation
InvokeLambdaFunction
Using Extensions
Configuring Extensions
Deleting Extensions
Unit Testing
Creating and Running a Test Case
Creating a Test Case for an Existing App
Creating a Test Case Along with a New App
Defining Flow Input
Creating Assertions
Creating Assertions for Flow Output
Creating Assertions for the Error Handler
Skipping an Activity with No Output
Validating a Test Case
Running a Test Case
Hiding Test Cases
Using Mock Data
Running a Test Case Using a Runtime Environment
Creating and Running a Test Suite
Creating a Test Suite
Running a Test Suite
Unit Testing for the CI/CD
App Configuration Management
Consul
Using Consul
Consul Connection Parameters
Setting the Consul Connection Parameters
AWS Systems Manager Parameter Store
Using the Parameter Store
Parameter Store Connection Parameters
Setting the Parameter Store Connection Parameters
Overriding an App Property at Runtime
Running Apps Locally
Configuring the Runtime
Environment Variables
Building and Running your App Locally
Building the App Locally
Running the App Locally
Exporting App JSON from an Executable
Editing a Runtime
Deleting a Runtime
Generating an Application Docker Image Locally
Deployment and Configuration
Deploying Flogo Apps from Visual Studio Code
View Flogo App List in Runtime Explorer
Developing for Lambda
Creating a Connection with the AWS Connector
AWS Connection Details
Creating a Flow with Receive Lambda Invocation Trigger
Deploying a Flow as a Lambda Function on AWS
Receive Lambda Invocation
InvokeLambdaFunction
Mapper Functions Guide
Overview of Mapper Functions
Using Functions
Array Functions
array.append
array.contains
array.count
array.create
array.delete
array.flatten
array.forEach
array.get
array.merge
array.reverse
array.slice
array.sum
Boolean Functions
boolean.false
boolean.not
boolean.true
Coerce Functions
coerce.toArray
coerce.toBool
coerce.toBytes
Coerce.toFloat32
Coerce.toFloat64
coerce.toInt
Coerce.toInt32
Coerce.toInt64
coerce.toObject
coerce.toParams
coerce.toString
coerce.toType
Compression Functions
compression.gzipCompress
compression.gzipUncompress
Data Functions
data.GetValue
data.isDefined
Datetime Functions
datetime.add
datetime.addHours
datetime.addMins
datetime.addSeconds
datetime.create
datetime.current
datetime.currentDate
datetime.currentDatetime
datetime.currentTime
datetime.diff
datetime.format
datetime.formatDate
datetime.formatDatetime
datetime.formatTime
datetime.now
datetime.parse
Datetime.sub
datetime.subHours
datetime.subMins
Datetime.subSeconds
Float Functions
float.float64
JSON Functions
json.exists
json.get
json.length
json.numbersToString
json.objKeys
json.objValues
json.path
json.jq
json.set
Math Functions
math.ceil
math.floor
math.isNaN
math.mod
math.round
math.roundToEven
math.trunc
Number Functions
number.int64
number.len
number.random
String Functions
String.base64ToString
string.concat
string.contains
string.containsAny
string.count
string.dateFormat
string.lastIndex
string.datetimeFormat
string.endsWith
string.equals
string.equalsIgnoreCase
string.float
string.index
string.indexAny
string.integer
string.join
string.len
string.length
string.lowerCase
string.matchRegEx
string.regex
string.repeat
string.replace
string.replaceAll
string.replaceRegEx
string.split
string.startsWith
String.stringToBase64
string.substring
string.substringAfter
string.substringBefore
string.timeFormat
string.toLower
string.toTitleCase
string.toUpper
string.tostring
string.trim
string.trimLeft
string.trimPrefix
string.trimRight
string.trimSuffix
string.upperCase
URL Functions
url.encode
url.escapedPath
url.hostname
url.path
url.pathEscape
url.port
url.query
url.queryEscape
url.scheme
Utility Functions
utility.renderJSON
Utils Functions
Utils.decodeBase64
Utils.encodeBase64
utils.uuid
TIBCO Documentation and Support Services
Legal and Third-Party Notices