Supported Custom CNCF Serverless Workflow

Each input argument to a function can be a JSON node, string, or jq expression, and follows the CNCF syntax.

connectivity::rest

This function is an outbound HTTP call. By default, it uses the configured security policy. Values for arguments can be valid jq expressions.

This table describes JSON node input format for this function.

Input object	Description
`uri`	This is the Outbound URL.
`method`	This is the HTTP method.
`headers`	(Optional) Set the headers where the JSON node is the key header name, and the value is a string or array of header value(s).
`parameters`	(Optional) This is a collection of path or query parameters, or both.
`body`	(Optional) This is the outbound request payload.
`skipPolicy`	(Optional) This is a boolean value, set by default to `FALSE`. Set it to `TRUE` if you want to skip the security policy.
`requestMediaType`	(Optional) Use this to override the default connectivity::rest behavior to process request media like structured (JSON), binary, multipart, and form-urlencoded.
`responseMediaType`	(Optional) Use this to override the default connectivity::rest behavior to process response media like structured (JSON), binary, multipart, and form-urlencoded.

This table describes JSON node output format for this function.

Response/output object for connectivity::rest	Description
`headers`	This is the response header, where the JSON node is the key header name, and the value is a string or array of header values.
`status`	This is the response status. It is an integer.
`body`	This is the outbound response payload.

Sample code:

