List of Available Activities
Activity groups in PlatformNx are collections of related activities. For example, the AWSStorage activity group contains all activities that enable you to work with AWS storage.
Here's a list of all available activities and activity groups:
HTTP Group
The HTTP group includes activities designed for managing HTTP-based communication, such as invoking APIs and handling webhook integrations. These activities enable seamless interaction with external services over HTTP protocols.
Rest Service
Used to configure and invoke REST APIs with flexible request and response handling.
Tab
Field
Required
Description
Config
Name
No
Unique identifier for the REST service.
Description
No
Optional description for context.
Path
Yes
Endpoint path for the REST service.
Method
Yes
HTTP method (GET, POST, etc.).
Media Types
Yes
Accepted media types for requests/responses.
Headers
Name
Yes
Header name for HTTP requests.
Default Value
Optional
Default value for the header.
Request
Optional
Specifies if the header is for requests.
Response
Optional
Specifies if the header is for responses.
Params
Name
Yes
Parameter name.
Default Value
Optional
Default value for the parameter.
Type
Optional
Data type of the parameter.
Required
Optional
Marks parameter as mandatory.
Output
Import Schema
No
Allows importing a schema for output.
REST Client
Facilitates sending HTTP requests to external services with custom configurations.
Tab
Field
Required
Description
Config
Name
No
REST client configuration name.
Description
No
Optional description for the REST client.
Scheme
Yes
Protocol type (HTTP/HTTPS).
URI
Yes
Full URI for the REST client.
Host
Yes
Hostname of the API server.
Port
Yes
Port number for the API server.
Method
Yes
HTTP method used by the client (GET, POST, etc.).
Headers
Name
Yes
Name of the HTTP header.
Default Value
Optional
Default value for the header.
Request
Optional
Specifies if the header is for requests.
Response
Optional
Specifies if the header is for responses.
Params
Name
Yes
Parameter name.
Default Value
Optional
Default parameter value.
Type
Optional
Data type of the parameter.
Required
Optional
Marks parameter as mandatory.
Auth
Auth Type
No
Authentication type (e.g., Basic, OAuth).
Input
Mapper
No
Input mapping configuration.
Anonymous Array
Optional
Toggle to map anonymous arrays.
Output
Import Schema
No
Allows importing a schema for output.
Webhook
Handles incoming HTTP requests triggered by external services or events.
Tab
Field
Required
Description
Config
Name
No
Webhook name.
Description
No
Webhook description.
Path
Yes
Webhook URL path.
Method
Yes
HTTP method (POST, GET, etc.).
Allowed Media Types
Yes
Accepted media types.
Headers
Name
Yes
Header name for HTTP requests.
Default Value
Optional
Default value for the header.
Webhook Signature
Encoding
Yes
Encoding for signature.
Algorithm
Yes
Signature algorithm.
Secret
Yes
Secret key for signing requests.
Signed Content Format
Optional
Format for signed content.
Output
Import Schema
Optional
Allows importing a schema for output.
Common Activities Group
The Common Activities group includes versatile tools for data manipulation, workflow control, logging, error handling, and general utilities. These activities support foundational workflow operations.
Response
Sends a response within a workflow for downstream systems or services.
Tab
Field
Required
Description
Config
Name
Yes
Name of the response activity.
Description
Optional
Optional description for context.
Stream
Optional
Enables response streaming.
Stream Resource
Optional
Specifies the resource for streaming.
Input
Mapper
Yes
Maps input values for the response.
Output
Import Schema
Optional
Allows importing a schema for response output.
UpdateWFVariable
Updates workflow variables dynamically during execution.
Tab
Field
Required
Description
Config
Name
Yes
Unique name for the workflow variable activity.
Description
Optional
Optional description for context.
Input
Mapper
Yes
Maps input values to update workflow variables.
Log
Logs messages to track workflow execution or debug issues.
Tab
Field
Required
Description
Config
Name
Yes
Name of the log activity.
Description
Optional
Optional description for clarity.
Log Level
Yes
Level of log severity (e.g., Debug, Info, Error).
Logger
Optional
Logger name or identifier for grouping logs.
GenerateError
Generates custom errors to handle unexpected situations in workflows.
Tab
Field
Required
Description
Config
Name
Yes
Name of the error-generating activity.
Description
Optional
Description of the error.
Error Code
Optional
Specifies the error code to generate.
Error Message
Optional
Custom message for the error.
Input
Mapper
Yes
Maps input values to provide error context.
Lookup
Fetches values from a predefined table based on input criteria.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the lookup activity.
Description
Optional
Optional description for the lookup.
Lookup Table
Yes
Name of the table to perform the lookup.
Workflow Loader
Optional
Specifies the workflow loader interaction.
Input
Mapper
Yes
Maps input values to lookup parameters.
Output
Import Schema
Optional
Allows importing schema for lookup results.
LookupUpsert
Performs insert or update operations in a lookup table.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the lookup upsert activity.
Description
Optional
Optional description for clarity.
Lookup Table
Yes
Table to perform the upsert operation.
Input
Mapper
Yes
Maps input values for upsert.
Output
Import Schema
Optional
Allows importing schema for upsert results.
Subflow
Executes another workflow as a sub-process, with optional waiting for completion.
Tab
Field
Required
Description
Config
Name
Yes
Name of the subflow activity.
Description
Optional
Optional description for clarity.
Subflow Path
Yes
Path to the subflow workflow.
Wait for Completion
Optional
Specifies whether to wait for subflow completion.
SendToEngage
Sends data to an Engage platform for further processing or tracking.
Tab
Field
Required
Description
Config
Name
Yes
Name of the SendToEngage activity.
Description
Optional
Optional description for clarity.
Workflow Context
Import Schema
Optional
Allows importing schema for engaging workflows.
Schedule
Automates execution based on time-based triggers.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the schedule activity.
Description
Optional
Optional description for the schedule.
Type
Yes
Type of schedule (e.g., Recurring, One-Time).
Start On
Yes
Start date for the schedule.
At Time
Yes
Time to start the schedule.
Run Interval
Yes
Interval for repeating the schedule.
Advanced
Date to End Schedule
Optional
Optional end date for the schedule.
Failure Threshold
Yes
Threshold for allowable failures.
Mapper
Maps and transforms data from one format to another.
Tab
Field
Required
Description
Config
Name
Yes
Name of the mapper activity.
Description
Optional
Description for the mapper.
Input
Mapper
Yes
Maps input values for transformation.
Output
Mapper
Yes
Specifies how transformed data is returned.
End
Marks the termination of a workflow.
Tab
Field
Required
Description
Config
Name
Yes
Name of the activity to end the workflow.
Description
Optional
Optional description for clarity.
Input
Mapper
Yes
Maps input values to finalize workflow outputs.
Azure Storage Group
S3Read
Reads files from an Amazon S3 bucket with options for encryption and compression.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the S3Read activity.
Description
Optional
Optional description of the activity.
Resource
Yes
AWS S3 connection resource.
Bucket Name
Yes
Name of the S3 bucket.
File Path
Yes
Path to the file within the bucket.
File Name
Optional
Name of the file to be read.
Encryption Type
Optional
Type of encryption used (e.g., NONE, SSE-S3).
Encryption Resource
Optional
Encryption key resource.
Compression Type
Optional
Compression format of the file (e.g., NONE, GZIP).
Content Type
Yes
Format of the file content (e.g., JSON, CSV).
Buffer Size
Optional
Size of the buffer for reading files, in bytes.
S3Write
Writes data to an S3 bucket with support for encryption, compression, and append options.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the S3Write activity.
Description
Optional
Optional description of the activity.
Resource
Yes
AWS S3 connection resource.
Bucket Name
Yes
Name of the S3 bucket.
File Path
Yes
Path where the file will be written in the bucket.
File Name
Yes
Name of the file to create or update.
Encryption Type
Optional
Type of encryption to apply (e.g., NONE, SSE-S3).
Encryption Resource
Optional
Encryption key resource.
Compression Type
Optional
Compression format for the file (e.g., NONE, GZIP).
Content Type
Yes
Format of the file content (e.g., JSON, CSV).
Create Directory
Optional
Creates the directory if it does not exist.
Append
Optional
Appends data to the file if enabled.
S3Delete
Deletes files from a specified Amazon S3 bucket.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the S3Delete activity.
Description
Optional
Optional description of the activity.
Resource
Yes
AWS S3 connection resource.
Bucket Name
Yes
Name of the S3 bucket.
File Path
Yes
Path to the file within the bucket.
File Name
Optional
Name of the file to be deleted.
S3List
Lists files in an Amazon S3 bucket with filtering and sorting options.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the S3List activity.
Description
Optional
Optional description of the activity.
Resource
Yes
AWS S3 connection resource.
Bucket Name
Yes
Name of the S3 bucket.
File Path
Optional
Path within the bucket to start listing files.
Pattern
Optional
Regex pattern to filter file names.
Prefix
Optional
Common prefix to filter files.
Max Results
Optional
Maximum number of files to return.
Recursive
Optional
Lists files recursively if enabled.
Descending
Optional
Sorts the file list in descending order if enabled.
Azure Storage Group
The Azure Storage group includes activities designed to interact with Azure Blob Storage, enabling efficient management of files and data within containers.
ABS Connection
ABS Connection is a resource that enables users to establish a secure and reliable connection between our platform and their Azure Blob Storage accounts. This connection serves as the foundation for accessing and manipulating blob data within workflows.
Field
Required
Description
Name
Yes
Name of the connection.
Auth Type
Yes
Authentication options for Azure Blob Storage: Access Key or SAS Token.
Account Name
Yes
Name of the Azure Storage account.
Account Key / SAS Token
Yes
Access key/token for the Azure Storage account.
Description
Optional
Description for the connection.
ABS Write
Writes data to Azure Blob Storage with options for creating or overwriting blobs.
Tab
Field
Required
Description
Config
Name
Yes
Unique identifier for the ABS Write activity.
Description
Optional
Optional description of the activity.
ABS Connection
Yes
Azure Blob Storage connection resource.
Container Name
Yes
Name of the container in Azure Blob Storage.
File Path
Yes
The path within the container where the blob is stored.
File Name
Yes
Name of the blob to create.
Encryption Type
Yes
The type of encryption (None, AES256, etc.).
Encryption Resource
Optional
Specifies an encryption key resource.
Content Type
Yes
Format for the blob (e.g., JSON, CSV).
Compression Type
Optional
Defines whether compression should be applied.
Create Container If Not Exists
Optional
Creates the container if it does not exist.
Append
Optional
If checked, data will be appended instead of overwriting.
Overwrite
Optional
If checked, existing files with the same name will be replaced.
ABS Read
Reads a blob from Azure Blob Storage.
Tab
Field
Required
Description
Config
ABS Connection
Yes
Drag the ABS Connection resource.
Container Name
Yes
Name of the container in Azure Blob Storage.
File Path
Yes
The path within the container for the blob.
File Name
Yes
Name of the blob.
Blob Type
Yes
The type of blob (Page, Block, Append).
Buffer Size
Optional
The buffer size for reading the file. Default: 4096 bytes.
ABS List
Lists all blobs present in Azure Blob Storage.
Tab
Field
Required
Description
Config
ABS Connection
Yes
Select Azure Storage Account.
Container Name
Yes
Name of the container in Azure Blob Storage.
Path
Yes
The path within the container.
Prefix
Optional
Prefix to filter blobs within the container.
Pattern
Optional
Filters files based on a pattern (e.g., *.csv).
Max Result
Yes
Limits the number of files returned.
Recursive
Optional
Includes subdirectories inside the specified path.
Descending
Optional
Lists files in descending order (newest first).
ABS Delete
Deletes a blob from Azure Blob Storage.
Tab
Field
Required
Description
Config
ABS Connection
Yes
Drag the ABS Connection resource of source.
Container Name
Yes
Name of the container in Azure Blob Storage.
File Path
Yes
The path within the container.
File Name
Yes
Name of the blob to delete.
CSV Group
The CSV Group focuses on operations involving CSV files, enabling workflows to read structured data for processing and transformation.
CSVReader
Reads and parses data from CSV files to enable further processing within workflows.
Tab
Field
Required
Description
Config
Name
Yes
Name of the CSV Reader activity.
Description
Optional
Optional description for the activity.
Source Definition
Optional
Defines the source structure for CSV.
Data Source
Yes
Path or location of the CSV file to read.
Input
Mapper
Yes
Maps input data for reading the CSV file.
Output
Import Schema
Optional
Allows importing a schema for CSV output.
File Group
The File Group includes activities for reading and writing streams, offering flexibility to handle files, databases, or other data sources.
ReadStream
Reads data from a specified stream for processing or analysis.
Tab
Field
Required
Description
Config
Name
Yes
Name of the ReadStream activity.
Description
Optional
Optional description for clarity.
Stream Type
Yes
Type of stream (e.g., File, Database).
Stream Connection
Yes
Connection resource for the stream.
File Path
Optional
Path to the file to read.
File Name
Optional
Name of the file to read.
Read All
Optional
Reads all data in the stream.
Multiline
Optional
Reads multiline data if enabled.
Advanced
Format Type
Yes
Format for parsing the data.
Formatter Config
Yes
Configuration for parsing data.
Input
Mapper
Yes
Maps input values for reading.
Output
Import Schema
Optional
Allows importing schema for output data.
WriteStream
Writes data to a specified stream with options for formatting and appending.
Tab
Field
Required
Description
Config
Name
Yes
Name of the WriteStream activity.
Description
Optional
Optional description for clarity.
Stream Type
Yes
Type of stream (e.g., File, Database).
Stream Connection
Yes
Connection resource for the stream.
File Path
Optional
Path to the file to write.
File Name
Optional
Name of the file to write.
Append If Exists
Optional
Appends data to the file if it exists.
Create If Not Exists
Optional
Creates the file if it does not exist.
Advanced
Format Type
Yes
Format for the data (e.g., JSON, CSV).
Formatter Config
Yes
Configuration for formatting data.
Input
Mapper
Yes
Maps input data for writing.
Output
Import Schema
Optional
Allows importing schema for output data.
CopyFile
The CopyFile activity enables you to copy files from a specified source resource to a designated target resource.
Tab Details
Configuration
Name
Yes
Unique identifier for the CopyFile activity.
Configuration
Description
No
Optional description to provide context about the activity.
Configuration
Source Resource
Yes
Resource connection where the source file is located.
Configuration
Source File Path
Yes
Path of the directory containing the file to be copied.
Configuration
Source File Name
Yes
Name of the file to be copied.
Configuration
Target Resource
Yes
Resource connection where the file will be copied to.
Configuration
Target File Path
Yes
Path of the destination directory.
Configuration
Target File Name
Yes
Desired name of the copied file at the target location.
Configuration
Move
No
Enable to delete the source file after a successful copy.
Configuration
Overwrite
No
Enable to overwrite existing files at the target location.
Configuration
Create Directory
No
Automatically creates the target directory if it doesn't exist.
Input
Dynamic Inputs
Optional
Define dynamic values or parameters for source and target locations, if applicable.
Output
File Details
Automatic
Provides details about the copied file, such as status and file information, upon completion of the activity.
Batch Group
Batch activity group enables efficient handling of large datasets, tracking progress, and ensuring data integrity across workflow
InitBatch
Creates a new batch or reuses an existing one. Supports TTL.
Config
Name
Yes
Unique identifier for the InitBatch activity.
Description
Optional
Optional description of the activity.
Batch ID
Optional
Identifier for the batch (if reusing).
TTL
Optional
Time-to-live for the batch (in seconds).
Use Batch If Exist
Optional
If checked, an existing batch will be reused.
AddToBatch
Adds records to a batch using Batch ID.
Config
Name
Yes
Unique identifier for the AddToBatch activity.
Description
Optional
Optional description of the activity.
Batch ID
Yes
Identifier for the batch to add records to.
BatchStatus
Retrieves the batch’s current status.
Config
Name
Yes
Unique identifier for the BatchStatus activity.
Description
Optional
Optional description of the activity.
Batch ID
Yes
Identifier for the batch to check status.
DeleteBatch
Deletes a batch by Batch ID.
Config
Name
Yes
Unique identifier for the DeleteBatch activity.
Description
Optional
Optional description of the activity.
Batch ID
Yes
Identifier for the batch to delete.
RecordProcessed
Marks a record as processed in the batch.
Config
Name
Yes
Unique identifier for the RecordProcessed activity.
Description
Optional
Optional description of the activity.
Batch ID
Yes
Identifier for the batch where the record exists.
Integration Patterns
The Integration Patterns Group enables reliable messaging between distributed components. It includes ReceiveMessage for consuming messages and SendMessage for publishing messages to queues or topics.
ReceiveMessage
Receives messages from a messaging queue or topic.
Config
Name
Yes
Unique identifier for the ReceiveMessage activity.
Description
Optional
Optional description of the activity.
Channel Type
Yes
Type of messaging channel (Queue, Topic).
Channel Name
Yes
Name of the queue or topic to receive messages from.
Advanced
On Error
Yes
Defines how to handle errors (e.g., Discard, Retry).
Redelivery Attempts
Optional
Number of times to retry message delivery.
Max Message Rate
Yes
Maximum number of messages received per second.
Max Unprocessed Messages
Yes
Maximum number of messages to keep unprocessed.
Max Failed Messages
Yes
Maximum number of failed messages before stopping.
Reset Timeout
Optional
Time before resetting the connection (seconds).
Properties
Custom Properties
Optional
Additional properties that can be attached to messages.
SendMessage
Sends messages to a messaging queue or topic.
Config
Name
Yes
Unique identifier for the SendMessage activity.
Description
Optional
Optional description of the activity.
Channel Type
Yes
Type of messaging channel (Queue, Topic).
Channel Name
Yes
Name of the queue or topic to send messages to.
Properties
Custom Properties
Optional
Additional properties that can be attached to messages.
SFTP Group
Here are the configuration tables for the SFTP Group:
ReadSFTPFile
Reads a file from an SFTP server.
Config
Name
Yes
Unique identifier for the ReadSFTPFile activity.
Description
Optional
Optional description of the activity.
Resource
Yes
SFTP connection resource.
File Path
Yes
The full path of the file to be read.
Directory
Optional
Directory where the file is located.
File Name
Optional
Name of the file to be read.
Content Type
Yes
Format of the file (e.g., JSON, CSV, XML).
Encryption Type
Optional
Type of encryption (e.g., AES256).
Compression Type
Optional
Compression method (e.g., NONE, ZIP).
Buffer Size
Optional
Defines the buffer size for reading the file.
WriteSFTPFile
Writes a file to an SFTP server with options for creating directories and overwriting files.
Config
Name
Yes
Unique identifier for the WriteSFTPFile activity.
Description
Optional
Optional description of the activity.
Resource
Yes
SFTP connection resource.
File Path
Yes
The full path where the file will be written.
Directory
Optional
Directory where the file should be stored.
File Name
Yes
Name of the file to be created.
Content Type
Yes
Format of the file (e.g., JSON, CSV, XML).
Compression Type
Optional
Compression method (e.g., NONE, ZIP).
Encryption Type
Optional
Type of encryption (e.g., AES256).
Create Directory If Not Exists
Optional
Creates the directory if it does not exist.
Append
Optional
If checked, data will be appended to the file.
Overwrite
Optional
If checked, existing files will be replaced.
ListSFTPFile
Lists files available in an SFTP server directory.
Config
Name
Yes
Unique identifier for the ListSFTPFile activity.
Description
Optional
Optional description of the activity.
Resource
Yes
SFTP connection resource.
File Path
Yes
Path to the directory on the SFTP server.
Directory
Optional
Directory location to search.
Prefix
Optional
Filters files based on a prefix.
Pattern
Optional
Filters files based on a pattern (e.g., *.csv).
Max Results
Optional
Limits the number of results returned.
Recursive
Optional
Searches within subdirectories.
Descending
Optional
Returns files in descending order (newest first).
DeleteSFTPFile
Deletes a specified file from an SFTP server.
Config
Name
Yes
Unique identifier for the DeleteSFTPFile activity.
Description
Optional
Optional description of the activity.
Resource
Yes
SFTP connection resource.
File Path
Yes
Full path to the file to be deleted.
Directory
Optional
Directory where the file is located.
File Name
Yes
Name of the file to be deleted.
Format Group
CSV Formatter
Configuration
Name
Yes
Unique name for the CSV Formatter component.
Configuration
Description
No
Optional description of the formatter.
Configuration
Column Definitions
No
Allows defining column mapping with keys, types, and default values.
Advanced
Start Row
No
Defines the row from which parsing should begin.
Advanced
Quote Char
No
Character used for quoting fields (e.g., double quotes).
Advanced
Column Separator
No
Specifies the delimiter used in the CSV (e.g., comma, semicolon).
Advanced
Array Element Separator
No
Defines the separator for array elements.
Advanced
Line Separator
No
Defines how lines are separated (e.g., Line Feed \n).
Advanced
Null Value
No
Defines how null values should be represented.
Advanced
Has Header
No
Specifies whether the first row is treated as a header.
Advanced
Skip First Data Row
No
Skips the first data row when parsing.
Advanced
Strict Headers
No
Enforces strict column matching.
XML to JSON Formatter
Configuration
Name
Yes
Unique identifier for the XML to JSON formatter.
Configuration
Description
No
Optional description of the formatter.
Configuration
Field Name Separator
No
Defines the separator used in field names.
Configuration
Value Field Name
No
Specifies the field name used for text values inside XML elements.
Configuration
Whitespace Handling
No
Defines how whitespace is handled (Trim, Preserve).
Configuration
Skip Element Values
No
Option to ignore element values and only keep attributes.
Configuration
Text As Value
No
Stores element text content as the main value instead of a nested object.
Configuration
Attributes As Fields
No
Converts XML attributes into JSON fields.
Configuration
Skip Attributes
No
Ignores XML attributes when converting.
Advanced Options
Strip Levels
No
Removes a specified number of XML levels before conversion.
Advanced Options
Attribute Prefix
No
Defines a prefix for XML attributes in JSON.
Advanced Options
Naming Convention
No
Specifies how element names are converted (Preserve, CamelCase, etc.).
Advanced Options
Attribute Handling
No
Determines how attributes are stored (e.g., prefixing them).
Advanced Options
Include Nodes
No
Filters specific XML nodes to be included in conversion.
Advanced Options
Exclude Nodes
No
Filters specific XML nodes to be excluded from conversion.
Advanced Options
Force Array Paths
No
Ensures specific XML elements are converted as arrays.
Last updated
Was this helpful?