Workflow Activities

Workflow Activities

Macros for Workflows

For a list and explanations of all the macros, go to Macros for Workflows.

 

Using the SmartBridge Workflow Studio

 

On this page

 

Activities grouped per topic

  1. A
  2. B
  3. C
  4. D
  5. E
  6. F-G
  7. H-J
  8. K-M
  9. N-Q
  10. R
  11. S
  12. T-U
  13. V-W
  14. X-Z

Tips for using the Activity pages

  • Each Activity has an 'All options' view, which allows you to see the complete list of Activity options.
  • If you have troubling finding an option in a table, try sorting the table alphabetically: Click on a column header to sort.
  • Many Activities contain extra information behind 'Read more' buttons. Click them open to learn more.

All Workflow Activities

Workflow ActivityWhat to use it forAvailable in SmartBridge version
AddDocumentContent

Add content from an external file to the current document in the Workflow.

2, 3
AddToCollection<T> 3
AnalyzeDocument

Instructs SmartBridge to analyze the document content based on defined document structures and to set the document properties according to the current document content.

all
AnonymousObjectAssign<T> 3
AnsiX12Envelope

Use AnsiX12Envelope to fix the envelope segments of a ANSI X12 document. It can also generate a unique interchange control number.

2, 3
Assign 3
AsyncExecute

Use to execute Activities that require a relatively large amount of time to finish.

3
ClearCollection<T> 3
CloneDocument

Creates a copy of the document and assigns a key to it, so that other Activities in the Workflow can process the clone.

all
ConvertToPdf

Creates a PDF representation of an XML document content, based on an XSLT which generates a formatted XML (XML-FO) representation of the original document content.

all
CopyContent

Creates a copy of the processed document content file(s) and place it in a specified folder. The rest of the Workflow Activities will try to retrieve the document content from the original folder.

all
CopyFileToAzureActivity for copying files to Microsoft Azure cloud storage.3
CopyFileToFolder

Use to copy a specific file to a specific folder.

3
CopyFileToS3Activity for copying files to Amazon S3 cloud storage.3
CorrelationScope 3

CreateAccountingEntry

CreateAccountingEntry is a TIE-specific Activity for our internal usage, used to be able to track data usage.

all
CreateDocumentForGroupMembers

If the document recipient is the owner of a group of partners, the Activity creates a clone of the document for each of the group members, and assigns that member as document recipient.

all
CreateDocumentFromContents

When a document has multiple content files, this activity is able to create new documents for each of these content files. To do further processing on the resulting documents, you need to use the “ReplicatorActivity” activity.

all
CreateFolder

Use to create a folder.

3
CreateInstance<T> 3
CreateMD5HashActivity to create a hash for a file or a string, using the MD5 algorithm.3
CreateSaltActivity to create a salt, a collection of random numbers that is used as an additional security measure for creating hashes.3
CreateSHA1HashActivity to create a hash for a file or a string, using the SHA1 algorithm.3
CreateSHA256HashActivity to create a hash for a file or a string, using the SHA256 algorithm.3
CreateSHA384HashActivity to create a hash for a file or a string, using the SHA384 algorithm.3
CreateSHA512HashActivity to create a hash for a file or a string, using the SHA512 algorithm.3

Decrement<T>

Use the Decrement<T> Activity in case you need a countdown in your Workflow.3
Delay (DelayActivity)

Introduces a specified delay in the processing of the document.

all
Decrement<T>Use in case you need a countdown in your Workflow.3
Delay (DelayActivity) all
DeleteFile

Use to delete a specific file.

3
DeleteFolder

Use to delete a folder.

3
DeleteFileFromAzureActivity for deleting files from Microsoft's Azure cloud storage.3
DeleteFileFromS3Activity for deleting files from Amazon's S3 cloud storage.3
DeleteMongoDBEntity<T> 3
DeserializeFromJSONFile<TResult>

Use to turn a JSON file into a data object.

3
DeserializeFromJSONString<TResult>

Use to turn an JSON string into a data object.

3
DeserializeFromXMLFile<TResult>

Use to turn an XML file into a data object.

3
DeserializeFromXMLString<TResult>

Use to turn an XML string into a data object.

3
DoWhile 3
DownloadFileFromAzureActivity for downloading files from Microsoft Azure cloud storage.3
DownloadFileFromS3

Activity for downloading files from Amazon's S3 cloud storage.

3
EdifactEnvelope