"functions": [
  {
   "name": "createTaskListFunction",
    "type": "custom",
    "operation": "connectivity::rest"
  }
],
"states":[
 {
  ...
  "actions":[
  {
  "functionRef": {
  "refName": "createTaskListFunction",
   "arguments": {
     "uri": <String/JQ expression>,
     "method": <String/JQ expression>,
     "headers": <Object/JQ expression>",
     "parameters": "<Object/JQ expression>,
     "body": <Object/String/JQ>",
     "skipPolicy": boolean

          }
        },
 "actionDataFilter": {
  "results": "${ {body: .body, headers: .headers, status: .status} }",
     ..
   }
  }
  ],
   ....
  }

connectivity::log

This function logs a message at the specified level.

This table describes the input arguments for this function.

Input argument	Description
`message`	This is the message to log.
`level`	This is the level at which to log the message. The value can be `SEVERE`, `WARN`, `INFO`, `DEBUG`, or `TRACE`.

Note:

DEBUG mode publishes the message to the activity stream.

Sample code:

"functions": [
  {
   "name": "logFunction",
    "type": "custom",
    "operation": "connectivity::log"
  }
],
"states":[
 {
  ...
  "actions":[
  {
  "functionRef": {
  "refName": "logFunction",
   "arguments": {
     "message": <String/JQ expression>
      }
   }
  }
  ],
   ....
  }

connectivity::avroSchemaToJsonSchema

This function converts the AVRO schema to JSON schema.

This table describes the input arguments for this function.

Input	Example Value
`avroSchema`	`"{\"type\":\"record\",\"name\":\"Person\",\"fields\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"age\",\"type\":\"int\"},{\"name\":\"email\",\"type\":\"string\"}]}"`

Sample output:

{
  "type" : "object",
  "required" : [ "name", "age", "email" ],
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "age" : {
      "type" : "integer"
    },
    "email" : {
      "type" : "string"
    }
  }
}

Sample code:

"functions": [

{
          "name": "dynamicAvroSchema",
          "type": "custom",
          "operation": "connectivity::avroSchemaToJsonSchema"
        }

],

"states": [

 {

...

"actions": [

{
              "functionRef": {
              "refName":"dynamicAvroSchema",
              "arguments": {
                "avroSchema": <String/JQ expression>              }
              },
              "actionDataFilter": {
                "toStateData": 

<JQ expression>

              }
            }

]

}

connectivity::avroEncode

This function converts the JSON data corresponding to the AVRO schema to AVRO binary encoded data.

This table describes the input arguments.

Key	Description	Example Value
`avroSchema`	AVRO schema (string format).	`"{\"name\":\"Jane Smith\",\"age\":25,\"email\":\"janesmith@example.com\"}"`
`avroJsonData`	JSON data (string format) corresponding to AVRO schema.	`"{\"type\":\"record\",\"name\":\"Person\",\"fields\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"age\",\"type\":\"int\"},{\"name\":\"email\",\"type\":\"string\"}]}"`

Here is the sample output:

Jane Smith2*janesmith@example.com

Sample code:

"functions": [
        {
          "name": "avroEncodeFunc",
          "operation": "connectivity::avroEncode",
          "type": "custom"
        }
      ],

"states": [
        {

"actions": [
            {
              "functionRef": {
                "refName":"avroEncodeFunc",
                "arguments": {
                  "avroSchema": "<String/JQ expression>
                  "avroJsonData": <String/JQ expression>
                }
                },
                "actionDataFilter": {
                  "toStateData": 

<JQ expression>

                }
            }

}
      ]

connectivity::avroDecode

This function decodes the AVRO binary encoded data.

This table describes the input argument.

Key	Description	Example Value
`avroSchema`	AVRO schema (string format), that was converted to JSON schema.	`"{\"type\":\"record\",\"name\":\"Person\",\"fields\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"age\",\"type\":\"int\"},{\"name\":\"email\",\"type\":\"string\"}]}"`
`avroEncodedData`	AVRO binary encoded data (text).	`Jane Smith2*janesmith@example.com`

Sample output:

{"name":"Jane Smith","age":25,"email":"janesmith@example.com"}

Sample code:

"functions": [
        {
          "name": "avroDecodeFunc",
          "operation": "connectivity::avroDecode",
          "type": "custom"
        }
      ],

"states": [
        {

"actions": [
            {
              "functionRef": {
                "refName":"avroDecodeFunc",
                "arguments": {
                  "avroSchema": "<String/JQ expression>"
                  "avroEncodedData": "<String/JQ expression>"
                }
                },
                "actionDataFilter": {
                  "toStateData": 

<JQ expression>

                }
            }

}
      ]

connectivity::jsonPayloadToXMLPayload

This function converts a JSON payload to an XML payload. You can use this function in two ways, that is, with or without the targetNamespace attribute. Using this attribute, you can add a target namespace to the output xml payload.

The input arguments for both the scenarios are described below.

Table 14-1 Without the targetNamespace argument

Key	Description	Example Input Value
`jsonPayload`	The JSON payload (in String format) to be converted to the XML payload.	"{ \"StorageServiceProperties\" : { \"Logging\" : { \"Version\" : \"1.0\", \"Read\" : \"false\", \"Write\" : \"true\", \"Delete\" : \"false\", \"RetentionPolicy\" : { \"Enabled\" : \"false\" } }, \"HourMetrics\" : { \"Version\" : \"1.0\", \"Enabled\" : \"true\", \"IncludeAPIs\" : \"true\", \"RetentionPolicy\" : { \"Enabled\" : \"true\", \"Days\" : \"7\" } }, \"MinuteMetrics\" : { \"Version\" : \"1.0\", \"Enabled\" : \"false\", \"RetentionPolicy\" : { \"Enabled\" : \"false\" } }, \"Cors\" : \"\", \"DeleteRetentionPolicy\" : { \"Enabled\" : \"true\", \"Days\" : \"7\", \"AllowPermanentDelete\" : \"false\" }, \"StaticWebsite\" : { \"Enabled\" : \"false\" } }}"

Table 14-2 With the targetNamespace argument

Key	Description	Example Value
`jsonPayload`	The JSON payload (in String format) to be converted to the XML payload.	`{ "AccelerateConfiguration": { "Status": "Suspended" } }`
`targetNamespace`	The target namespace to add to the output xml payload.	`"http://s3.amazonaws.com/doc/2006-03-01/"`

Sample output without the targetNamespace property:

<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?><StorageServiceProperties><Logging><Version>1.0</Version><Read>false</Read><Write>true</Write><Delete>false</Delete><RetentionPolicy><Enabled>false</Enabled></RetentionPolicy></Logging><HourMetrics><Version>1.0</Version><Enabled>true</Enabled><IncludeAPIs>true</IncludeAPIs><RetentionPolicy><Enabled>true</Enabled><Days>7</Days></RetentionPolicy></HourMetrics><MinuteMetrics><Version>1.0</Version><Enabled>false</Enabled><RetentionPolicy><Enabled>false</Enabled></RetentionPolicy></MinuteMetrics><Cors/><DeleteRetentionPolicy><Enabled>true</Enabled><Days>7</Days><AllowPermanentDelete>false</AllowPermanentDelete></DeleteRetentionPolicy><StaticWebsite><Enabled>false</Enabled></StaticWebsite></StorageServiceProperties>

Sample output with the targetNamespace property:

<?xml version="1.0" encoding="UTF-8"?>
<AccelerateConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <Status>Suspended</Status>
</AccelerateConfiguration>

Sample code without the targetNamespace property:

"functions": [

{
          "name": "dynamicXMLPayload",
          "type": "custom",
          "operation": "connectivity::jsonPayloadToXMLPayload"
        }

],

"states": [

 {

...

"actions": [

{
              "functionRef": {
              "refName":"dynamicXMLPayload",
              "arguments": {
                "jsonPayload": <String/JQ expression>

}
              },
              "actionDataFilter": {
                "toStateData": 

<JQ expression>

              }
            }

]

}

Sample code with the targetNamespace property:

"functions": [

{
          "name": "dynamicXMLPayload",
          "type": "custom",
          "operation": "connectivity::jsonPayloadToXMLPayload"
        }

],

"states": [

 {

...

"actions": [

{
              "functionRef": {
              "refName":"dynamicXMLPayload",
              "arguments": {
                "jsonPayload": <String/JQ expression>,

  "targetNamespace": "${.configuration.TargetNamespace}"         

}
              },
              "actionDataFilter": {
                "toStateData": 

<JQ expression>

              }
            }

]

}

connectivity::xmlPayloadToJsonSchema

This function converts an XML payload to a JSON schema. You can provide the XML payload with attributes on the Adapter Endpoint Configuration Wizard, which will be converted to a JSON schema. You can also use this to create a JSON trigger at runtime.

The input arguments for the function are described below.

Key	Description	Example Value
`XMLPayload`	The XML payload to be converted to the JSON schema.	`<?xml version = '1.0' encoding = 'UTF-8'?> <ListBucketResult> <Name firstname="chai">chaitanya</Name> <Prefix/> <Marker/> <MaxKeys>0</MaxKeys> <IsTruncated>false</IsTruncated> </ListBucketResult>`

Sample output:

 {

    "type": "object",

    "properties": {

        "ListBucketResult": {

            "type": "object",

            "properties": {

                 "Name": {

                    "type": "object",

                    "properties": {

                        "firstname": {

                            "type": "string",

                            "xml": {

                                "attribute": true

                            }

                        },

                        "xml": {

                            "type": "string"

                        }

                    }

                },

                "Prefix": {

                    "type": "string"

                },

                "Marker": {

                    "type": "string"

                },

                "MaxKeys": {

                    "type": "number"

                },

                "IsTruncated": {

                    "type": "boolean"

                }

            }

        }

    }

}

Sample code:

"functions": [

{
          "name": "dynamicJSONSchema",
          "type": "custom",
          "operation": "connectivity::xmlPayloadToJsonSchema"
        }

],

"states": [

 {

...

"actions": [

{
              "functionRef": {
              "refName":"dynamicJSONSchema",
              "arguments": {
                "XMLPayload": <String/JQ expression>              }
              },
              "actionDataFilter": {
                "toStateData":

<JQ expression>

              }
            }

]

connectivity::sampleXmlToJson

This function converts a sample XML payload to a JSON schema in designtime.

The input arguments for the function are described below.

Key	Description	Example Value
`XMLPayload`	The XML payload (in String format) to be converted to the JSON payload in designtime.	<?xml version="1.0" encoding="UTF-8"?> <ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Owner> <ID>77fd6d45133de29e6f96bf93a519ffcff023b726995f38e8100e7d95ff8fe501</ID> </Owner> <Buckets> <Bucket> <Name>ap-bucket-bcone</Name> <CreationDate>2024-01-25T05:44:12.000Z</CreationDate> </Bucket> <Bucket> <Name>ap-bucket-bconevi</Name> <CreationDate>2024-01-18T08:40:28.000Z</CreationDate> </Bucket> <Bucket> <Name>ap-bucket-bconevj</Name> <CreationDate>2024-01-18T08:28:40.000Z</CreationDate> </Bucket> <Bucket> <Name>ap-bucket-bconevo</Name> <CreationDate>2024-01-18T08:40:46.000Z</CreationDate> </Bucket> <Bucket> <Name>bconeb</Name> <CreationDate>2024-01-08T14:48:21.000Z</CreationDate> </Bucket> <Bucket> <Name>bconebkt1</Name> <CreationDate>2024-01-02T11:54:28.000Z</CreationDate> </Bucket> <Bucket> <Name>bconebuck16thjan</Name> <CreationDate>2024-01-16T09:15:53.000Z</CreationDate> </Bucket> <Bucket> <Name>bconebuck18thjan</Name> <CreationDate>2024-01-18T07:46:16.000Z</CreationDate> </Bucket> <Bucket> <Name>bconebucket</Name> <CreationDate>2024-02-14T06:57:49.000Z</CreationDate> </Bucket> <Bucket> <Name>bconegbbucketab</Name> <CreationDate>2024-02-21T11:40:35.000Z</CreationDate> </Bucket> <Bucket> <Name>bucket12feb</Name> <CreationDate>2024-02-12T10:21:33.000Z</CreationDate> </Bucket> <Bucket> <Name>bucket23rdjan</Name> <CreationDate>2024-01-23T05:10:29.000Z</CreationDate> </Bucket> <Bucket> <Name>bucket30thjan</Name> <CreationDate>2024-01-30T05:39:54.000Z</CreationDate> </Bucket> <Bucket> <Name>bucket31stjan</Name> <CreationDate>2024-01-31T05:37:53.000Z</CreationDate> </Bucket> <Bucket> <Name>demobucket2vj</Name> <CreationDate>2024-02-13T08:21:30.000Z</CreationDate> </Bucket> <Bucket> <Name>demotest88</Name> <CreationDate>2024-02-13T12:05:51.000Z</CreationDate> </Bucket> <Bucket> <Name>demotest89</Name> <CreationDate>2024-02-23T07:49:19.000Z</CreationDate> </Bucket> <Bucket> <Name>east-2-11</Name> <CreationDate>2024-01-24T06:43:23.000Z</CreationDate> </Bucket> <Bucket> <Name>mulebucket1abc</Name> <CreationDate>2024-02-12T08:08:27.000Z</CreationDate> </Bucket> <Bucket> <Name>oicawsbucket</Name> <CreationDate>2024-02-15T12:19:06.000Z</CreationDate> </Bucket> <Bucket> <Name>oicbucketaws6thfeb</Name> <CreationDate>2024-02-09T11:32:52.000Z</CreationDate> </Bucket> <Bucket> <Name>sstestbucket10</Name> <CreationDate>2024-01-30T04:58:40.000Z</CreationDate> </Bucket> <Bucket> <Name>sstestbucket11</Name> <CreationDate>2024-01-30T05:16:19.000Z</CreationDate> </Bucket> <Bucket> <Name>sstestbucket13</Name> <CreationDate>2024-01-30T05:27:11.000Z</CreationDate> </Bucket> <Bucket> <Name>test2vijaya</Name> <CreationDate>2024-02-16T07:23:21.000Z</CreationDate> </Bucket> <Bucket> <Name>vijaya2000</Name> <CreationDate>2024-02-19T10:42:51.000Z</CreationDate> </Bucket> </Buckets> </ListAllMyBucketsResult>

Sample output:

 {
    "ListAllMyBucketsResult": {
        "Owner": {
            "ID": "77fd6d45133de29e6f96bf93a519ffcff023b726995f38e8100e7d95ff8fe501"
        },
        "Buckets": {
            "Bucket": [
                {
                    "Name": "ap-bucket-bcone",
                    "CreationDate": "2024-01-25T05:44:12.000Z"
                },
                {
                    "Name": "ap-bucket-bconevi",
                    "CreationDate": "2024-01-18T08:40:28.000Z"
                },
                {
                    "Name": "ap-bucket-bconevj",
                    "CreationDate": "2024-01-18T08:28:40.000Z"
                },
                {
                    "Name": "ap-bucket-bconevo",
                    "CreationDate": "2024-01-18T08:40:46.000Z"
                },
                {
                    "Name": "bconeb",
                    "CreationDate": "2024-01-08T14:48:21.000Z"
                },
                {
                    "Name": "bconebkt1",
                    "CreationDate": "2024-01-02T11:54:28.000Z"
                },
                {
                    "Name": "bconebuck16thjan",
                    "CreationDate": "2024-01-16T09:15:53.000Z"
                },
                {
                    "Name": "bconebuck18thjan",
                    "CreationDate": "2024-01-18T07:46:16.000Z"
                },
                {
                    "Name": "bconebucket",
                    "CreationDate": "2024-02-14T06:57:49.000Z"
                },
                {
                    "Name": "bconegbbucketab",
                    "CreationDate": "2024-02-21T11:40:35.000Z"
                },
                {
                    "Name": "bucket12feb",
                    "CreationDate": "2024-02-12T10:21:33.000Z"
                },
                {
                    "Name": "bucket23rdjan",
                    "CreationDate": "2024-01-23T05:10:29.000Z"
                },
                {
                    "Name": "bucket30thjan",
                    "CreationDate": "2024-01-30T05:39:54.000Z"
                },
                {
                    "Name": "bucket31stjan",
                    "CreationDate": "2024-01-31T05:37:53.000Z"
                },
                {
                    "Name": "demobucket2vj",
                    "CreationDate": "2024-02-13T08:21:30.000Z"
                },
                {
                    "Name": "demotest88",
                    "CreationDate": "2024-02-13T12:05:51.000Z"
                },
                {
                    "Name": "demotest89",
                    "CreationDate": "2024-02-21T11:43:54.000Z"
                },
                {
                    "Name": "east-2-11",
                    "CreationDate": "2024-01-24T06:43:23.000Z"
                },
                {
                    "Name": "mulebucket1abc",
                    "CreationDate": "2024-02-12T08:08:27.000Z"
                },
                {
                    "Name": "oicawsbucket",
                    "CreationDate": "2024-02-15T12:19:06.000Z"
                },
                {
                    "Name": "oicbucketaws6thfeb",
                    "CreationDate": "2024-02-09T11:32:52.000Z"
                },
                {
                    "Name": "sstestbucket10",
                    "CreationDate": "2024-01-30T04:58:40.000Z"
                },
                {
                    "Name": "sstestbucket11",
                    "CreationDate": "2024-01-30T05:16:19.000Z"
                },
                {
                    "Name": "sstestbucket13",
                    "CreationDate": "2024-01-30T05:27:11.000Z"
                },
                {
                    "Name": "test2vijaya",
                    "CreationDate": "2024-02-16T07:23:21.000Z"
                },
                {
                    "Name": "vijaya2000",
                    "CreationDate": "2024-02-19T10:42:51.000Z"
                }
            ]
        }
    }
}

Sample code:

"functions": [

{
            "name": "samplexmlToJsonFunc",
            "operation": "connectivity::sampleXmlToJson",
            "type": "custom"
          }

],

"states": [

 {

...

"actions": [

{
                "name": "SampleXMLToJSONConverstion",
                "functionRef": {
                  "refName": "samplexmlToJsonFunc",
                  "arguments": {
                    "XMLPayload": <String/JQ expression>
                  }
                },
                "actionDataFilter": {
                    "toStateData": <String/JQ expression>
                }
              }

]

connectivity::updateSecurityProperty

This function updates or adds a security property in the secret store.

Note:

This function is available only in the subscription register or unregister flow.

The input arguments for the function are described below. The output will be a Boolean true node if successful.

Key	Type	Description
`key`	Text node	The property key.
`value`	Text node	The property value.
`scope`	Text node (Optional)	The scope for the composite policy. The valid values are: inbound outbound Note: If the property is not present, check if it is present in the inbound scope. If present, it adds with inbound scope else adds as outbound scope.

Sample code: Unscoped property update


"functions": [
    {
        "name": "updateSecurityPropertyFn",
        "type": "custom",
        "operation": "connectivity::updateSecurityProperty"
    }
...

{
    "functionRef": {
        "refName": "updateSecurityPropertyFn",
        "arguments": {
            "name": "secret",
            "value": "${.configuration.value}"
        }
    },
    "actionDataFilter": {
        "toStateData": "${ .output }"
    }
}
//.output is set to Boolean(True or false)

Sample code: Scoped property update


"functions": [
    {
        "name": "updateSecurityPropertyFn",
        "type": "custom",
        "operation": "connectivity::updateSecurityProperty"
    }
]
....

{
    "functionRef": {
        "refName": "updateSecurityPropertyFn",
        "arguments": {
            "name": "signKey",
            "value": "${.configuration.value}",
            "scope": "inbound"
        }
    },
    "actionDataFilter": {
        "toStateData": "${ .output }"
    }
}
//.output is set to Boolean(True or false)

connectivity::getSecurityProperty

This function gets the security property value.

Note:

This function is available only in the subscription register or unregister flow.

The input arguments for the function are described below. The output will be a text value.

Key	Type	Description
`key`	Text node	The property key.
`scope`	Text node (Optional)	The scope for the composite policy. The valid values are: inbound outbound Note: If the property is not present, check if it is present in the outbound scope first, and then in the inbound scope.

Sample code: Fn declaration


{
  "name": "getSecurityPropertyFn",
  "type": "custom",
  "operation": "connectivity::getSecurityProperty"
}

Sample code: Unscoped Get


{
  "functionRef": {
    "refName": "getSecurityPropertyFn",
    "arguments": {
      "name": "secret"
    }
  },
  "actionDataFilter": {
    "toStateData": "${ .output }"
  }
}
...

{
  "functionRef": {
    "refName": "getSecurityPropertyFn",
    "arguments": {
      "name": "secret"
    }
  },
  "actionDataFilter": {
    "toStateData": "${ .output }"
  }
}
//.output is textNode with property value

Sample code: Scoped Get


{
  "functionRef": {
    "refName": "getSecurityPropertyFn",
    "arguments": {
      "name": "secret"
    }
  },
  "actionDataFilter": {
    "toStateData": "${ .output }"
  }
}
...

{
  "functionRef": {
    "refName": "getSecurityPropertyFn",
    "arguments": {
      "name": "secret",
      "scope": "inbound"
    }
  },
  "actionDataFilter": {
    "toStateData": "${ .output }"
  }
}
//.output is textNode with property value

connectivity::getPersistentState

This function gets a bag of persistent properties.

Note:

This function is allowed in polling init, polling, success, and error flows. To prevent multiple storage calls, it returns a bag of properties.

The function automatically derives the key from the flow context. The output is a JSON node, which is a bag of properties that you set.

Sample code:

"functions": [
  {
    "name": "getRTSessionPropsFn",
    "type": "custom",
    "operation": "connectivity::getPersistentState"
  }
],
"states":[
  {
    "name": "startState",
    "type": "operation",
    "actions": [
      {
        "functionRef": {
          "refName": "getRTSessionPropsFn"
        },
        "actionDataFilter": {
          "toStateData": "${ .output }"
        }
      }
    ],

connectivity::setPersistentState

This function sets a bag of persistent properties.

Note:

This function is restricted to polling init, success, and error flows. Only one usage of the function is allowed.

The input arguments for the function are described below. It automatically derives the key from the flow context.

Input Argument	Type	Description
`properties`	JSON node	Represents a bag of properties.

The output is a Boolean node indicating success or failure.

Sample code:

"functions": [
  {
    "name": "setRTSessionPropsFn",
    "type": "custom",
    "operation": "connectivity::setPersistentState"
  }
],
"states":[
  {
    "name": "startState",
    "type": "operation",
    "actions": [
      {
        "functionRef": {
          "refName": "setRTSessionPropsFn",
          "arguments": {
           "properties": "${.input}"
          }
        },
        "actionDataFilter": {
          "toStateData": "${ .output }"
        }
      }