45
TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide Software Release 2.6.1 July 2019

(PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

  • Upload
    others

  • View
    3

  • Download
    0

Embed Size (px)

Citation preview

Page 1: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

TIBCO Cloud™ Integration- Flogo®(PAYG)Activities and Triggers GuideSoftware Release 2.6.1July 2019

Page 2: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, Two-Second Advantage, TIB, Information Bus, and Flogoare either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or othercountries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. Please see the readme.txt file forthe availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 2016-2019. TIBCO Software Inc. All Rights Reserved.

2

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 3: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Out-of-the-box Activities and Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

General Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Timer Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

REST Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

GraphQL Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

LogMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

SendMail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

InvokeRESTService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

ReplyToHTTPMessage (Supported for backward compatibility only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

InvokeLambdaFunction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Apache Avro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Avro Serialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Avro Deserialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Apache Kafka . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Configuring a Kafka Client Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Kafka Client Configuration Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Kafka Consumer Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Kafka Producer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Kafka Offset Commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Creating a Microsoft SQL Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Microsoft SQL Server Connection Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

SQLServer Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

SQLServer Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

SQLServer Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

MQTT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Creating an MQTT Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

MQTT Connection Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

3

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 4: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

MQTT Subscriber Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

MQTT Publish Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

PostgreSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Creating a PostgreSQL Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

PostgreSQL Connection Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

PostgreSQL Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

PostgreSQL Insert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

PostgreSQL Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

TIBCO Cloud Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Creating a TIBCO Cloud Messaging Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

TIBCO Cloud Messaging Connection Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

MessageSubscriber Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

TCMMessagePublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

List of Supported Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

4

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 5: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Documentation for TIBCO Flogo® Enterprise is available on the TIBCO Flogo® Enterprise ProductDocumentation page.

Product-Specific Documentation

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO Flogo® Enterprise Installation

● TIBCO Flogo® Enterprise User's Guide

● TIBCO Flogo® Enterprise Release Notes

● TIBCO Flogo® Activities and Triggers Guide

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

5

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 6: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Out-of-the-box Activities and Triggers

This section documents the out-of-the-box activities and triggers that are suppoted in TIBCO Cloud™Integration- Flogo® (PAYG).

General CategoryThe General category is available by default in all flows. It consists of activities and triggers that maybe commonly used by any flow in the app. A trigger activates the flow in which it appears. An activityis used to perform a task.

This section contains the following topics:

TriggersIn addition to the Receive HTTP Message and Timer Trigger available for general use, TIBCO CloudIntegration- Flogo (PAYG) supports triggers that were originally created in Project Flogo™. This allowsfor a seamless import of apps that were created in Project Flogo™. The Project Flogo™ triggers aremarked with the OSS abbreviation on them.

If you are creating an app in TIBCO Cloud Integration- Flogo (PAYG), it is preferable to use the generalpurpose triggers (the triggers that do not have an OSS tag on them), since they are more robust infunctionality.

Refer to https://github.com/TIBCOSoftware/flogo-contrib for details on the activities that are markedwith an OSS tag.

You cannot create a flow branch from a trigger.

You can create the trigger at the time of flow creation or create a blank flow to begin with and add oneor more triggers to it at a later time after the flow has been created. If you anticipate that you will needmultiple triggers for a flow, be sure to create a blank flow and add the triggers as needed. If you attacha trigger to a flow during flow creation, you will not be able to modify it or add triggers to the flowonce such a flow has been created.

For triggers that have an output, the output from the trigger becomes the input to the flow. Likewise,the output from the flow becomes the reply from the trigger.

This section contains the following topics:

Timer Trigger

Use the Timer Trigger trigger as a process starter when creating flows designed to be activated withoutexternal input. It is useful when you want your flows to run at certain time intervals. You can configurethe Timer Trigger trigger to activate the flow multiple times at a specified interval.

Field Description

Repeating True: Select the True radio button to run the flow at periodic intervals.

False: Select the False radio button if you want the flow to run only once.

If Repeating is set to True and a Time Interval and Interval Unit is specified, theflow will be triggered at the exact same time as the first run. For example, if theflow was run at 1:00 pm on Monday and the Interval Unit is specified as weekwith the Time Interval as 2, the flow be run at 1:00 pm on every other Monday.

6

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 7: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Time Interval An integer indicating the number of units specified in the Interval Unit field. Forexample, if you enter 1 as the Time Interval and select Hour in the Interval Unitdrop down menu, the Timer trigger activates the flow every hour. If you enter 2as the time interval and specify Week as the Interval Unit, the flow is run everyother week.

Interval Unit The unit of time to use with the Time Interval field to determine how often torun the flow. The units can be: Second, Minute, Hour, Day, and Week.

REST Trigger

Use the REST trigger, ReceiveHTTPMessage, when creating flows that require invoking RESTful webservices that provide some input necessary to activate the flow. The ReceiveHTTPMessage trigger isused when you want to expose your flow as an API, making it accessible by other apps running oneither the TIBCO Cloud™ or elsewhere. This trigger must be configured to set up the fields for a requestthat the server receives from a REST client.

Settings

Field Description

Port By default, the port on which the trigger listens is set to 9999. You can change thisto use another port to that is open.

SecureConnection

By default, it is set to False. If you set this field to True, you can create a secureendpoint by providing Server Key and CA or Server Certificate.

Server Key - A PEM encoded private key file

CA or Server Certificate - A PEM encoded CA or self-signed server certificate file

Method The REST operation which the flow implements, for example GET, PUT, POST, orDELETE. This is a non-editable field since each REST flow implements a singleoperation.

7

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 8: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Path The resource path for the operation. By default, the path displayed here is theresource path you had entered when you created the flow. The Path field iseditable. For example, if you want to add a path parameter for a GET operation,you can do so by editing the resource path in the GET flow. If you edit the path inthe Path field for a particular REST operation flow, the edited resource path willbe applicable only to the flow in which it was edited.

Two resource paths with same base path should not contain path parameters atthe same location. For example, you cannot have the following paths in the sameapplication:

● /books/{ISBN}/Author/{releaseDate} and /books/{ISBN}/Author/releaseDate is considered the same from a routing perspective.

In these two paths, since the ISBN value is dynamic, it will cause a conflictduring path resolution.

● /books/{ISBN}/{releaseDate} and /books/{ISBN}/Author in the sameapplication is not supported.

Although the two paths appear to be different, when a message comes in, therouter mechanism cannot know which path to call (the one with parameter orthe one without) since the actual value has been substituted for the paramter.

● Resource path with two different path parameters at the same URL sub-section. For example, /0.6/api/account/{account}/orderhistory/{orderhistory}/branch/{branch} and /0.6/api/account/{AccountKey}/Price?ProductList={ProductList}

In these paths even though the paths differ after the base path (/0.6/api/account/), there will be a conflict when resolving the {account} and{AccountKey} values.

● Multiple REST resources with same base path and same number of pathparameters. For example, /resource/{id} and /resource/{id1}

● /messages/{messageid}/comments/{commentid} and /messages/{messageid}/likes/{likeid}

where the paths differ after {messageid}.

OutputValidation

When set to True, the incoming data (body, headers, and query parameters) isvalidated against the configured JSON schema. By default, it is set to False.

8

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 9: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Output Settings

Field Description

QueryParameters

Query parameters to be appended to the path. To add the query parameters, click

the ( ) button and press Enter to save your changes.

parameterName: Name of the query parameter

type: The data type of the query parameter. Supported types are string, number,or boolean.

repeating: Set to True if more than one value is expected for the query parameter.

required: Set to True if query parameter is a required configuration. The triggerwill report an error if no value(s) are provided to the required query parameter.

Path Parameters Path parameters that are appended to the path.

HeadersHeader values for the trigger. To add the header parameters, click the buttonand press Enter to save your changes.

parameterName: Name of the header parameter.

type: The data type of the header parameter. Supported types are string, number,or boolean.

repeating: Set to True if more than one value is expected for the HTTP header.

required: Set to True if header parameter is a required configuration. The triggerwill report an error if no value(s) are provided to the required header parameter.

Request Schema Request schema for the trigger. Be sure to use straight quotes for element namesand values in the schema.

Map to Flow Inputs

The Output tab displays the query, header, and path parameters and the body configured for theoperation in a tree format.

Reply Settings

Field Description

Reply DataSchema

The schema used for the reply data of the trigger. Be sure to use straight quotesfor element names and values in the schema.

Map from Flow Outputs

Field Description

code HTTP code

9

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 10: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

data Body of the reply

message Use this field to enter the details for a response code, particularly for giving errordetails

GraphQL Trigger

The GraphQL Trigger lets the Flogo app act as the GraphQL server. To use this trigger, you simplyupload your GraphQL schema and TIBCO Cloud Integration- Flogo (PAYG) automatically creates theflows corresponding to each query or mutation field in your schema.

Settings

Field Description

Port The port on which the trigger listens to requests. By default, it is set to 7879. Youcan change this to use any other port that is open. This field can also be set usingan application property.

Path The HTTP resource path for the operation. By default, it is set to /graphql, butyou can change it to any string that is meaningful to you. It is the single endpointthat GraphQL queries and mutations use to access data from the multipleresources on the server. This field can also be set using an application property.

SecureConnection

By default, it is set to False. If you set this field to True, you can create a secureendpoint by providing Server Key and CA or Server Certificate.

Server Key - A PEM encoded private key file

CA or Server Certificate - A PEM encoded CA or self-signed server certificate file

GraphQLOperation

The type of Graphql operation the flow should represent. You can select eitherQuery or Mutation

Resolver for This field is populated based on the type of GraphQL Operation that youselected. If you selected Query, the Resolver For lists the field names under thequery type in the schema. If you select Mutation, the drop down menu lists thefield names under the mutation type in the schema.

Map to Flow Inputs

The Map to Flow Inputs tab contains an element, arguments, which contains a list of fields or objectsthat match the input arguments of the Resolver For field in the GraphQL schema.

Map from Flow Outputs

The Map from Flow Outputs tab contains a child element, data, which contains either a simple type oran object that match the output type of the Resolver For field in the GraphQL schema. If the outputtype of the field is an interface type, the data will contain a single field of type any.

ActivitiesIn addition to the activities available for general use, TIBCO Cloud Integration- Flogo (PAYG) supportsactivities that were originally created in Project Flogo™. Such activities are marked with an OSS tag on

10

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 11: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

them. This allows for a seamless import of apps that were created in Project Flogo™. The ProjectFlogo™ activities are placed under the Default category.

If you are creating an app in TIBCO Cloud Integration- Flogo (PAYG), it is preferable to use the generalpurpose activities (the activities that do not have an OSS tag on them), since they are more robust infunctionality.

Refer to https://github.com/TIBCOSoftware/flogo-contrib for details on the activities that are markedwith an OSS tag.

The available activities are placed under the following categories:

● Default

● General

You can create a flow branch from any activity except the Return activity.

To create a branch from an activity. Refer to the TIBCO Flogo® Enterprise User's Guide for steps to createa branch.

Refer to the TIBCO Flogo® Enterprise User's Guide for steps to delete an activity.

This section contains the following topics:

LogMessage

LogMessage is an activity that writes a message to the log. For each application, there is a log file. Youcan view the logs in the Log tab.

You can view the logs in the Log tab.

Settings

The Settings tab has the following fields.

Field Description

Log Level Select one of the following log levels:

● Info: logs informational messages highlighting the application progress.

● Warning: is the warning message of an unexpected error when runningthe flow.

● Error: logs error conditions and messages.

● Debug: can be used for debug-level messages.

Add Flow Details Appends Flow Instance ID, Flow Name and Activity Name to the logmessage.

By default, this field is set to False.

Input

Provide the following input for this activity.

Input Iten Description

message The message to be displayed in the log.

11

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 12: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

SendMail

SendMail is an activity that sends an email by way of an SMTP server.

To securely configure the SendMail activity using the smtp.gmail.com server, use TLS on Port 587 orSSL on port 465.

Settings

The Settings tab has the following fields.

Field Description

Server The host name or IP address for the mail server.

Port The port used to connect to the server.

ConnectionSecurity

The type of connection to be used to communicate with the mail server. SelectTLS or SSL depending upon the security configuration of the mail server. In caseno security is enabled on the mail server, select NONE.

Username The username to use when authenticating to the mail server.

Password The password to use when authenticating to the mail server.

Input

This tab displays the fields that are used as input for the activity.

Input Item Description

sender The email address of the sender.

recipients The recipient list for the email. You can send mail to more than one recipient.

Provide a list of recipients in a single string by using a comma as thedelimiter.

subject The subject of the email.

message The text of the email message.

InvokeRESTService

This activity is both an outbound and inbound REST request which means that it is used to make arequest to the REST service and also accept the reply returned by the service.

Settings

Field Description

Method Select an operation for the request, such as GET, POST, PUT, or DELETE.

12

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 13: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Uri An absolute path to the REST service that you want to invoke, for example, http://acme.com or https://acme.com. If you enter an absolute path beginning withhttps:// the Use certificate for verification section appears. Select:

If your connection requires an SSL certificate select True, otherwise select False.To add a certificate click Browse under Server Certificate and browse to thecertificate location on your machine.

Request Type The Request content type of the REST service. This field is applicable and visibleonly in the POST and PUT activities. The following content-type are supported:

● text/plain

● application/json

● application/x-www-form-urlencoded

Response Type The Response content type of the REST service. The following content-types aresupported:

● text/plain

● application/json

● other

Input Settings

Field Description

Request Schema Enter a request schema here. This field is visible only if you selected the POST orPUT method in the Settings tab.

Query Params Query parameters to be appended to the path. To add the query parameters, click

the button and press Enter to save your changes.

parameterName: Name of the query parameter.

type: The data type of the query parameter. Supported types are string, number,or boolean.

required: Set to True if query parameter is a required configuration. The triggerwill report an error if no value(s) are provided to the required query parameter.

13

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 14: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

RequestHeaders

Header values for the InvokeRESTService activity. To add the header parameters,

click the button and press Enter to save your changes.

parameterName: Name of the header parameter.

type: The data type of the header parameter. Supported types are string, number,or boolean.

required: Set to True if header parameter is a required configuration. The triggerwill report an error if no value(s) are provided to the required header parameter.

Input

Field Description

queryParams Provide a value to the query parameters configured on the Input Settingssection. This field is visible only if you selected the POST or PUT method in theSettings tab.

pathParams Provide a value to path parameters defined as part of URL in the Settings tab.This field is visible only if you selected the POST or PUT method in the Settingstab.

headers Header values for the activity. These values can be manually entered or mappedto the output of the trigger or any preceding activity.

body Request Schema values for the activity. These values can be manually entered ormapped to the output of the trigger or any preceding activity. This field is visibleonly if you selected the POST or PUT method in the Settings tab.

Output Settings

Field Description

ResponseSchema

The schema for the reply that the server sends.

ResponseHeaders

The header parameters for the reply.

Output

The Output tab displays the headers and response body configured for both the request and theresponse in a tree format.

14

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 15: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Using SSL

If you choose to set up SSL authentication for the InvokeRESTService activity, you must have a self-signed server certificate that you must upload when setting up the activity.

Use Self-signed PEM certificate for secure connection.

To set up SSL authentication, follow these steps:

Prerequisites

You must have the self-signed server certificate handy on your machine.

Procedure

1. On the flow page, click the Invoke REST Service tile to open its properties.

2. In the Settings tab, under Use certificate for verification, select the True radio button.This exposes the Browse button. The SSL verification will be turned off when Use certificate forverification is set to False.

3. Use the Browse button to navigate to the location of the server certificate.Once the server certificate is uploaded successfully, the connection uses the certificate toauthenticate.

ReplyToHTTPMessage (Supported for backward compatibility only)

This activity is not supported in TIBCO Cloud Integration- Flogo (PAYG) 2.5.0 and above. This activityis applicable only to flows that were created in previous versions of TIBCO Cloud Integration- Flogo(PAYG) (prior to version 2.5.0) that are imported into the current version.

This activity automatically gets created when you create a flow with a REST trigger. It is used by theserver to reply to a request from the REST client.

Configuration

Field Description

Reply Reply sent by the server in response to the REST client request. The twosupported replies are Success with Data and Error with Message.

If you select Success with Data, the reply schema must be configured in theInput Settings tab in the Schema field. If you select Error with Message, youmust configure the error message in the message field of the Input tab.

Input Settings

Field Description

Schema Enter the reply schema or sample data using a JSON structure.

15

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 16: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Input

Field Description

message The string that is included in the reply. If you configured the Reply field in theConfiguration tab with Error with Message, the error message must be enteredin message text box. If you configured the Reply field with Success with Data,then you must map your data according to the schema specified in the InputSettings tab.

Mapper

Use this activity to define a schema to get the desired data. This activity is particularly useful to define aschema for an object of type any. In the flow, you place the Mapper activity preceding an activity whoseinput requires an object of data type any. This allows you to map the object of type any to the outputfrom the Mapper activity. An advantage of using this activity is that you can construct the data for theany data type within the flow instead of fetching it from outside.

Input Settings

Field Description

Input Schema Enter the JSON schema that will be used as the input for this activity. Theelements of this schema are available for mapping in the Input tab and aremappable to the output from any preceding activity, trigger, or the flow input.

The Mapper activity outputs the elements from this schema, so they are alsodisplayed in the Output tab in a tree format. This makes them available formapping in the following activities.

Input

The Input tab displays the schema you entered in the Input Settings tab in a tree format. You can mapthese elements to the output from any preceding activity, trigger, or the flow input.

Output

The Output tab displays the elements from the schema you entered in the Input Settings tab.

InvokeLambdaFunction

Use this activity to to invoke a specific Lambda function.

Settings

Field Description

AWSConnectionName

Select a AWS connection

ARN Amazon Resource Name

16

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 17: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Input Settings

Field Description

Payload Schema Enter a JSON request schema for your payload that will be used to invoke theLambda function.

Input

The payload schema that you entered in the Input Settings tab is displayed in a tree format in theInput tab. Map the elements in the schema using the mapper or alternatively, enter values for theelement by manually typing the value in the mapper.

Output Settings

Field Description

Result Schema The schema for the result that is expected from the Lambda function invokerequest

Output

The Output tab displays the result schema you entered in the Output Settings tab in a tree format.

Apache Avro

This section contains the following topics:

OverviewTIBCO Flogo® Connector for Apache Avro provides a mechanism to serialize and deserialize messages.It uses JSON-based schemas. For information on using Apache Avro refer to the Apache Avrodocumentation.

Avro SerializeUse this activity to serialize the message data into a base64 encoded string using the schema andmessage that you configure in the Input tab of this activity. Once the message is base64 encoded, it canbe transported over network.

Settings

The elements from the schema that you enter in this tab will be available for manually configuring ormapping in the Input tab.

Field Description

Schema The Apache Avro schema to be used to serialize a message. It contains thecomplex and/or primitive types that are supported by Apache Avro.

Input

The Input tab displays the elements of the schema that you entered in the Settings tab in a tree format.You can input the values for each element by hard coding the value or mapping the value to an element

17

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 18: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

from the output schema of a previous activity in the flow. See the section on "Using the Mapper" in theTIBCO Flogo® Enterprise User's Guide for details on how to map elements.

Output

This tab displays serialized data in the base64 encoded format.

Avro DeserializeUse this activity to deserialize serialized data into a JSON readable format using the schema that youconfigure in the Settings tab of this activity.

Settings

The elements from the schema that you enter in this tab will be available for manually configuring ormapping in the Input tab.

Field Description

Schema The Apache Avro schema to be used to deserialize a message. It contains thecomplex and/or primitive types that are supported by Apache Avro.

Input

Field Description

serializeddata Enter the serialized data or map it to serialized data from the output of aprevious activity. This data will be decoded into JSON format.

Output

The Output tab displays the elements of the schema that you entered in the Settings tab in a tree formatafter the serialized data from the Input tab has been deserialized.

Apache Kafka

This section contains the following topics:

OverviewApache Kafka is a distributed messaging system, providing fast, highly scalable, and redundantmessaging through a publisher-subscriber model. By using TIBCO Flogo® Connector for Apache Kafka,you can design the flows to send and receive the records.

For information about how to use Apache Kafka, see Kafka documentation.

Configuring a Kafka Client ConnectionTo use TIBCO Flogo® Connector for Apache Kafka, you must first configure a Apache Kafka clientconnection. The Apache Kafka client connection contains the parameters required to connect to the

18

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 19: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Apache Kafka cluster. The Apache Kafka client connection is used by all the activities in the ApacheKafka category.

Prerequisites

Before you create a client connection, familiarize yourself with Apache Kafka. For details about how touse the Apache Kafka product, see the Kafka Documentation.

Procedure

1. On the TIBCO Cloud™ Integration- Flogo® (PAYG) page, click the Connections tab and perform oneof the following actions:

● To add a client connection for the first time, click the Apache Kafka Client Configuration card.You can search for a connector card by typing the connector name in the search field.

● If you have existing connections and want to add a new connection, click the Add Connectionlink.

2. In the Apache Kafka Client Configuration dialog box, enter the connection details. For fielddescriptions, see the Kafka Connection Details topic.

3. Click Save.

Kafka Client Configuration Details

To establish the connection successfully, you must configure the Apache Kafka instance.

The Apache Kafka Client Configuration dialog box contains the following fields:

Condition Applicable Field Description

N/A Connection Name

The unique name for the connection you are creating.

This name is displayed in the Connection drop-down listfor all the TIBCO Flogo® Connector for Apache Kafkaactivities.

N/A Description

A short description of connection

N/A Brokers A comma-separated list of host and port pair (host:port)for establishing the initial connection with the Kafkacluster.

Applicable only whenSASL/PLAIN is selectedin the Auth Mode field.

AuthMode

Select one for following authentication type to establishthe connection with Kafka cluster:

● None: To establish the connection withoutauthentication

● SASL/PLAIN: To use Simple Authentication SecurityLayer (SASL) PLAIN authentication

● SSL: To use Secure Socket Layer (SSL) authentication

User Name The user name for authentication.

Password The password for authentication.

19

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 20: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Condition Applicable Field Description

Applicable only whenSASL/PLAIN or SSL isselected in the AuthMode field.

ClientCertificate

A Privacy Enhanced Mail (PEM) encoded client certificatefile for mutual authentication.

Client Key A PEM encoded private key file for mutualauthentication.

CA orServerCertificate

A PEM encoded private key file for server authentication.

Connection Timeout

The amount of time in seconds to wait for the initialconnection.

Default value: 30 seconds

N/A RetryBackoff

The amount of time in milliseconds to wait for leaderelection to occur before retrying.

Default value: 250 milliseconds

N/A Max Retry The number of attempts to retry metadata request whenthe cluster is in the middle of a leader election.

Default value: 3 attempts

N/A RefreshFrequency

The amount of time in seconds after which metadata isrefreshed.

Default value: 40 seconds

Kafka Consumer TriggerApache Kafka Consumer Trigger receives records from specified topic in the Apache Kafka cluster.

Settings

On the Settings tab, you can define the Apache Kafka connection and its details as given in thefollowing table:

Condition Applicable Field Description

N/A ApacheKafkaClientConfiguration

Apache Kafka client configuration to be used.

N/A Topic The topic where Apache Kafka cluster stores streams ofrecord.

N/A ConsumerGroup ID

The group ID for the consumer group.

20

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 21: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Condition Applicable Field Description

N/A ValueDeserializer

Select the type of record value to be received from thedrop-down list: String or JSON

N/A CommitInterval

The time interval in which a consumer offset commits toApache Kafka.

Default Value: 5000 milliseconds

N/A InitialOffset

Select one of the following options:

● Newest: To start receiving published records since theconsumer is started

● Oldest: To start receiving records since the last commit

N/A Fetch MinBytes

Minimum size of data that server sends on fetch request.

N/A Fetch MaxWait

The maximum amount of time that the server wouldblock before answering a fetch request if there is notsufficient data to immediately satisfy the requirement thatyou have configured in the Fetch Min Bytes field.

N/A HeartbeatInterval

Time in milliseconds to send heartbeats to consumer.Heartbeats are used to ensure that the consumer's sessionremains active and to facilitate rebalancing whenconsumers join or leave a group.

Heartbeat interval must not be more than one-third of the session time.

N/A SessionTimeout

The consumer sends periodic heartbeats to serverindicating about its liveness to the broker. If no heartbeatsare received by a broker before the session times out, thebroker removes this consumer from the group andinitiates a rebalance.

Output Settings

Condition Applicable Field Description

N/A Headers Record headers to be received. Only String datatypevalue is supported.

Headers are supported in the Apache Kafkaversion 0.11.0 and later.

Applicable only whenJSON is selected in theValue Serializer field onthe Settings tab.

Schema forJSONvalue

The JSON schema for the Apache Kafka record value

21

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 22: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Output

Condition Applicable Field Description

Applicable only whenJSON is selected in theValue Serializer field.

jsonValue Complex data structure based on JSON schema that youhave configured in the Output Settings section.

N/A partition Partition number of the record

N/A offset Offset of the record

N/A topic Name of the topic

N/A key Key value

Applicable only whenString is selected in theValue Deserializer fieldon the Settings tab.

stringValue

String value to be received

N/A headers Header value to be received

Kafka ProducerApache Kafka producer activity sends a record to a specified topic or channel in the Kafka cluster.

Settings

On the Settings tab, you can define the Apache Kafka connection and its details as given in thefollowing table:

Condition Applicable Field Description

N/A ApacheKafkaConnection

Select the connection you want to use from the drop-down list.

N/A Acks Mode Select one of the following acknowledgement modes fromthe drop-down list:

● None: To receive no acknowledgement on recorddelivery

● Leader: To receive an acknowledgement on recorddelivery from the leader

● All: To receive acknowledgement on record deliveryfrom leaders and all in-sync replicas

Applicable only whenAll is selected in the AckMode field.

AckTimeout

The amount of waiting time in milliseconds to receiveconfirmation.

22

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 23: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Condition Applicable Field Description

N/A Compression Type

Select a compression type: None, GZIP, or LZ4.

N/A ValueSerializer

Select the type of record value to be sent: String or JSON.

N/A MaxRequestSize

The maximum size of buffered records that can be sent inone request.

Default value: 1048576 bytes

N/A MaxMessages

The maximum number of records that can be sent in asingle broker request.

N/A Frequency The frequency of sending buffered records inmilliseconds.

Default value: 1000

Input Settings

Condition Applicable Field Description

N/A Headers Header record to be sent. Only String datatype value issupported.

Headers are supported in the Apache Kafkaversion 0.11.0 and later.

Applicable only whenJSON is selected in theValue Serializer field.

Schema forJSONvalue

The JSON schema for the Apache Kafka record value.

Input

Condition Applicable Field Description

N/A topic Name of the topic.

N/A partition Partition number of the record to send.

N/A key Optional key value.

Applicable only whenString is selected in theValue Serializer field.

stringValue

String value to be send

Applicable only whenJSON is selected in theValue Serializer field.

jsonValue Complex data structure based on JSON schema that youhave configured on the Input Settings tab.

N/A headers Header value to be sent

23

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 24: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Output

Condition Applicable Field Description

N/A topic Name of the topic.

N/A partition Partition number of the record to send.

N/A offset Offset of the record.

Iterator

Use the Iterator tab to iterate a certain piece of logic multiple times. If you leave this tab blank, theactivity is executed only once. For more information about Iterator, see "Using the Iterator in anActivity" in the TIBCO Flogo® apps documentation.

Kafka Offset CommitApache Kafka Offset Commit activity notifies Kafka Consumer Trigger to commit given offset. This isuseful in case you want offsets to be committed as soon as the record is processed in the flow. Bydefault, offsets are committed only when flow is successfully executed.

This activity can be used only in conjuction with Kafka Consumer Trigger.

Iterator

Use the Iterator tab to iterate a certain piece of logic multiple times. If you leave this tab blank, theactivity is executed only once. For more information about Iterator, see "Using the Iterator in anActivity" in the TIBCO Flogo® apps documentation.

Microsoft SQL Server

This section contains the following topics:

OverviewTIBCO Flogo® Connector for Microsoft SQL Server is a TIBCO Cloud Integration- Flogo (PAYG)connector for executing SQL queries on a SQL Server database instance.

Creating a Microsoft SQL Server ConnectionYou must create a SQL Server connection before you can use the TIBCO Flogo® Connector for MicrosoftSQL Server. The Microsoft SQL Server connection contains all the parameters required to connect to theMicrosoft SQL Server database. The Microsoft SQL Server connection is used by all the activities in theMicrosoft SQL Server category.

By default, the Microsoft SQL Server database listens for connections on port 1433, although that isconfigurable as is the connection property on the Microsoft SQL Server.

To create a Microsoft SQL Server connection, click the Connections tab on the TIBCO CloudIntegration- Flogo (PAYG) page.

If this is the first connection you are adding, do the following:

1. Click the SQL Server Connector tile.

2. Enter the values for the fields in the SQL Server Connector dialog. See SQL Server ConnectionDetails topic for a description of the fields.

24

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 25: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

3. Click Connect.

If you already have existing connections for any connector in TIBCO Cloud Integration- Flogo (PAYG),the connections will be displayed on the Connections page.

1. Click Add Connection.

2. Click the SQL Server Connector tile.

3. Enter the values for the fields in the SQL Server Connector dialog. See SQL Server ConnectionDetails topic for a description of the fields.

4. Click Connect.

Microsoft SQL Server Connection Details

Provide the information of the Microsoft SQL Server server that this connection will connect to.

The SQL Server Connector dialog contains the following fields:

Field Description

Name A name for the Microsoft SQL Server connection that you are creating

Description A short string describing the connection

Host URL of the server that hosts the Microsoft SQL Server Connector database

Port Port number on which the Microsoft SQL Server Connector database listens

By default the Microsoft SQL Server Connector cluster is configuredwith port 1433. For custom configurations the port range should bewithin 1024 - 32767.

Database Name Name of the Microsoft SQL Server Database

User User name of the Microsoft SQL Server Database user

Password Password for the Microsoft SQL Server Database account

SQLServer QueryUse this activity to execute a simple or a complex SQL Query on a Microsoft SQL Server database. TheSQLServer Query activity returns information in the form of rows.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the Microsoft SQL Server database connection from which to retrieveinformation.

25

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 26: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Input Settings

Field Description

Query An SQL statement used to query the database. The query can be a simplequery or a complex query. A complex query has nested SQL statements.Prepared SQL queries can be constructed by using substitution variables (orsubstitution parameters) of the form ?<fieldname> in the query statement.For example select lastname, firstname, title from employees wherelastname='?lastname';

Each substitution variable identifies an input parameter whose mappedvalue will be substituted into the substitution variable at runtime. Thesubstitution variable can be reused for the same input parameter elsewherein the query. Input parameters used in the WHERE clause, and outputparameters used in the SELECT clause, and their corresponding typeinformation is automatically fetched from the database using the selectedconnection for the entered query. Input and output fields in the Input andOutput tabs of the activity are also automatically generated.

Be sure to include the semicolon (;) at the end of the query. Thisactivity expects a query to end with a semicolon to indicate the endof the query. A missing semicolon at the end of the query results inthe query hanging.

Following are some examples of simple and complex queries:

● Simple query example:SELECT * FROM employees;

For the above query, the output fields are generated from the table user'scolumn information.SELECT lastname, firstname FROM employees WHERE country = ?country and lastname like '%ll%' ORDER BY lastname DESC, firstname ASC;

For the above query, output fields are generated for lastname andfirstname and input fields are generated for country. Also the mappedvalue for the field country is substituted into the substitution variable ?country at runtime.

● Nested query example:SELECT categoryID, productName, MAX(unitprice) FROM products A WHERE unitprice = ( SELECT MAX(unitprice) FROM products B WHERE B.categoryID = A.categoryID) GROUP BY categoryID, productName HAVING MAX(unitprice) > 100;

Fields The grid is provided for informational purposes only.

26

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 27: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Input

This tab contains the input schema. The fields that were selected in the Input Settings tab will beavailable in the schema. You can either hard code their values or map them to a field from the output ofa preceding activity in the flow using the Mapper.

Output

This tab displays the activity output schema in a tree structure format. The output of an activity isdisplayed for informational purposes only and cannot be modified or altered. The information in thisschema varies depending on the fields that you selected in the Input Settings tab.

The properties that are displayed in the Output tab schema correspond to the output of this activityand can be used as input by subsequent activities in the flow.

SQLServer InsertUse this activity to execute an SQL Insert to insert the records into the Microsoft SQL Server database.

Settings

The Settings tab has the following fields.

Field Description

Connection Name of the Microsoft SQL Server database connection from which to retrieveinformation. You can select a connection from the drop-down list.

Input Settings

The Input Settings tab has the following fields:

Field Description

Insert An SQL statement used to insert a record in the table. You can constructprepared SQL queries by using substitution variables (or parameters) of theform ?<fieldname> in the insert query statement.

Each substitution variable identifies an input parameter whose mappedvalue will be substituted into the substitution variable at runtime. You canreuse the substitution variable for the same input parameter elsewhere in thequery. The type information for the input parameters used in the VALUESclause, is fetched from the database using the selected connection for theentered insert query. Similarly, input fields in the Input tab of the activity arealso populated based on the SQL Insert statement.

Be sure to include the semicolon (;) at the end of the query. Thisactivity expects an insert query to end with a semicolon to indicatethe end of the query. A missing semicolon at the end of the queryresults in the query hanging.

The following example represents a typical insert query:INSERT INTO ADVISOR (s_id, i_id) VALUES (?s_id, ?i_id);

For the above insert query, there will not be any output field, and input fieldis generated for s_id (VARCHAR) and i_id(VARCHAR) under Values[]node as its part of the values clause. Also, the mapped value for the fieldprice and name is substituted into the substitution variable ?s_id and ?i_id.

27

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 28: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Fields The grid is provided for informational purpose only.

Input

This tab displays the input schema of the activity in a tree structure format. The information in theschema varies based on the insert query provided. The fields that were selected in the Input Settingstab will be available in the schema. You can either hard code the values or map them to a field from theoutput of a preceding activity in the flow using the Mapper.

Fields from VALUES clause are displayed under VALUES node in input schema.

Output

This tab displays the output schema of the activity in a tree structure format. The information in theschema varies based on the insert query provided. The properties that are displayed in the Output tabschema correspond to the output of this activity and can be used as input by subsequent activities inthe flow.

SQLServer DeleteUse this activity to execute an SQL Delete to delete the record based on the delete statement.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the Microsoft SQL Server database connection from which to retrieveinformation. You can select the connection from the drop-down list.

Input Settings

The Input Settings tab has the following fields:

28

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 29: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Delete A SQL statement used to delete the record from the table. You can constructprepared SQL queries by using substitution variables (or parameters) of theform ?<fieldname> in the delete query statement.

Each substitution variable identifies an input parameter whose mappedvalue will be substituted into the substitution variable at runtime. You canreuse the substitution variable for the same input parameter elsewhere in thequery. The type information for the input parameters used in the WHEREclause, is fetched from the database using the selected connection for theentered delete query. Similarly, input fields in the Input tab of the activity arealso automatically generated.

Be sure to include the semicolon (;) at the end of the query. Thisactivity expects a delete query to end with a semicolon to indicatethe end of the query. A missing semicolon at the end of the queryresults in the query hanging.

The following example represents a typical delete query:Delete from advisor where i_id=?i_id;

For the above delete query, there will be no output field and input field isgenerated for i_id (VARCHAR). Also the mapped value for the field name issubstituted into the substitution variable ?i_id.

Fields The grid is provided for informational purpose only.

Input

This tab displays the input schema of the activity in a tree structure format. The information in theschema varies based on the delete query provided. The fields that were selected in the Input Settingstab will be available in the schema. You can either hard code the values or map them to a field from theoutput of a preceding activity in the flow using the Mapper.

Output

The Output tab displays the output schema of the activity in a tree structure format. The output is read-only. The information in the schema varies based on the fields selected on the Settings tab. Theproperties that are displayed in the schema correspond to the output of this activity and can be used asinput by subsequent activities in the flow.

MQTT

This section contains the following topics:

OverviewTIBCO Flogo® Connector for MQTT is used to subscribe to a topic or publish messages to a topic. Itsupports security and authentication, quality of service, and message retention.

For information about how to use MQTT, see the MQTT documentation.

29

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 30: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Creating an MQTT ConnectionTo use TIBCO Flogo® Connector for MQTT, you must first create an MQTT connection. The MQTTconnection contains the parameters required to connect to the MQTT server. The MQTT connection isused by all the activities in the MQTT category.

Prerequisites

Before you create a connection, familiarize yourself with MQTT. For details about how to use theproduct, see the MQTT documentation.

Procedure

1. In TIBCO Cloud Integration, click the Connections tab and perform one of the following actions:

● To add a connection for the first time, click the MQTT Connector card. You can search for aconnector card by typing the connector name in the search field.

● If you have an existing connection and want to add a new connection, click the AddConnection link.

2. In the MQTT Connector dialog box, enter the connection details. For field descriptions, see the MQTT Connection Details topic.

3. Click Save Connection.

MQTT Connection Details

To establish the connection successfully, you must configure the MQTT instance.

The MQTT Connector dialog box contains the following fields:

Field Description

ConnectionName

A unique name for the connection that you are creating. This is displayed in theConnection drop-down list for all the TIBCO Flogo® Connector for MQTTactivities.

Description A short description of the connection

Broker URL The format of the broker URL is:

<proto>://<host>:<port>

Where proto is either "tcp" or "ssl".

Username Enter the user name required to authenticate the broker port for this connection.

Password Enter the password required to authenticate the broker port for this connection.

EncryptionMode

Choose the encryption mode from None, TLS-Cert, or TLS-ClientAuth.

Client Key Browse to the location of the client's secret key and select it. It is required formutual authentication.

30

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 31: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

MQTT Subscriber TriggerThe MQTT Subscriber Trigger subscribes to a topic and presents the messages received as output.When the messages arrive, a new flow is triggered.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the connection

Topic The topic to which the trigger subscribes.

As the topic string can contain wild card characters, multiple topicscan be subscribed.

Some topic string rules are:

● + is a single level wild card. It must be presented alone between '/' chars

● # is a multi-level wild card corresponding to one or more levels. It must bepresented as the last char in the topic preceded by a '/'. The following topicstrings are allowed:

— /country/province/county/street

— /country/+/county/street

— /country/province/#

— /country/+/county/#

For details about topic string rules, see the MQTT documentation.

Maximum QoS If a message is sent with a higher QoS, the effective QoS of the message isreduced to the maximum QoS value. To avoid QoS getting reduced on thesubscriber side, you must set maximum QoS to 2.

ValueDeserializer

Establish the way the message body is treated

ValueDeserializer:String

The activity input presents the message bytes as a simple string

ValueDeserializer:JSON

The activity input presents the message bytes as a JSON object decoded with theprovided schema

ValueDeserializer:Base64

The activity input presents the message bytes as a base64 encoded string

Output Settings

The Output Settings tab has the following field:

31

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 32: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Schema forJSON value

Enter a JSON object representation used on the output tab.

For instance:

{

"fname":"Sam",

"lname":"Patricks",

"age":37,

"employed":true

}

Output

The Output tab displays the schema in a tree format. The output is read-only.

The Output tab has the following fields:

Field Description

topic The exact topic on which the message arrived

retained It indicates whether this message was a retained message

qos It indicates the quality of service of the message.

string value The value of the message presented as a string. An error is displayed if themessage is not a string.

MQTT Publish ActivityThe MQTT Publish activity publishes a message to a broker, which supports and exposes the MQTTprotocol.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the connection

Topic The topic where the message is published

Retain You must enable this field to retain the last message for new subscribers

QoS The quality of service is set to 0, 1, or 2

● 0 - message is delivered utmost once

● 1 - message is delivered at least once

● 2 - message is delivered exactly once

32

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 33: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

ValueDeserializer

Establish the way the message body is treated

ValueDeserializer:String

The activity input accepts a simple string. The string is sent as an array of bytesto the server.

ValueDeserializer:JSON

An Input Settings field is enabled where the application designer can enter aJSON object. That object is presented on the input schema for mapping and atrun time the object is deserialized and sent as bytes. A subscriber can use thesame JSON object definition to deserialize the message.

ValueDeserializer:Base64

The activity accepts string data which is base64 decoded into a byte array beforebeing sent to the broker. If a previous activity presents a byte array on its output,it is safe to map that value here.

Input Settings

The Input Settings tab is visible if the deserializer is set to JSON on the Settings tab. An example of aJSON object is entered in this field which can be used to compose the input schema.

The Input Settings tab has the following field:

Field Description

Schema forJSON value

Enter a JSON object representation to be used on the Input tab.

Sample JSON query:

{

"fname":"Sam",

"lname":"Patricks",

"age":37,

"employed":true

}

Input

The Input tab has the following field:

Field Description

Input Map the string, byte array, or JSON object.

PostgreSQL

This section contains the following topics:

33

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 34: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

OverviewThis connector enables you to run SQL queries on a PostgreSQL or a Greenplum database instance. APostgreSQL connection is used to create a PostgreSQL or Greenplum query activity.

For details about using PostgreSQL or Greenplum Database, see their respective productdocumentation.

Creating a PostgreSQL ConnectionYou must create a PostgreSQL connection before you can use this connector. The PostgreSQLconnection contains all the parameters required to connect to the PostgreSQL database. This connectionis used by all the activities in the PostgreSQL category.

By default, the PostgreSQL database listens for connections on port 5432, although that is configurableas is the connection property on the PostgreSQL Connector.

To create a connection, click the Connections tab on the TIBCO Cloud Integration- Flogo (PAYG) page.

If this is the first connection you are adding, do the following:

1. Click the PostgreSQL Connector tile.

2. Enter the values for the fields in the PostgreSQL Connector dialog. See PostgreSQL ConnectionDetails topic for a description of the fields.

3. Click Connect.

If you already have existing connections for any connector in TIBCO Cloud Integration- Flogo (PAYG),the connections will be displayed on the Connections page.

1. Click Add Connection.

2. Click the PostgreSQL Connector tile.

3. Enter the values for the fields in the PostgreSQL Connector dialog. See PostgreSQL ConnectionDetails topic for a description of the fields.

4. Click Connect.

PostgreSQL Connection Details

Provide the information of the PostgreSQL server that this connection will connect to.

The PostgreSQL Connector dialog contains the following fields:

Field Description

ConnectionName

A name for the PostgreSQL Connector connection that you are creating

Description A short string describing the connection

Host URL of the server that hosts the PostgreSQL Connector database

Port Port number on which the PostgreSQL Connector database listens

By default PostgreSQL Connector cluster is configured with port 5432.For custom configurations, the port range should be within 1024 -32767.

Database Name Name of the PostgreSQL Database

34

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 35: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

User User name of the PostgreSQL Database user

Password Password for the PostgreSQL Database account

PostgreSQL QueryUse this activity to execute a simple or a complex SQL Query on a database. The PostgreSQL Queryactivity returns information in the form of rows.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the PostgreSQL database connection from which to retrieveinformation. You can select the connection from the drop-down list.

Input Settings

The Input Settings tab has the following fields:

35

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 36: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Query An SQL statement used to query the database. The query can be a simplequery or a complex query. A complex query has nested SQL statements. Youcan construct prepared SQL queries by using substitution variables (orparameters) of the form ?<fieldname> in the query statement. For example,select * from student where name = ?name;

Each substitution variable identifies an input parameter whose mappedvalue will be substituted into the substitution variable at runtime. You canreuse the substitution variable for the same input parameter elsewhere in thequery. Input parameters used in the WHERE clause, and output parametersused in the SELECT clause, and their corresponding type information isautomatically fetched from the database using the selected connection for theentered query. Input and output fields in the Input and Output tabs of theactivity are also automatically generated.

Be sure to include the semicolon (;) at the end of the query. Thisactivity expects a query to end with a semicolon to indicate the endof the query. A missing semicolon at the end of the query results inthe query hanging.

The following examples represent simple and complex queries:

● Simple query example:SELECT * FROM student;

For the above query, the output fields are generated from the tablestudent's column information.SELECT name, dept_name, tot_cred FROM student WHERE dept_name = ?dept_name and tot_cred > ?tot_cred ORDER BY dept_name;

For the above query, output fields are generated for name, dept_name andtot_cred and input fields are generated for dept_name (varchar) andtot_cred (numeric). Also the mapped values for the fields, dept_nameand tot_cred are substituted into the substitution variables ?dept_nameand ?tot_cred at runtime.

● Nested query example:SELECT * FROM (SELECT dept_name, SUM(tot_cred) AS total_credit FROM student GROUP BY dept_name) SUBS, department WHERE SUBS.dept_name = department.dept_name AND total_credit > 8000;

Fields The grid is provided for informational purposes only.

Input

This tab contains the input schema. The fields that were selected in the Input Settings tab will beavailable in the schema. You can either hard code their values or map them to a field from the output ofa preceding activity in the flow using the Mapper.

36

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 37: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Output

This tab displays the activity output schema in a tree structure format. The output of an activity isdisplayed for informational purposes only and cannot be modified or altered. The information in thisschema varies depending on the fields that you selected in the Input Settings tab.

The properties that are displayed in the Output tab schema correspond to the output of this activityand can be used as input by subsequent activities in the flow.

PostgreSQL InsertUse this activity to execute an SQL Insert to insert the records into the database and return theinformation based on the returning clause specified in the insert query.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the PostgreSQL database connection from which to retrieveinformation. You can select the connection from the drop-down list.

Input Settings

The Input Settings tab has the following fields:

37

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 38: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

Insert An SQL statement used to insert a record in the table. You can constructprepared SQL queries by using substitution variables (or parameters) of theform ?<fieldname> in the query statement.

Each substitution variable identifies an input parameter whose mappedvalue will be substituted into the substitution variable at runtime. You canreuse the substitution variable for the same input parameter elsewhere in theinsert query. The type information for the input parameters used in theVALUES and RETURNING clause is fetched from the database using theselected connection for the entered insert query. Also based on the outputparameters used in the RETURNING clause, the corresponding typeinformation is fetched from the database using the selected connection for theentered insert query. Similarly, input and output fields in the Input andOutput tabs of the activity are also populated based on the SQL Insertstatement.

Be sure to include the semicolon (;) at the end of a query. Thisactivity expects an insert query to end with a semicolon to indicatethe end of the query. A missing semicolon at the end of the queryresults in the query hanging.

The following examples represent insert queries:

● INSERT INTO products (product_no, name, price) VALUES (1, 'Cheese', ?price), (2, 'Juice', ?price), (3, 'Milk', ?price ) returning (select name from instructor where name = ?name);

For the above insert query, output field is generated for name and inputfield is generated for price (NUMERIC) under Values[] node as its part ofvalues clause, and name(VARCHAR) under parameters node as it is partof the parameter select sub-query . Also, the mapped value for the fieldprice and name is substituted into the substitution variable ?price and ?name.

● INSERT INTO products (product_no, name, price) VALUES (?product_no, ?name, ?price) returning price;

For the above insert query, output field is generated for price and inputfields are generated for product_no (INTEGER), name(TEXT), andprice(NUMERIC). Also, the mapped value for the field product_no,name, price is substituted into the substitution variables ?product_no, ?name, ?price. The parameters node in the input tab will not havemappings as there is no parameter in the insert query statement.

Fields The grid is provided for informational purposes only.

Input

This tab displays the input schema of the activity as a tree structure. The information in the schemavaries based on the insert query provided. The fields that were selected in the Input Settings tab will beavailable in the schema. You can either hard code the values or map them to a field from the output of apreceding activity in the flow using the Mapper.

Fields from RETURNING clause are displayed under Parameters node and fields from VALUES clauseare displayed under VALUES node in input schema.

38

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 39: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Output

This tab displays the output schema of the activity as a tree structure. The output is read-only. Theinformation in the schema varies based on the fields selected on the Settings tab. The properties thatare displayed in the schema correspond to the output of this activity and can be used as input bysubsequent activities in the flow.

PostgreSQL DeleteUse this activity to execute an SQL Delete to delete the record and return the information based on thereturning clause specified in the delete query.

Settings

The Settings tab has the following fields:

Field Description

Connection Name of the PostgreSQL database connection from which to retrieveinformation. You can select the connection from the drop-down list.

Input Settings

The Input Settings tab has the following fields:

Field Description

Delete An SQL statement used to delete the record from the table. You can constructprepared SQL queries by using substitution variables (or parameters) of theform ?<fieldname> in the query statement.

Each substitution variable identifies an input parameter whose mappedvalue will be substituted into the substitution variable at runtime. You canreuse the substitution variable for the same input parameter elsewhere in thedelete query. The type information for the input parameters used in theWHERE and RETURNING clause, is fetched from the database using theselected connection for the entered delete query. Also, output parametersused in the RETURNING clause and their corresponding type information isautomatically fetched from the database using the selected connection for theentered delete query. Similarly, input and output fields in the Input andOutput tabs of the activity are also automatically generated.

Be sure to include the semicolon (;) at the end of a query. Thisactivity expects a delete query to end with a semicolon to indicatethe end of the query. A missing semicolon at the end of the queryresults in the query hanging.

The following example represents a typical delete query:Delete from student where name = ?name returning id;

For the above delete query, output field is generated for id from thereturning clause and input field is generated for name (VARCHAR). Alsothe mapped value for the field name is substituted into the substitutionvariable ?name.

Fields The grid is provided for informational purposes only.

39

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 40: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Input

This tab displays the input schema of the activity as a tree structure. The information in the schemavaries based on the delete query provided. The fields that were selected in the Input Settings tab willbe available in the schema. You can either hard code the values or map them to a field from the outputof a preceding activity in the flow using the Mapper.

Output

This tab displays the output schema of the activity as a tree structure. The output is read-only. Theinformation in the schema varies based on the fields selected on the Settings tab. The properties thatare displayed in the schema correspond to the output of this activity and can be used as input bysubsequent activities in the flow.

TIBCO Cloud Messaging

This section contains the following topics:

OverviewTIBCO Flogo® Connector for TIBCO Cloud™ Messaging allows sending and receiving messages to andfrom TIBCO Cloud Messaging service.

Before you use the connector, ensure that you have a valid TIBCO Cloud Messaging account.

For details on using TIBCO Cloud Messaging, refer to the TIBCO Cloud Messaging productdocumentation.

Creating a TIBCO Cloud Messaging ConnectionYou must create a TIBCO Cloud Messaging connection before you can use the TIBCO Flogo® Connectorfor TIBCO Cloud™ Messaging connector. The TIBCO Cloud Messaging connection contains all theparameters required to connect to TIBCO Cloud Messaging. The TIBCO Cloud Messaging connection isused by all the activities in the TIBCO Cloud Messaging category.

Before you create a TIBCO Cloud Messaging connection, be sure that you have an active TIBCO CloudMessaging subscription.

Before you create a connection, familiarize yourself with TIBCO Cloud Messaging. For details on howto use the TIBCO Cloud Messaging product, see the TIBCO Cloud Messaging product documentation.

To create a TIBCO Cloud Messaging connection, click the Connections tab on the TIBCO CloudIntegration- Flogo (PAYG) page.

If this is the first connection you are adding, do the following:

1. Click the TIBCO Cloud Messaging Connector tile.

2. Enter the values for the fields in the TIBCO Cloud Messaging Connector dialog. See TIBCO CloudMessaging Connection Details topic for a description of the fields.

3. Click Save.If you already have an existing connection for any connector in TIBCO Cloud Integration- Flogo(PAYG), the connections will be displayed on the Connections page.

1. Click Add Connection.

2. Click the TIBCO Cloud Messaging Connector tile.

3. Enter the values for the fields in the TIBCO Cloud Messaging Connector dialog. See TIBCO CloudMessaging Connection Details topic for a description of the fields.

40

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 41: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

4. Click Save.

TIBCO Cloud Messaging Connection Details

Provide the information of the TIBCO Cloud Messaging connection to be created.

The TIBCO™ Cloud Messaging Connector dialog contains the following fields:

Field Description

ConnectionName

Name for the TIBCO Cloud Messaging connection that you are creating

Description A short string of text describing the connection.

Connection URL URL to the TIBCO Cloud Messaging service. You can obtain the URL from theTIBCO Cloud Messaging domain in the cloud.

AuthenticationKey

Authentication key required to log in to your TIBCO Cloud Messaging service.You can obtain the authentication key from the TIBCO Cloud Messaging domainin the cloud.

MessageSubscriber TriggerThe Message Subscriber trigger listens for a published message from the TIBCO Cloud Messagingservice.

Settings

The Settings tab has the following fields.

Field Description

Connection Name of the TIBCO Cloud Messaging connection that you want to use.

DurableSubscriber

By default, this field is set to False. Setting this field to True, will change yoursubscriber to a durable subscriber. As a durable subscriber, if your app goesdown, any incoming messages during the period when your app was down willbe preserved and delivered once your app comes back up again.

A trigger marked as a durable subscriber should have been running atleast once in order for it to receive pending messages that were sentwhile the app was down.

When you set this field to True, you see the Durable Name and Durable Typefields.

Enter a Durable Name for the subscription. This is a required field.

Currently, only Shared durable subscriber type is supported. As a SharedDurable Subscriber, if you have multiple instances of an app, the messagesreceived will be distributed among the app instances in a round-robin manner.

Destination Name of the message destination. If you leave this blank it will receive allmessages, otherwise only the messages with the specific destination set.

41

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 42: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Field Description

ContentMatcher

Specify the attributes to match in the incoming message by clicking on Add row.For each attribute specify its name, type, and value.

You cannot have two subscribers with the same durable name but different destinations runningconcurrently. You must stop the subscriber that was already running before your start the secondsubscriber. This is also true for blue-green deployments supported by PaaS platforms, such as TIBCOCloud Integration. So, do not update the destination name in blue-green deployments.

Output Settings

The fields that you select in this tab will be available in the output schema in the Output tab.

Field Description

Message Schema An example JSON object that you want to receive from TIBCO CloudMessaging service.

Output

This tab displays the schema specified in the Output Settings tab in a tree structure format. The outputof an activity is displayed for informational purposes only and cannot be modified or altered.

The properties that are displayed in the Output tab schema correspond to the output of this activityand can be used as input by subsequent activities in the flow.

TCMMessagePublisherThis activity sends a message to the TIBCO Cloud Messaging service.

Settings

The Settings tab has the following fields.

Field Description

Connection Name of the TIBCO Cloud Messaging connection that you want to use.

Input Settings

The fields that you select in this tab will be available in the input schema in the Input tab.

Field Description

Message Schema A JSON object that you want to send to TIBCO Cloud Messaging.

Input

Field Description

destination The destination for a message.

In addition to destination, the Input tab displays the elements of the schema that you entered in theInput Settings tab in a tree format. You can input the values for each element by hard coding the value

42

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 43: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

or mapping the value to an element from the output schema of a previous activity in the flow. See thesection on Mapper in the TIBCO Cloud™ Integration- Flogo® (PAYG) documentation for details on howto map elements.

43

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 44: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

List of Supported Connectors

The following connectors are supported on TIBCO Cloud Integration- Flogo (PAYG) and can bedownloaded from the TIBCO™ eDelivery site. Refer to the specific connector readme for the compatibleTIBCO Cloud Integration- Flogo (PAYG) version.

Connector forProduct Link to Connector Documentation

AmazonDynamoDB

https://docs.tibco.com/products/tibco-flogo-connector-for-amazon-dynamodb

Amazon ElasticFile System

https://docs.tibco.com/products/tibco-flogo-connector-for-amazon-elastic-file-system

Amazon Glacier https://docs.tibco.com/products/tibco-flogo-connector-for-amazon-glacier

AmazonRedshift

https://docs.tibco.com/products/tibco-flogo-connector-for-amazon-redshift

Amazon S3 https://docs.tibco.com/products/tibco-flogo-connector-for-amazon-s3

ApacheCouchDB

https://docs.tibco.com/products/tibco-flogo-connector-for-apache-couchdb

Apache Solr https://docs.tibco.com/products/tibco-flogo-connector-for-apache-solr

GitHub https://docs.tibco.com/products/tibco-flogo-connector-for-github

Google CloudStorage

https://docs.tibco.com/products/tibco-flogo-connector-for-google-cloud-storage

Google Docs https://docs.tibco.com/products/tibco-flogo-connector-for-google-docs

Google Sheets https://docs.tibco.com/products/tibco-flogo-connector-for-google-sheets

GreenplumDatabase

https://docs.tibco.com/products/tibco-flogo-connector-for-greenplum-database

Jira https://docs.tibco.com/products/tibco-flogo-connector-for-jira

MailChimp https://docs.tibco.com/products/tibco-flogo-connector-for-mailchimp

Marketo https://docs.tibco.com/products/tibco-flogo-connector-for-marketo

MicrosoftAzure DataFactory

https://docs.tibco.com/products/tibco-flogo-connector-for-microsoft-azure-data-factory

MicrosoftAzure ServiceBus

https://docs.tibco.com/products/tibco-flogo-connector-for-microsoft-azure-service-bus

44

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide

Page 45: (PAYG) Activities and Triggers Guide TIBCO Cloud ... · Activities and Triggers Guide Software Release 2.6.1 July 2019. Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES

Connector forProduct Link to Connector Documentation

MicrosoftAzure Storage

https://docs.tibco.com/products/tibco-flogo-connector-for-microsoft-azure-storage

Redis https://docs.tibco.com/products/tibco-flogo-connector-for-redis

Riak KV https://docs.tibco.com/products/tibco-flogo-connector-for-riak

SalesforcePardot

https://docs.tibco.com/products/tibco-flogo-connector-for-salesforce-pardot

Salesforce.com https://docs.tibco.com/products/tibco-flogo-connector-for-salesforce-com

Salesforce.comEinsteinAnalytics

https://docs.tibco.com/products/tibco-flogo-connector-for-salesforce-com-einstein-analytics

SAP Cloud forCustomer

https://docs.tibco.com/products/tibco-flogo-connector-for-sap-cloud-for-customer

SAP S/4 HANACloud

https://docs.tibco.com/products/tibco-flogo-connector-for-sap-s-4hana-cloud

SAPSuccessFactors

https://docs.tibco.com/products/tibco-flogo-connector-for-sap-successfactors

Slack https://docs.tibco.com/products/tibco-flogo-connector-for-slack

SugarCRM https://docs.tibco.com/products/tibco-flogo-connector-for-sugarcrm

Zoho CRM https://docs.tibco.com/products/tibco-flogo-connector-for-zoho-crm

45

TIBCO Cloud™ Integration- Flogo® (PAYG) Activities and Triggers Guide