EdifactEnvelope can change the Interchange header data elements and update the Message and Interchange trailers.

all
ElseBranch 3
ElseIfBranch 3
EmailNotification

Instructs SmartBridge to deliver an e-mail notification to specified recipient(s).

all
ETCTranslation

Translates almost all EDI documents content to other formats. Use XlsToCsvTranslation or XSLTranslation for the remaining formats.

all
ExecuteBatch

Executes a command line batch, which is an external process that may be applied to the document’s content. Optionally, the generated file(s) can be used as document new document content for further processing.

all
ExecuteCsharpScript

Executes a C# script allowing non-standard processing of document attributes or of document content files.

Note: only for experienced implementers!

all
ExecuteLinqQuery<T> 3
ExecuteNonQueryUse a non-query to modify the content of a database, specifically to store, update, insert and delete data.3
ExecuteScalarQuery<T>Use to request a single column value from a specific table row (i.e. a cell value).3
ExistsInCollection<T> 3
ExposeDocument (deprecated)

Instructs SmartBridge to expose a document’s properties. When a property is exposed, you can use it as a condition for an IfElse Activity.

all
FinalStateFor developers. Use as Final State in the context of a State Machine.3
FindDuplicates

Use FindDuplicates when incoming documents could have duplicate envelope numbers. With FindDuplicates you can define what SmartBridge should do in case it runs into duplicate envelope numbers.

all
FindMongoDBEntries<T> 3
FindOneByIdMongoDBEntry<T> 3
FindOneMongoDBEntry<T> 3
Flowchart 3
FlowDecision 3
FlowSwitch<T> 3
ForEach<Document> 3
GetApplicationSetting<TResult>

Use to get one of the SmartBridge settings, for use further on in the Workflow.

3
GetMongoDBCollection<T> 3
GetRegistryKey<TResult>

Use to get a value from a registry key, for use further down the Workflow.

3
GetSqlQueryResultAsList<T> 3
GetSqlQueryResultAsRecordSetObjectUse a GetSqlQueryResultAsRecordSetObject to get a set of records from a database (i.e. a table), to use these records as objects.3
GetSqlQueryResultAsXmlUse to get data from a database, which you want to receive in XML format.3
GroupDocuments (deprecated)

Starts the aggregation (grouping) of the content of EDI documents specified as input for this activity.

all
HttpDeleteRequestUse the HttpDeleteRequest to ask a server to delete something.3
HttpGetRequestUse the HttpGetRequest to get data from the server you are interacting with.3
HttpHeadRequestUse the HttpHeadRequest to get metadata about a specific resource from the server you are interacting with.3
HttpOptionsRequestUse the HttpOptionsRequest to find out which types of requests are allowed by the server you are interacting with.3
HttpPostRequestUse the HttpPostRequest to send new data to the server you are interacting with.3
HttpPutRequestUse the HttpPutRequest to modify data on the server you are interacting with.3
IfBranch 3
IfElseActivity

Use when it depends on the circumstances in the Workflow which set of Activities need to be executed.

all
IfElseIf

Use when it depends on the circumstances in the Workflow which set of Activities need to be executed.

3
IfThen

Use the If Activity when it depends on the circumstances in the Workflow whether a single set of Activities needs to be executed.

3
Increment<T>Use the Increment<T> Activity in case you need a count in your Workflow.3
InitializeCorrelation 3
InnerRavenQuery<TResult> 3
InsertMongoDBEntry<t> 3
ListAzureContainersActivity for obtaining a list of containers on a Microsoft Azure cloud storage account.3
ListFileInAzureContainerActivity for listing all files in specific container on Microsoft Azure cloud storage.3
ListFiles

Use to obtain a list of files in a specific directory.

3
ListFilesAndFolders

Use to obtain a list of files and (sub)folders in a specific directory.

3
ListFilesInS3BucketActivity for listing all files in specific bucket on Amazon's S3 cloud storage.3
ListFolders

Use to obtain a (sub)folders in a specific directory.

3
ListS3BucketsActivity for obtaining a list of containers on an Amazon S3 cloud storage account.3
LoadExcelFile 3
ModifyInstance<T> 3
MoveFileUse to move a single file to a different location.3
OpenFileForReadingUse OpenFileForReading in case you want to process a text file line per line, so that each line becomes a single element that you can use further in the Workflow.3
OpenFileForWritingUse OpenFileForWriting to write content to a non-binary file, line per line.3
Parallel (ParallelActivity) (Parallel)

Runs a set of child activities at the same time. The ParallelActivity only finishes when all children are complete.

all
ParseDateTime 3
Pick 3
Pickbranch 3
Pointer 3
PutDocumentToFolder

Places the content of the processed document into the specified destination folder. The rest of the workflow activities will try to retrieve the document content from the specified folder.

all
RavenDelete 3
RavenDocumentSession 3
RavenLoad<TResult> 3
RavenQuery<TEntityType,TResult> 3
RavenSaveSession 3
RavenStore 3
ReadFromFile

Use to get the contents of a non-binary file, in a single operation.

3
Receive 3
ReceiveAndSendReply 3
RemoveFromCollection<T> 3
RenameContent

Changes the name of the content file to the specified value.

It is possible to use macros to specify document attributes as part of the file name.

all
RenderRazorTemplate<TModel> 3
ReplicatorActivity

The ReplicatorActivity repeats the same activities on each of the multiple documents received as input, similar to a “for each” statement in code.

Set “ReplicatorProcessingSequence“ as child activity and add the repetitive activities to the “ReplicatorProcessingSequence“.

  • 1, 2
  • 3: Replaced with ForEach
ReplicatorProcessingSequence

Contains the sequence of activities to be executed for each of the documents presented as input for the “ReplicatorActivity“.

  • 1, 2
  • 3: Replaced with ForEach
RepostAsNewDocument

Places the document back onto the messaging bus as a new document, allowing it to be processed beginning with document analyzing.

Note: only for experienced implementers!

all
ReprocessDocument

Instructs SmartBridge to reattempt processing of the document by reposting it to the system bus as a known document. The document will then be dispatched to another process configured in the system.

all
Rethrow 3
Retry 3
SaveAsNewExcelFile 3
SaveExcelFile 3
SaveMongoDBEntity<T> 3
Send 3
SendAndReceiveReply 3
SendDocument

Creates a send request for the document, so that it will be sent to its intended recipient once the next communication session begins.

all
Sequence 3
SerializeToJSONFile

Use to turn a data object into a JSON file.

3
SerializeToJSONString

Use to turn a data object into a JSON string.

3
SerializeToXMLFile

Use to turn a data object into an XML file.

3
SerializeToXMLString

Use to turn a data object into a XML string.

3
SetCommunicationAttributeSpecifies the value of a document Communication Attribute. For example, you can define the subject line for documents sent out using SMTP.all
SetDocumentData 3
SetDocumentProperties

Specifies new values for one or more document properties.

all
SetFileAttributesSetFileAttributes is an Activity to change or set the attributes of a file, such as whether the file is read-only, compressed, encrypted, hidden, etc.3
SetRegistryKeyUse to add settings to or modify settings in the registry.3
SignContent

The document content can be signed electronically using the information from a certificate file which contains also a private key.

It can be used for PDF and EDI documents.

all
SplitDocument

Generates a set of documents from an EDI interchange.

all
StateFor developers. Use as State in the context of a State Machine.3
StateMachineFor developers. Container Activity to build application-like functionalities using State diagrams.3
Switch<T> 3
TerminateWorkflow (TerminateActivity)

Use TerminateActivity in situations that require terminating the workflow. An example is to terminate when certain conditions apply (for example on an Else branch). TerminateActivity will produce an error message.

  • 1, 2
  • 3: See TerminateWorkflow
TerminateWorkflow 3
TextProcess

Allows text processing on the document content, like find and replace, insert or append strings in the document content.

all
Throw 3
TradacomsEnvelope

Use TradacomsEnvelope to fix the envelope segments of a TRADACOMS document. It can also generate a unique sender transmission reference.

all
TransactedReceiveScope 3
TryCatch 3
UnZip

UnZip is an Activity to unzip or decompress the contents of a zip file.

3
While 3
WriteLine 3
WriteToFile

Use to add content as a single chunk to a non-binary file, in a single operation.

3
WriteToLog

Use this activity to write entries to the service log.

2, 3
XlsToCsvTranslation

Use XlsToCsvTranslation to transform XLS documents to CSV documents.

3
XPathSelectNodes<TResult>Use to map a specific set of nodes in an XML file to a different set of nodes.3
XPathSelectingSingleNode<TResult>Use to map a specific node in an XML file to a specific target node.3
XSLTranslation

Translates an XML document using an XSL file.

all
Zip

Zip is an Activity to zip (compress) one or more files into one smaller file.

3