Flow services

Use Flow services to encapsulate a sequence of services within a single service and manage the flow of data among them, and create complex, advanced integration scenarios involving multiple application endpoints.

Flow services provide you with rich data mapping capabilities, a familiar debugging mechanism, a large collection of built-in services, and more.

Overview

IBM webMethods Integration offers various features that enables you to automate tasks based on specific requirements. However, there are some scenarios where you want to create complex integrations that require advanced data transformation and custom logic implementation. Earlier you could do this by switching to the Flow Editor using the App Switcher and create the required integrations in the Flow Editor.

We have simplified this process by providing you with flow services directly in your IBM webMethods Integration project, thus eliminating the need to access the Flow Editor through the App Switcher. With flow services, you can encapsulate a sequence of services within a single service and manage the flow of data among them, and create complex, advanced integration scenarios involving multiple application endpoints.

In the Flow Editor, you used a graphical drag and drop tool to create integrations. You set up your integrations by plugging blocks together in the workspace and coding concepts were represented as interlocking blocks.

In flow services, you can easily build a flow service by adding steps and selecting the constructs including Connectors, Controls, flow services, and Services from within the steps. The editor is visually enhanced to offer ease of use and is more interactive.

A flow service step is a basic unit of work that IBM webMethods Integration interprets and runs at run time. The steps are the building blocks of a flow service and are shown as rectangular blocks prefixed with step numbers. Steps may be compared to an actual implementation of a service in a programming language, where the business logic or the algorithm is written. IBM webMethods Integration lists steps sequentially from top to bottom and also runs them in that order.

You can simultaneously open five flow services in different tabs in a browser.

Comparing Workflows and Flow services

Workflows and flow services enable you to automate and optimize monotonous tasks based on a set of predefined rules and business logic. These features give you the power to connect apps, devices, and on-premises systems with only clicks and zero code. Although workflows and flow services help you to accomplish the same goal, there are significant differences between both the features.

The following table showcases the differences between workflows and flow services.

Workflows Flow Services
Designed for Citizen developers. No code. Designed for Integration specialists. Low code.
Offers a visual, drag and drop interface to create business use cases. Offers steps and constructs from within the steps to create business use cases.
Offers in-built triggers to automatically trigger workflows when relevant events occur and actions to perform specific tasks. Offers in-built applications and services to perform specific tasks.
Supports executing other flow services and workflows from within a workflow. Supports executing other flow services from within a flow service.
Ideal for scenarios where basic data transformation on application data is required. This means you can execute simple business use cases with workflows. Ideal for scenarios where complex integrations and advanced data transformation are required. This means you can execute simple as well as complex business use cases with flow services.

Migrating Flow Editor Integrations to Flow services

If you are an existing customer and have created integrations in the Flow Editor, you can migrate those integrations to Flow services in IBM webMethods Integration using the Migrate Integrations functionality. You can migrate integrations from a Flow Editor project to the same project in flow services.

How it works

  1. In IBM webMethods Integration, ensure that you have the Developer and Admin roles assigned from the Settings > Roles page.

  2. In IBM webMethods Integration, select the project where you want to migrate the Flow Editor integrations and click the Flow services tab. IBM webMethods Integration displays the number of integrations available for migration.

  3. Click Migrate Integrations.

A dialog box appears displaying the list of integrations that will be migrated. Click OK to continue.

A dialog box appears showing the migration results. Click OK.

All integrations available in the Flow Editor project are migrated and available in Flow services in case of a successful migration. In case of any errors, it is recommended to recreate those integrations in Flow services.

Note
  • After you migrate the integrations, you will not be able to open or edit the same integrations in the Flow Editor.
  • If a Flow Editor integration refers to another integration, both the integrations will be migrated.
  • After migrating flow services, if the pipeline variables used in if or elseif blocks are dropped, the else block will not work properly. In such cases, update the migrated flow service from the user interface and save it.

Core elements, constructs, and components of Flow services

Let us see the core elements, constructs, and components that are used to create and run a flow service.

On the new flow service page, click on the rectangular box as shown below.

By default, the left panel lists the recently used Connectors, Controls, Project services, and Built-in services.

You can type a keyword in the rectangular box and search for the available elements. IBM webMethods Integration filters the data based on what you type in the search box.

Click All to view the categories available on the right panel, which you can use to build the Flow service.

Categories

Displays the following categories:

Connectors

Displays the connectors available to create the Flow service.

Connectors are grouped in the following categories on the flow services panel.

Predefined Connectors

Predefined and configurable connectors. These connectors allow you to connect to the SaaS providers.

Note
A few connectors are deprecated in this release. A deprecated connector displays the Deprecated label just below the connector where ever it appears in the user interface. Deprecated connectors will continue to work as before and are fully supported by IBM. If you are using deprecated connectors in your existing Workflows and/or flow services, they will work as expected. No new feature enhancements will be made for deprecated connectors. If you are creating new Workflows or flow services, it is recommended to use the provided alternative connectors instead of the deprecated connectors. The deprecation is applicable only for Actions. The deprecation is not applicable for Triggers, that is, Triggers are supported for both deprecated and alternative connectors. For the list of triggers, see the documentation for alternative connectors.

REST Connectors

You can define REST Resources and Methods and create custom REST connectors. You can invoke a REST API in a flow service by using a REST connector.

SOAP Connectors

Displays custom SOAP connectors. Custom SOAP connectors enable you to access third party web services hosted in the cloud or on-premises environment. You can also invoke a SOAP API in a flow service by using a SOAP connector.

On-Premises Connectors

On-Premises applications uploaded from on-premises systems.

Flat File Connectors

Displays the Flat File connectors created either manually or from a sample file.

Controls

Controls are the programming constructs in a flow service. This allows you to run a specified sequence based on a field value, try a set of steps, and catch and handle failures. The panel displays conditional expressions, looping structures, and transform pipeline. Conditional expressions perform different computations or actions depending on whether a specified boolean condition evaluates to true or false.

Sequence

Use the Sequence step to build a set of steps that you want to treat as a group. Steps in a group are run in order, one after another.

Conditional Controls

Loops

Loops run a set of steps multiple times based on the block you have chosen. It repeats a sequence of child steps once for each element in an array that you specify. For example, if your pipeline contains an array of purchase-order line items, you could use a Loop to process each line item in the array. Loop requires you to specify an input array that contains the individual elements that are used as input to one or more steps in the Loop. At run time, the Loop runs one pass of the loop for each member in the specified array. For example, if you want to run a Loop for each line item stored in a purchase order, you would use the document list in which the order’s line items are stored as the Loop’s input array.

A Loop takes as input an array field that is in the pipeline. It loops over the members of an input array, executing its child steps each time through the loop. For example, if you have a flow service that takes a string as input and a string list in the pipeline, use Loops to invoke the flow service one time for each string in the string list. You identify a single array field to use as input when you set the properties for the Loop. You can also designate a single field for the output. Loop collects an output value each time it runs through the loop and creates an output array that contains the collected output values.

Note
In case of an infinite loop, there is a default timeout configured in IBM webMethods Integration. If the time taken for execution exceeds this limit, the flow service execution is terminated. Contact your administrator for customizing the default timeout.

Error Handling

Exit

This step exits the entire flow service and signals success or failure as part of the exit.

Switch, Case

Switch allows a variable to be tested for equality against a list of values. Each value is called a case, and the variable being switched on is checked for each case, that is, Switch evaluates a variable and skips to the value that matches the case. For example, if the Switch variable evaluates as “A”, then case “A” is run.

A switch statement can have an optional default case, which must appear at the end of the switch. The default case can be used for performing a task when none of the cases are true. You cannot insert multiple default statements.

You can include case steps that match null or empty switch values. A switch value is considered to be null if the variable does not exist in the pipeline or is explicitly set to null. A switch value is considered to be an empty string if the variable exists in the pipeline but its value is a zero length string. Switch runs the first case that matches the value, and exits the block.

Branch

Branch is a conditional execution of steps and constitutes a group of expressions. Within a Branch, IBM webMethods Integration runs the first expression that evaluates to true. Expressions are the conditions on the pipeline variables.

At run time, Branch evaluates the conditions provided and runs the first expression whose condition is evaluated to true. If none of the expressions are true, the default expression if included, is run.

The following figure is the default template of a Branch construct.

If you want to perform different actions on different values of one or more pipeline variables, use the Branch construct. In the following example, action is a pipeline variable created using the Define input and output fields dialog box.

The Branch contains two conditional expressions and a default expression.

Scenario 1

If the value of action starts with mult, IBM webMethods Integration evaluates the first expression (action = /^mult/) and runs step 3, that is, performs the multiplication operation.

Scenario 2

If the value of action is addition (action == “addition”), then the Branch starts its execution from step 2. As step 2 is evaluated to false, the execution moves to the next expression, that is, step 4. Step 4 is evaluated to true, hence step 5 is run, that is, the addition operation is performed. Remaining expressions in the Branch, if any, are ignored and the execution falls through to the next step after the Branch in the flow service.

Scenario 3

Let us assume that the value of action is subtraction. The Branch then starts its execution from step 2. As IBM webMethods Integration evaluates step 2 to false, the execution moves to the next expression, that is, step 4. IBM webMethods Integration evaluates Step 4 to false, hence evaluates step 6 ($default), that is, runs step 7, which makes the execution exit the flow service.

Note
  • If you are specifying a field in a document or in a document reference, format it as document/documentVariable. For example, if you want to specify a field name, from the document employeeProfile, then format it as employeeProfile/name.

  • If you specify a literal value in an expression, the value you specify must exactly match the run-time value of the pipeline variable. Further, the value must be case sensitive.

  • IBM webMethods Integration runs only the first target step whose expression evaluates to true. If none of the expressions evaluate to true, none of the child steps are invoked, and the execution falls through to the next step in the flow service, if there is no default expression.

  • If you want to prevent the execution from falling through a Branch step when an unmatched value occurs at run time, include a default target step to handle unmatched cases. Branch can have zero to many default expressions. IBM webMethods Integration runs the first sequentially encountered default expression.

  • The default step does not need to be the last step of a Branch but IBM webMethods Integration always evaluates the default step at the end.

Any step other than an expression cannot be a direct child of a Branch step. Further, you cannot add the expression step anywhere outside a Branch. If you are branching on expressions, ensure that the expressions you assign to the target steps are mutually exclusive. In addition, do not use null or empty values when branching on expressions. IBM webMethods Integration ignores such expressions and does not display any errors. You can provide multiple conditions for each expression and can also use regular expressions, for example, /^mult/. The expressions you create can also specify a range of values for the variables.

Specify the value of the variables in the expressions, as mentioned in the following table:

To Match… Specify…
That exact string A string
The string representation of the object’s value.
Example for Boolean object: true
Example for Integer object: 123
A constrained object value
Any string matching the criteria specified by the regular expression.
Example: /^REL/
A regular expression
An empty string A blank field
A null value $null
Any unmatched value (that is, run the step if the value does not match any other label) $default

Transform Pipeline

As systems rarely produce data in the exact format that the other systems need, at times you need to transform data in terms of format, structure, or values of data. Using the Transform Pipeline control in the flow service you can do transformations on data in the Pipeline.

You can insert multiple transformers in a single Transform Pipeline step, to perform multiple data transformations. When multiple transformers are added, the Transform Pipeline step behavior is as follows:

Consequently, the output of one transformer cannot be used as the input to another transform. These characteristics make the Transform Pipeline step different than that of a normal step in a flow service.

Inserting a Transform Pipeline Step in a Flow service

  1. Create a flow service. A flow service step is created initially without any data.

  2. Select Transform Pipeline from the step drop-down list. The Transform Pipeline step is added.

Adding Transformers

  1. Create a flow service. A flow service step is created initially without any data.

  2. Select Transform Pipeline from the step drop-down list.

  3. Click on the flow service step. The Pipeline panel appears.

  4. Click on the Transformers column header. The Select Transformer step is added under the Transformers column.

  5. Select the function from Select Transformer. The input field values are modified based on the selected transformer.

Mapping Pipeline Fields to Transformer Fields

The pipeline fields can be mapped to the service fields of the transformers added.

  1. Go to the Transformer step (for which the transformers have been added) in the Pipeline panel.

  2. Click in the Transformer step. The fields are displayed.

  3. Link the fields as per your requirements.

Note
  • At a time, only one transformer can be expanded. On collapsing, all the existing transformers are visible.
  • You can delete a transformer using the delete icon against each transformer. If a transformer is deleted, the mappings made to its service fields will also be deleted.

Mapping Fields Directly

The Pipeline Input fields can be directly mapped to any of the Pipeline Output fields. This is known as Direct Mapping.

Example

Let’s see how transformers work with the help of an example. In the below example, we will transform the case of a string field label to upper case.

1.Provide a name and description of the new flow service and click the I/O icon.

2.Define an input field Currency Code and click Done.

3.Select Transform Pipeline.

4.Click the pipeline mapping icon and open the pipeline mapping window.

5.On the pipeline mapping window, click the Add New Transformer option.

The Select Transformer panel appears.

6.Click ALL on the transformer panel.

Note
  • You must specify the pipeline input and output variables in the corresponding flow when invoking a flow service in the transform step to ensure visibility of the signature.

  • You cannot use the Controls category within a flow service transform step.

7.Select the toupper service.

8.Click the Expand icon.

9.Map Currency Code to inString and value to Currency Code.

10.Save the flow service and run it. In the Input values dialog box, type usd as the Currency Code.

11.Click Run on the Input values dialog box. The transformer converts the string field usd in lowercase to uppercase.

Note
You can delete a transformer by clicking the delete icon against each transformer. If a transformer is deleted, the mappings made to the service variables are also deleted.

Project Services

Displays the flow services available in the selected project. This enables you to invoke other flow services from the current flow service. The input and output of the referred flow service must be accordingly mapped for a successful execution.

Built-in Services

Displays the service categories. An extensive library of built-in services is available for performing common tasks such as transforming data values, performing simple mathematical operations, and so on.

Service input and output parameters are the names and types of fields that the service requires as input and generates as output and these parameters are collectively referred to as a signature.

Note
Related services are grouped in categories. Click here for information on the service categories, and input parameters, output parameters, and usage notes if any for each service.

Tasks associated with Flow Services

You can perform the following tasks for flow services by clicking the icons available on the flow services panel.

Icons Task/Description
Provide a flow service name and description. The asterisk denotes that the flow service is modified.
Search for text in the flow service, inside the editor, and within the steps.
Debug a flow service and inspect the data flow during the debugging session. For more information, see Debug Flow services.
Run the flow service after you save it. This enables you to test the flow service execution in real time and view the test results.
View the runtime log entries for a selected runtime directly within the Flow Editor.
Define the input and output fields of a flow service. For more information, see Input and Output Fields Declaration.
This option allows you to log business data at the flow service level. You need to first click the I/O icon and define the input and output fields. Then click the Log business data icon and select the defined fields in the Log business data dialog box.
You can choose whether you want to log business data only when errors occur On Failure, or choose Always to always log business data. The default setting is On Failure.
When selecting fields for logging, you can specify the same display name for more than one field, but this is not recommended. Having the same display name might make monitoring the fields at run time difficult.
The business data log appears in the Execution Details page under Business Data.
For more information, see Log Business Data.
Click the Navigator icon to view a summary of the flow service steps, which appear on the right panel. Move the slider available on the navigator panel to move through the flow service. If you move through the main flow service page, the navigator view will automatically move. You can click on a navigator step to go to that step in the flow service.
Click the Default mode to view more spacious, visual representation of the integration flow. Each step or action is displayed with ample space around it, making it easier to visualize and interact with each element.
Click the Compact mode option to display actions and steps in a more condensed format. This mode minimizes the space between elements, allowing more steps to be visible on the screen without scrolling.
Press Ctrl and select a step or multiple steps in the flow service. Then click the delete step(s) icon to delete the selected step or multiple steps in the flow service. You can also delete steps by right-clicking on a step on the flow service editor and selecting the delete option.
Press Ctrl and select a step or multiple steps in the flow service. Then click the move step(s) icon and select the move steps up, down, right, or left options.
You can also move steps by right-clicking on a step on the flow service editor and selecting the available options.
Cut, Copy, Paste, Duplicate, Enable, and Disable steps in the flow service.
You can also right-click on a step on the flow service editor and add a step or a child step for the selected step, cut, copy, and paste steps, copy the selected step(s) and paste the step(s) after the selected step(s) by clicking Duplicate, delete a step, and move steps up, down, right, or left.

Note
You can perform cut, copy, and paste actions within the same flow service or another flow service in the same project. However, if you perform these actions from one flow service to another in a different project, you might encounter deployment errors.
Undo a step action.
Redo a step action.
Whenever you save a flow service, a newer version is added to the Version History with the default commit message. You can also provide a custom commit message by clicking the drop-down arrow beside the Save option and selecting Save with message.
- Whenever you save a flow service, a newer version is added to the Version History with the default commit message. You can also provide a custom commit message by clicking the drop-down arrow beside the Source Control option and selecting Save with message.
-Version History: View the version commit history of the flow service.
Access Help topics or take a tour.
The following options are available:
- Schedule: Define a schedule for the flow service execution. Select Once if you want to schedule the flow service to run just once immediately or run once at a specified date and time.
- Select Recurring if you want to define a recurrence pattern. You can define a recurrence pattern daily, weekly, monthly, and in hours. Select the frequency (Hourly, Daily, Weekly, Monthly) with which the pattern recurs, and then select the options for the frequency. Click the + icon to repeat the execution for daily, weekly, and monthly schedules. Click the delete icon to delete the selected execution time for daily, weekly, and monthly schedules.
- Select Prevent concurrent executions option to skip the next scheduled execution if the previous scheduled execution is still running, except when the previous scheduled execution is running for more than 60 minutes (default). In this case, the next scheduled execution starts even if the previous scheduled execution is running. IBM support if you want to change the 60 minutes default value. If you do not select the Prevent concurrent executions option, the next scheduled execution starts, even if the previous scheduled execution has not yet completed. In the Input Value Set panel, provide inputs to the flow service based on the defined input signature. Click Delete if you want to permanently remove the current recurrence schedule.
Note
Any time stamp displayed in IBM webMethods Integration is based on the time zone you have specified in IBM webMethods iPaaS. All time zones available in IBM webMethods iPaaS are currently not supported in IBM webMethods Integration. If a time zone in IBM webMethods iPaaS is not supported, then the time stamp in IBM webMethods Integration defaults to the Pacific Standard Time (PST) time zone.
You can pause a flow service execution that was scheduled by clicking the Pause option on the Overview page of a flow service.
- Key Shortcuts: View keyboard shortcut keys.
Note
Occasionally, there may be instances where keyboard shortcuts in the Flow Editor coincide with those of the browser. If this occurs, it is advisable to avoid using the shortcuts and instead follow the regular methods to access the editor.

- Execution History: View successful and failed flow service executions, operations, and business data logs.
- Version History: View the version commit history of the flow service.
An account is linked and configured.
Note: For a migrated or imported flow service, the step-level validation might show that the account is not configured. This means that the steps are linked to an account alias but the account does not exist. In such a case, you can create the account inline and refresh the page, or you can go to the Connectors page and create the account with the same name as the alias.
An account is not linked.
A red circle on a step may appear for many error scenarios, for example, if an account is not configured, or the associated action is not selected, or for any invalid constructs.
Map or edit existing pipeline mappings.
Click the ellipsis icon and perform the following tasks:
- Comment: Add a note for the selected step.
- Disable: Disable or deactivate a step. You can enable the step by clicking the enable step icon . You can cut, copy, or delete a step after you disable it.
- Log business data: This option allows you to log business data at the step level.
Note: At the step level, the Log business data option is enabled only for connectors.
In the Log business data dialog box, choose whether you want to log business data only when errors occur On Failure, or choose Always to always log business data. The default setting is On Failure. Expand the Input Fields and Output Fields trees to display the fields available in the signature, and select the check boxes next to the fields you want to log. If you want to define a display name for a field, type the display name beside the field. The display name defaults to the name of the selected field, but it can be modified. When selecting fields for logging, you can have the same display name for more than one field, but this is not recommended. Having the same display name might make monitoring the fields at run time difficult.
The business data log appears in the Execution Details page under Operations > Business Data. See the Log Business Data section for more information.
- Delete: Delete the step.
Click this icon to open the referenced flow service if a flow service references any other flow service.
Indicates count of only the immediate child steps.
Note
Flow services can accommodate a maximum of 300 steps. Exceeding this maximum step limit might lead to performance issues.

Input and Output Fields Declaration

The Define I/O feature allows you to define the input and output fields for a flow service. You can define the input and output fields from the Define input and output fields screen. You can access the screen by clicking the Define I/O icon () from the flow services action bar.

The Define input and output fields screen has two tabs:

You can declare the fields of a flow service in one of the following ways:

Guidelines for Defining Input and Output Fields

Although declaring input and output fields for a flow service is optional, it is strongly recommended that you make it a practice to declare the fields for every flow service that you create due to the following reasons:

Input Fields

Output Fields

Declaring Fields Manually

You can declare fields manually in one of the following ways: - Using Add a new set

Using Add a new set

Here, the instructions are explained for input fields. You can follow the same instructions to add output fields from the Output Fields tab.

  1. Go to the Define input and output fields screen.

  2. Select Add a new set in the Input Fields tab.

  3. Click Add in the Data Fields section. The fields are listed under Data fields.

  4. Enter the details as per your requirements.

  5. Click Done. The input fields are declared.

    Note
    • When you select the Type as String in the Display Type field, select:

      • Text Field if you want the input entered in a text field.

      • Large Editor if you want the input entered in a large text area instead of a text field. This is useful if you expect a large amount of text as input for the field, or you need to have new line characters in the input.

      • In the Pick List field, define the values that will appear as choices when IBM webMethods Integration prompts for input at run time.

      • In the Content Type field, you can define constraints for the field such as, minimum value of a field or maximum length of a string. For example,

      • It is crucial to keep in mind that the characters “/” and “&” should not be utilized while defining field names. Using these symbols in a field name will generate an error. To avoid this issue, it is advisable to opt for field names comprising solely of alphanumeric characters and underscores.

      • Password if you want the input entered as a password.

      • Large Editor if you want the input entered in a large text area instead of a text field. This is useful if you expect a large amount of text as input for the field, or you need to have new line characters in the input.

      • In the Pick List field, define the values that will appear as choices when IBM webMethods Integration prompts for input at run time.

      • In the Content Type field, you can define constraints for the field such as, minimum value of a field or maximum length of a string. For example,

      • It is crucial to keep in mind that the characters “/” and “&” should not be utilized while defining field names. Using these symbols in a field name will generate an error. To avoid this issue, it is advisable to opt for field names comprising solely of alphanumeric characters and underscores.

Loading through XML or JSON

Here, the instructions are explained for input fields. You can follow the same instructions to add output fields from the Output Fields tab.

  1. Go to the Define input and output fields screen.

  2. Select Add a new set in the Input Fields tab.

  3. Perform one of the following actions:

    • Load XML - Click Load XML in the Data Fields section to define the content in XML. The Type or paste XML content text box appears.

    • Load JSON - Click Load JSON in the Data Fields section to define content in JSON. The Type or paste JSON content text box appears.

  4. Type the details as per your requirements. Alternatively, you can paste the details from an XML or JSON file.

  5. Perform one of the following actions:

    • Load XML - Click Load XML if you have defined the fields in the XML format.

    • Load JSON - Click Load JSON if you have defined the fields in the JSON format.

    The input fields are defined.

Declaring Fields using Document Reference

You can use a document type to define the input or output fields for a flow service. For example, if there are multiple flow services with identical input fields but different output fields, you can use a document type to define the input fields rather than manually specifying individual input fields for each flow service. When you assign a Document Type to the Input or Output side, you cannot add, modify, or delete the fields on that part of the tab.

You can select Document Type from the Document reference drop-down list. A Document Type can be created using the Document Types option under Project > Configurations > Flow service.

You can create pipeline fields as document references, create document types comprising of document references, and also define the signature of flow services comprising of document references.|

  1. Go to the Define input and output fields screen.

  2. Select Document Reference in the Input Fields tab. The Choose Document Reference drop-down list appears listing all documents available in the project.

  3. Select the document from the Choose Document Reference drop-down list.

  4. Click Done. The input fields are declared.

Input and Output Field Validations

The Input and Output Field Validations feature enables you to validate the input and output fields during runtime. While declaring the input and output fields you can provide constraints such as, minimum value a field can accept, maximum length of a string, and so on. During runtime, IBM webMethods Integration validates the values and if the constraints are not satisfied, then the flow service execution fails.

You can enable this feature using the options Validate input and Validate output in the Input Fields and Output Fields tabs of the Define input and output fields screen.

Value Set

When running a service using IBM webMethods Integration, you frequently need to submit input values. A value set allows you to save these input values. If you need to execute the same flow service again in the future with the same input values, you can use the previously saved value set instead of manually inputting the input values.

Example

In this example, you will learn about defining a value set for a service. Assume, you use a *Slacktest service, to create an integration that posts a user defined message on a specific slack channel.

Let us see how to provide input values to a flow service. We will create a flow service slacktest that posts a user defined message on a specific Slack channel.

Basic Flow

1.Create the flow service.

2.Click the Define IO () icon and define the input fields channel and message.

3.Click the mapping icon () and define the pipeline mapping as shown in the following illustration.

4.Click the Run icon (). The Input values dialog box appears.

Note
If you do not define any input fields in a flow service, then the Input values dialog box does not appear and the flow service executes directly.

5.Specify the input values as general and Hello Team !!! and save the value set as slack_valueset_1.

You can run the flow service without saving the value set too.

Note
If you do not define any input fields in a flow service, then the Input values dialog box does not appear and the flow service executes directly.

5.Specify the input values as general and Hello Team !!! and save the value set as slack_valueset_1.

You can run the flow service without saving the value set too. A value set is a placeholder to store run time input values. You can use the same value set if you want to run the same flow service with the same input values. This is useful when you have multiple input fields. Value sets are stored in your browser’s local storage and the value sets are retained till the local storage is cleared.

Include empty values for string types: If you do not provide an input value for a string field, then at run time, the value will be null by default. If you select this option, then at run time, the value will be an empty string.

6.Click Run.

7.View the result. The values for the input fields channel and message are displayed.

Upload Input Values

The Upload Input Values feature allows you to upload a JSON file containing a value set that needs to be provided as input to a service.

When uploading a JSON file, if there is a value set with the same name, the following warning appears:

Note
The JSON file can be a maximum of 200 KB in size. Exceeding this limit may impact the performance of the user interface.

Download Input Values

The Download input values feature allows you to download the input values used in a service as a JSON file. When you click Download input values, the input values are downloaded as a JSON file in the {flowServiceName}-{valueSetName}.json format and saved in the default download folder on your local system.

This downloaded file can be exported or used later based on your requirements.

Pipeline Mapping

The Pipeline feature offers a graphical representation view for all of your data and allows you to map the data between flow service’s user input, and connectors or services. Pipeline is the general term used to refer the data structure in which the input and output values are maintained for each step of a flow service. The pipeline starts with the user defined input to the flow service and collects inputs and outputs from every step to the next step in the flow service. When the flow service executes, pipeline has access to data until the previous step’s output.

Pipeline Panel

The Pipeline panel enables you to map the input and output fields. You can access the Pipeline panel by clicking the mapping icon () on the flow services step. The Pipeline panel appears only when you select any operation of the connector or service and an account must be configured in case of connector. The flow service generates the fields based on the operation and the service or connector selected. You can define the input or output fields in the Define IO section and map them to the service or connector fields.

The Pipeline panel has the following columns:

You can map the fields in the following order:

  1. Pipeline Input fields to Service Input fields

  2. Service Output fields to Pipeline Output fields

    Note
    For easy identification purpose, services are indicated with fn text in the column header and the connector icon is displayed for connectors.

Pipeline Taskbar

You can perform the following actions while mapping the input and output fields in a flow service. The Taskbar is available at the top right-corner of the Pipeline panel.

Name and Icon Description
Recommended Mappings ( ) Recommends mappings based on the pattern of previous mappings. The recommended mappings are represented with dotted lines. For more information, see Smart Mapping.
Show only Mapped () Displays only the mapped fields.
Copy () Copies a field from the Pipeline Input and Pipeline Output sections. This icon is enabled only when a field is selected. For more information, see Copy and Paste Fields.
Clear () Clears all mappings and values set for fields in the pipeline. This icon is enabled always. For more information, see Clear Values.
Delete () Deletes the selected mapping. You can also delete the values set for input and output fields, delete the map between fields, and delete the drop value. This icon is enabled if a particular mapping is selected by clicking on the mapping line.
For more information, see Delete Mappings.
Move () Moves the selected field to either left, right, up, or down in the pipeline. The left and right icons are enabled only when the selected field has a possibility to move to the immediate parental hierarchy (if any). The up and down icons are enabled only when the selected field has a possibility to move one level up or down its sibling field.
Map () Connects service and pipeline fields in the pipeline with a line called a map (link). For more information, see Map Pipeline Fields.
Set Value () Sets the values for input and output fields. For more information, see Set Values.
Drop () Drops a field from the Pipeline Input or Pipeline Output sections. For more information, see Drop Fields.
Map by Condition () Sets a condition on a pipeline map. Only when the condition is satisfied the target field is assigned a value. For more information, see May by Condition.
Expand () Expands the Pipeline panel. For more information, see Expand Mapping Panel.
Toggle Pipeline Panel () Allows you to efficiently manage and inspect pipeline data. Provides a flexible way to control screen space.
Close () Closes the mapping panel and returns to the flow service. This icon is always enabled. Whatever the state of mappings or data manipulations done till that point are saved.
Paste () Pastes the field in the pipeline after a copy field action. For more information, see Copy and Paste Fields.
Add () Adds a field to the pipeline. You can add fields that were not declared as input or output fields (through Define IO) of the flow service. For more information, see Add Fields.
Note
You can also access these actions by right-clicking a field in the pipeline as shown:

Set Values

The Set Values feature allows you to set values for the fields by clicking on the field in the Pipeline panel.

The behavior of the Set Value feature is as follows:

For example, let us see the Adding Integers (AddInts) functionality using the Math service.

  1. Create a flow service. For example, AddingIntegers. A flow service step is created initially without any data.

  2. Select the AddInts operation in the flow service step.

  3. Click on the flow service step. The Pipeline panel appears. Two service input fields num1 and num2 are listed in the Service Input column.

  4. Click any of the fields, for example, num1. The Set Value dialog box appears.

  5. Enter the value in the num1 field.

    Note
    When you paste data equal to or exceeding 0.5 MB in the text box, the system disables editing due to performance limitations. However, you can still use the respective buttons to copy and paste the data and perform editing in an external tool.
  6. Click Save. The value is set and the corresponding field is represented with the SetValue icon. If you export this step, the set value of this field is exported.

  7. Repeat the above steps to set values for the required fields.

Pipeline Variable Substitution

The Perform pipeline variable substitution check box indicates whether you want the application to perform pipeline variable substitution at runtime. If selected, the application replaces the pipeline variable with the runtime value of the variable while running the flow service.

Note
You can assign values of string or string[] fields to other string or string[] fields in the pipeline.

The Perform pipeline variable substitution check box indicates whether you want the application to perform pipeline variable substitution at runtime. If selected, the application replaces the pipeline variable with the runtime value of the variable while running the flow service.

Note
You can assign values of a only string or string[] fields to another string or string[] fields in the pipeline.

Clear Values

The Clear Values feature allows you to reset the field values. If the field is a document or document reference type, Clear All resets the nested fields as well. The default values of different types on Set Value (without giving any input, just opening the Set Value screen and save) and Clear All are as follows:

Field Type On Default Set Value On Clear All
String “(empty)
Boolean False False
Array [] []
Float, Int, Double, Long, Short nothing set
Document, Document Reference An object with all String fields at all levels are set to “, nothing is set for other types. An object with all String fields at all levels are set to “, nothing is set for other types.

Map Pipeline Fields

The Map Pipeline Fields feature allows you to connect service and pipeline fields in the pipeline with a line called a map (link). You can select two input fields and click the Map icon to create a map between them. Creating a map between fields copies the value from one field to another at run time. There are two types of mapping:

Implicit Mapping

Within a flow service, IBM webMethods Integration implicitly maps fields whose names are the same and whose data types are compatible. flow service connects implicitly mapped fields with a dotted line.

Explicit Mapping

You can map input fields from the Pipeline Input column to Service In fields, and also can map the output from the Service Out to a different field in the Pipeline Out column. Explicit Mapping can be achieved in the following ways:

Delete Mappings

The Delete Mappings feature allows you to remove mappings . You can delete each map individually or all mappings at a time.

Search Fields

The Search feature allows you to search fields. When you type field names in the Search text box, IBM webMethods Integration performs a dynamic search across all fields (including nested fields), and displays the resultant fields in the respective panels. Additionally, each column has its own search bar that allows you to search in the respective column.

Expand Mapping Panel

The Expand feature allows you to resize the Pipeline panel. On clicking the Expand icon, the Pipeline panel size increases and you can resize the column widths as per your requirements to view the mappings clearly.

Tip
The Expand Mapping Panel option is useful in scenarios when there are many mappings and the current default column width is not sufficient for clear view of the mappings. You can click Expand to increase the Pipeline panel size and resize the column for viewing the mappings with more clarity.

Note
For any nested structures, you can easily expand or collapse all nodes by clicking the Expand All and Collapse All buttons. The Expand All and Collapse All buttons appear only when there are nested structures in a Transform step.

When any parent node is in expanded mode, then the button name is changed to Collapse All until all nodes are in collapsed state

Copy and Paste Fields

The Copy and Paste feature allows you to copy any field and paste in the pipeline. Depending on the context, you can either paste the field or the field path. For example, if you copy a field and paste the field in the Set Value dialog box, the field path is pasted. Alternatively, you can use keyboard shortcuts Ctrl+C to copy and Ctrl+V to paste fields. You can perform the copy and paste actions in the following ways:

Note
To copy any field name in the pipeline panel, you right-click the field and select Copy field name from the displayed menu. The complete path of the field is copied. You could use this option if you would like to extract field names only.

Drop Fields

The Drop feature allows you to remove fields from a pipeline that are no longer used by the subsequent steps. You can drop fields from only the Pipeline Input and Pipeline Out columns.

By dropping the unwanted fields you can reduce the size of the pipeline at run time. Also, the length and complexity of the Pipeline Input and Pipeline Out columns is reduced, thus making the pipeline panel much easier to use when you are working with a complex flow service. If any output field is dropped, then that particular field is not sent as Pipeline Input to the next step. This way you can restrict the flow of fields from one step to another.

For easy identification purpose, the Drop icon appears after a field is dropped. For example, .

You cannot drop a field in the following scenarios:

Add Fields

The Add Fields feature allows you to add fields to a pipeline.

Map by Condition

The Map by Condition feature allows you to define conditions for the maps (links) drawn between fields in a pipeline. A condition consists of one or more expressions that allows you to:

For example, map the fields BuyersTotal and OrderTotal only if BuyersTotal has a value, that is, Not Null.

During runtime, the application runs all conditional mappings and assigns a value to the target field only when the condition is true. Otherwise, the application ignores the mapping. In scenarios where the fields are mandatary and the conditions are not satisfied, you might observe flow service runtime failure issues.

You can map multiple source fields to the same target field if the mappings to the target have conditions. In some scenarios, where you have mapped multiple source fields to a single target field, at most, only one of the conditions you define can be true at run time. If more than one condition to the same target field evaluates to true, then the result is not definite because the order in which the conditions are run is not guaranteed.

You can define conditions for a map using the Condition Editor screen. The Condition Editor screen can be accessed by selecting the map and clicking the Map by Condition () icon on the Pipeline panel or by double-clicking the map.

The Condition Editor screen functionality is similar to that of the Expression Editor screen. For more information about the Condition Editor screen description, see Expression Editor.

Points to Consider when Defining Conditions for Maps

The condition expression given for the map behaves similar to the flow service containing a Branch condition. For more information on Branch steps, see Branch.

Adding Conditions to a Map

Example

Assume that there is a flow service CentimetertoMeterConversion that converts the values provided by you from centimeters to meters. If the meter value is zero, then a custom message is logged. The flow service includes the following:

Let us modify the logic of the flow service such that it converts only specific values instead of all values based on the following conditions:

Before you Begin

Basic Flow

  1. Go to the CentimetertoMeterConversion flow service.

  2. Select the centimeters to num1 map and click from the pipeline tool bar. The Condition Editor screen appears.

    By default, the first field is selected and displayed in the editor.

  3. Ensure that the Enable Condition during execution check box is selected. Otherwise, the condition is not considered during runtime.

  4. Define the conditions. For more information on how to define conditions and sub conditions, see Creating Complex Expressions.

    As per the example, the condition minValue > 1 and maxValue < 9999 is defined for the selected mapping as shown in the following iluustration:

  5. Click Save. The condition is added to the map and the icon is added to indicate that the map has a condition defined.

  6. Map the default pipeline Input field to num1.

  7. Define condition for the Default pipeline Input field.

    Note
    To remove a condition from a map:
    1. Select the map and click the Map By Condition icon. The Condition Editor appears.
    2. Click Remove Condition.
  8. Click Run. The results are displayed based on the values you provide.

Default Pipeline Mapping Rules and Behavior

Before you start mapping fields, it is recommended to go through the mapping guidelines to avoid runtime issues due to incorrect mappings.

Note
  • Mapping between a multidimensional data type (Target) and any single dimensional data type (Source), then the Target field is assigned to the specified element of the Source field. For rules to know whether mapping occurs at runtime, see the tables in the Default Pipeline Mapping Rules and Behaviour section.
    • Single Dimension Data Types - String, Short, Long, Integer, Float, Double, Boolean, Byte Array (b[]), Big Decimal, Big Integer, Object
    • Multi Dimension Data Types - String [], Short [], Long [], Integer [],Float [], Double [], Boolean [], Big Decimal [], Big Integer [], Object[]
    • Document, Document References can be mapped only with Document, Document References And arrays of these (Document [], Document Reference[]).

Indexed Mapping

The Indexed Mapping feature allows you to map array fields and specify which element in the array you want to map. Few examples are:

The mapping between array indexes can be performed using the Indexed Mapping dialog box. The Indexed Mapping dialog box automatically appears when you map array fields in the Pipeline panel.

Note
Index mapping for the Document and Document Reference data types are not supported.

The Indexed Mapping dialog box has the following options:

Note
  • If you have not mapped:

    • any indexes and the Map specific elements in an array option is selected, then the parent fields are automatically mapped.
    • any one of the target index with the source index, then that index element is mapped to the parent.
  • If you have mapped multiple source indexes to a single target, then the result is not definite because the order in which the mappings are run is not guaranteed.

  • If you want to add or delete a row index, you can use the Add and Delete buttons in the Indexed Mapping dialog box. To delete a single index entry, use the Delete button adjacent to the index entry row. You cannot modify any existing mappings that are indexed.

Guidelines for Mapping Array Fields

Default Pipeline Rules for Mapping Array Fields

When you create maps between scalar and array fields, you can specify which element of the array field you want to map to or from. Scalar fields are those that hold a single value, such as String and Object. Array fields are those that hold multiple values, such as String List and Object List. For example, you can map a String to the second element of a String List.

If you do not specify which element in the array that you want to map to or from, the application uses the default rules in pipeline to determine the value of the target field. The following table lists the default pipeline rules considered for mapping to and from array fields:

Field 1 - Field 2 Behavior
A scalar field - An array field that is empty (the field does not have a defined length) The map defines the length of the array field; that is, it contains one element and has length of one. The first (and only) element in the array is assigned the value of the scalar field.
A scalar field - An array field with a defined length The length of the array is preserved and each element of the array is assigned the value of the scalar field.
An array field - A scalar field The scalar field is assigned the first element in the array.
An array field - An array field that does not have a defined length The map defines the length of the target array field; that is, it will be the same length as the source array field. The elements in the target array field are assigned the values of the corresponding elements in the source array field.
An array field - An array field that has a defined length The length of the source array field must equal the length of the target array field. If the lengths do not match, the map does not occur. If the lengths are equal, the elements in the target array field are assigned the values of the corresponding elements in the source array field.

Smart Mapping

IBM leverages the collective intelligence of the IBM webMethods Integration community to suggest which fields should be mapped in a data map by learning from the mappings you create.

Smart mapping provides you with recommendations while mapping the pipeline data and utilizes a series of algorithms to determine the likely accuracy of a given suggestion, enabling you to toggle between high, medium, and low levels of mapping confidence. A Machine Learning (ML) algorithm is applied to provide the suggestions. The ML algorithm learns from the mappings you create and provides suggestions automatically to map similar fields. The algorithm benefits from having more data from more number of users.

Smart mapping is anonymous and does not store any customer-specific information or actual data of any kind and is available to only those tenants who provide their consent to share their mapping information. Individual fields contained within the records are indexed. Specifically, the field names and their hierarchy are indexed, as well as the mapping relationships between them.

After providing consent, if you have the relevant role permissions, you can choose to opt-out of smart mapping. Your maps will not be indexed, that is, if you opt out of smart mapping, you will not be able to see or utilize any mapping suggestions and your maps will no longer be indexed. However, as the index is anonymous, any maps and profiles indexed during the opt-in period will remain in the database. Further, the data collected is confined to that particular data center where the tenant resides.

Mapping recommendations are not tenant specific, so mapping inputs from one tenant maybe used to make recommendations for another tenant. When you do the mapping, the data collected does not reflect immediately as a recommendation for another user as the information is recorded and processed in our database only at specified intervals.

Note
For trial tenants, the mapping data is collected by default. Further, for trial tenants and for the Free Forever Edition, smart mapping is always enabled and cannot be changed. For paid tenants, only an Administrator has the permission to enable or disable smart mapping.

The following information is not indexed:

How it works

  1. To provide your consent to share the mapping information, from the IBM webMethods Integration navigation bar, click on the profile icon located at the top-right corner of the home page, and select Settings > Preferences.

  2. On the Configure Tenant Preferences page, select the Publish integration mappings to recommendations engine option and click Save to enable smart mapping. This provides you mapping recommendations whenever you do mapping. By enabling this option, you are also providing us your consent to collect your mapping information. For trial tenants and for the Free Forever Edition, this option is always enabled by default and cannot be changed.

  3. Select a project and then the flow service for which you want to do smart mapping.

  4. On the pipeline mapping screen, select Recommend Mappings to see the recommended mappings. If you select the Show only mapped option, the Recommend mappings option is automatically cleared.
    When the screen is initially loaded, only high recommendations appear by default.

  5. Drag the recommendation accuracy slider to view the mapping recommendations and filter the recommendations based on their recommendation accuracy. The recommendation accuracy or confidence number appears when you hover the pointer over a mapping and is the level of mapping confidence of that specific recommendation.

    Based on the level of mapping confidence, the recommendations are grouped into High, Medium, and Low categories:

    • Mappings have the highest probability
    • Mappings have medium probability
    • Mappings have the least probability

    You can select more than one category by moving the slider. In the following example, mappings that have medium and high probability are displayed.

  6. Select a mapping and click Accept to hard map it. You can select one or more recommendations and accept only those recommendations (Selected (x)), or you can accept all the recommendations that appear on the screen (All shown (x)). The accepted recommendation behaves like an actual mapping.

  7. To unmap a hard mapping, select the hard mapping and then click the delete icon available on the pipeline action bar. Once the hard mapping is deleted, the recommendations appear again. To hard map the recommendations again, click Accept and select the desired option.

    Note
    If you are an Administrator of a paid tenant, and have cleared the Publish Integration Mappings to Recommendations Engine option, IBM webMethods Integration displays a message to inform you whether you want to enable the smart mapping feature. If you select Yes, the Predict Mappings option appears in the pipeline mapping screen.

Expression Editor

The Expression Editor is an interface that allows you to define complex expressions (conditions) using the conditional controls such as If, Else If, While, and Do Until. A complex expression is formed by combining simple conditions (rules) with logical operators AND and OR or negating these conditions with logical negation operator NOT.

You can access Expression Editor by clicking the Expression () icon on the Flow service step. The Expression icon appears only when you select a conditional construct control in the Flow service step.

Components of Expression Editor

Expression Editor consists of two sections:

Expression View

The Expression View section displays the conditions defined. Additionally, when you hover the mouse pointer on operator of the condition, the condition’s scope is highlighted for easy reference as shown in the following illustration:

Expression Builder

The Expression Builder section allows you to create complex conditions by defining rules. By default, a rule step is displayed to start with the condition definition. A rule step consists of Left Operand, Operator, and Right Operand to define a condition. The operands list the fields available in the Pipeline. You can group multiple rules to define sub conditions.

Expression Builder contains the following controls that aid you in defining the complex conditions:

At any time you can either modify or delete a part or whole of the complex condition using these controls.

When you hover on the operands, the complete path of the operand appears.

Creating Complex Expressions

Example

Let us create a complex expression for checking the vaccination slot availability with the following conditions:

Before you Begin

Basic Flow

  1. Go to Flow services.

  2. Select the project where you want to create the new flow service. You can also create a new project.

  3. Click to create a flow service. The Start Creating the Flow service screen appears.

  4. Provide a name for the flow service. For example, GetVaccinationSlotStatus and an optional description for the new flow service.

  5. Select a conditional control in the flow service step. For example, If.

  6. Click the Expression () icon on the conditional flow service step. The Expression Editor screen appears.

  7. Perform the following steps to define a rule:

    1. Select a left operand.

    2. Select an operator.

    3. Select a right operand.

    The rule is defined. As per the example, the rule 1 - Location is Washington is defined as follows:

  8. [Optional] Click or Add Rule. A new rule step is added.

  9. Repeat the above steps to define more rules as per your requirement.

  10. Select the operator (group-level) from the And drop-down list to conjunct the previous and new rules. As per the example, rule 2 - Zipcode is 20010 is defined and both are combined with an And operator as follows:

  11. Perform the following steps to define a group:

    1. Click Add Group. A new rule step appears and is grouped under a separate block.

    2. Select the operands and operator to define the rule.

    3. [Optional] Click or Add Rule (group-level). A new rule step is added to the group.

    4. [Optional] Select the operator from the And drop-down list (group-level) to conjunct the previous and new rules in the group.

    5. Repeat the above steps to define all rules in the group. The sub condition is defined.

    As per the example, group 1 - Vaccine can be either Pfizer, Moderna, or Sputnik, group 2 - Age is less than or equal to 45 and slot exists are defined as follows. The groups and other rules are combined with an And operator.

  12. Define the rule 3 - Venue is Howard University Hospital as per the example. The expression created is as follows:

  13. [Optional] Perform the following steps to remove a rule or rule group:

    • Rule - Click adjacent to the rule that must be deleted. The rule is deleted from the complex condition.

    • Rule Group - Click Remove Group in the group that must be deleted. The rule group is deleted from the complex condition.

    Tip
    You can use the keys Ctrl+Z and Ctrl+Y to undo and redo the delete actions.
  14. [Optional] Perform the following steps to negate a rule or rule group:

    • Rule - Click adjacent to the rule that must be negated. The rule is deleted from the complex condition.

    • Rule Group - Click Negate Group in the group that must be negated. The rule group is deleted from the complex condition. The button is renamed as Remove Negation and allows you to remove the negation for that group.

  15. Click on the Expression Editor screen. The condition is added to the flow service step. You can click the down and up arrows in the flow service step to view and hide the complete expression.

The complex condition is created and you can proceed with the other flow service steps.

Creating Flow services

See the following examples to learn how to create flow services. Click here for information on how to manage roles and project permissions.

Get leads from Salesforce CRM and create corresponding customer leads in Microsoft Dynamics 365 CRM

Summary

Get leads from Salesforce CRM and create corresponding customer leads in Microsoft Dynamics 365 CRM.

Before you begin

Basic Flow

  1. Select the project where you want to create the new Flow service. You can also create a new project.

  2. Click the Flow services tab and on the Flow services page, click the icon.

  3. Provide a name, for example, SalesforceToMSDynamics365CRM, and an optional description for the new flow service.

  4. Type Salesforce in the search box and select Salesforce CRM.

    Tip
    In a flow service step, you can perform search in one of the following ways:
    - Alias-based search: Type a keyword and the matching results are displayed. List of supported keywords for alias-based search are as follows:
    - map: Transform pipeline - iteration/loop: While, Do Until, Repeat, Repeat for Count, Repeat-Input-Output - selection/condition: If, Else, If Else, Else If, Switch, Branch, Case - jump: Break, Exit - exception: Try, Catch, Finally, Try Catch, Try Finally, Try Catch Finally
    - Restricted scope search: Type a keyword followed by a pipe symbol or space or tab to search within a specific scope, for example, to search within flow services, type fs|. List of supported keywords for restricted scope search are as follows:
    - ctrl: Controls - con: Connectors - fs: Flow services - svc: Services
  5. Select the queryleads operation.

  6. Select the SalesforceCRM_1 account. You can also create or configure an account inline.

  7. Click the icon to add a new step.

  8. Type repeat, select Repeat to create a repeat step, and then select the /Lead option.

  9. Select Microsoft Dynamics 365 CRM and then select the associated createLead action.

  10. Select the msdynamics_1 account. You can also create or configure an account inline.

  11. Click the mapping icon to map the input and output fields.

  12. Click the Pipeline Input fields (FirstName and LastName) and drag it to the service input (firstname and lastname). The service output is automatically mapped to the Pipeline Output by a dotted line.

  13. Save the flow service and run it by clicking the Run icon.

  14. View the flow service execution results for a successful run. The lead ID generated is acf4f843-2970-ea11-a811-000d3a4da920.

    Note
    If a value is null for a field or if the datatype is unknown, then the obj (object) icon is displayed.

  15. Download the results.

16.You can also view the previous flow service execution results.

Note
By default, all flow service execution results are retained for 30 days. You can optionally specify the number of days (up to 30 days) for which you would like to retain the flow service execution logs by clicking the Modify Retention Period link available at Monitor > Execution Results > Flow service Execution. Once the retention period is over, the flow service execution logs are deleted automatically.

Get attendees from Concur and create contacts in Salesforce CRM

Summary

Get attendees from Concur and create contacts in Salesforce CRM.

Before you begin

Basic Flow

  1. Select the project where you want to create the new flow service. You can also create a new project.

  2. Click the Flow services tab and on the Flow services page, click the icon.

  3. Provide a name, for example, ConcurAttendeeToSalesforce, and an optional description for the new flow service.

  4. Type Concur in the search box, select Concur, and then in the Type to choose action field, select Add Custom Operation.

  5. Do the steps as shown in the following images to create the GetConcurAttendees custom operation.

  6. Select GetConcurAttendees, click the icon, and select the Concur_1 account. You can also create this account inline.

  7. Click the icon to add a new step.

  8. Type repeat, select Repeat to create a repeat step, and then select the /item option.

  9. Select Salesforce CRM and then select the associated createcontact action.

  10. Select the SalesforceCRM_1 account. You can also create or configure this account inline.

  11. Click the mapping icon to map the input and output fields.

  12. Map the input and output fields as shown below. Double-click the OtherCity and OtherCountry fields and set the required input values. You can also select the field and click the Set Value icon . The service output is automatically mapped to the Pipeline Output by a dotted line.

  13. Save the flow service and click Run.

  14. View the flow service execution results.

Retrieve files stored in Amazon Simple Storage Service (S3) bucket and log the content of the files

Summary

Retrieve files stored in Amazon Simple Storage Service (S3) bucket and log the content of the files.

Before you begin

Note
Click here for information on how to manage roles and project permissions.

Basic Flow

1.Select the project where you want to create the new flow service. You can also create a new project.

2.Click the Flow services tab and on the Flow services page, click the icon.

3.Provide a name, for example, AmazonS3, and an optional description for the new flow service.

4.Type Amazon Simple Storage Service (S3) in the search box, select it, and then select the action or operation, getBucket.

5.Select the AmazonSimpleStorageServiceS3_1 account. You can also create or configure an account inline.

6.Click the mapping icon to set a value for getbucketinput.

7.Expand getBucketInput and click bucketName.

8.Type softwareagbucketaws as the value for bucketName.

9.Click the icon to add a new step. Then type repeat to select the Repeat step and select the /content option.

10.Select Amazon Simple Storage Service (S3) and choose the getObject action to retrieve the object from the specified bucket.

11.Click the mapping icon to map the input and output fields.

12.As shown below, click the pipeline input fields (name and key) and drag it to the service input (bucketName and objectName). The service output (getObjectOutput) is automatically mapped to the pipeline output by a dotted line.

.

13.Click the + icon to add a new step as shown below.

14.Select the Flow function and then select the logCustomMessage service. You can also type logCustomMessage and select it. This logs a message, which you can view in the flow service execution results screen.

15.Map the input (stream) to message. This step logs the contents of the files in the bucket.

16.Save the Flow service and click Run.

17.You can also view the execution result in the Monitor > Flow service Execution page. Click the execution result name link to view the execution details.

Creating Custom Operations in Flow services

IBM webMethods Integration provides predefined connectors, which contain SaaS provider-specific information that enables you to connect to a particular SaaS provider. Further, each connector uses an account to connect to the provider’s back end and perform operations. Each connector comes with a predefined set of operations. You can also create your own custom operations while creating a flow service.

Let us see how to create a custom operation while creating a flow service and then use that custom operation to create a Salesforce CRM back end account.

1.After you log in, select a project or create a new project where you want to create the flow service.

2.Click the Flow services tab and on the Flow services page, click the icon.

3.Provide a name SalesforceCreateAccountCustom and description of the new flow service.

4.Type Salesforce in the search box, select Salesforce CRM, and then select Add Custom Operation.

5.On the Connect to account page, select the supported Authentication type and the Salesforce CRM account created from the drop-down list. Provide a name and description of the custom operation.

6.Select the create operation.

Note that for REST-based connectors, after selecting the operation, you can click Headers to add input Headers, if required. IBM webMethods Integration displays the default HTTP transport headers for the operation, along with their default values. At run time, while processing the headers, IBM webMethods Integration substitutes the values as necessary. In order to customize the headers, do the following:

a. Click + Add to add a custom Header.

b. Click the icon to specify the header name and an optional default value for the header variable. If the variable is null in the input pipeline, this value will be used at run time. If the variable already has an existing default value defined, this value will overwrite the existing value at run time.

c. If headers appear in the signature, select Active to activate the headers in the signature.

d. To delete a custom header that you have added, click Delete.

Note
You cannot delete the required headers.

You can also customize the parameters for REST-based connectors after selecting the operation, by clicking the Parameter option. Review the operation parameter details. IBM webMethods Integration displays the parameter Name and Description, the Data Type used to represent the kind of information the parameter can hold, the parameterization Type of the request, and the default value needed to access the operation. To specify a default value for the parameter, click the icon and then type or paste the default value. The default value is used at run time. You cannot add or delete request parameters. You can only modify the default value of a parameter. All parameters appear in the signature.

Now let us go back to our example.

7. After you select the create operation, click Next, and then select the Business Object Account. Business Objects appear only for certain connectors and operations.

8.Select the data fields and confirm the action to create the custom operation. Data fields appear only for certain connectors and operations.

9.On the Flow service editor, click the icon to define the input and output fields.

10.Create two Input Fields, AccountName and CityName.

11.Click to edit the flow service mapping. Only fields selected earlier are shown in the input panel.

12.Save the flow service and click Run. Provide the custom field values in the AccountName and CityName fields, for example, Software

As the results show, the Software account is created.

Support for Multipart Request Body

IBM webMethods Integration supports the multipart/form-data media type using which you can embed binary data such as files into the request body. Though application/x-www-form-urlencoded is a more natural way of encoding, it becomes inefficient for encoding binary data or text containing non-ASCII characters. The media type multipart/form-data is the preferred media type for request payloads that contain files, non-ASCII, and binary data.

For example, if you want to create a user as well as upload a photo, the request has to be a multipart request where one part is an image file while the other part is a JSON request body. Further, uploading the CRM individual contact data to Salesforce is time consuming, so using the MIME/Multipart attachments capability, you can upload the csv/json file containing multiple contacts data into Salesforce in a single run.

For some connectors and operations, for example, for SalesforceR Bulk v2 Data Loader, DocuWare, Google Drive, Amazon S3, and FreshService, IBM webMethods Integration supports multipart request body.

Example of a multipart request

A multipart/form-data request body contains a series of parts separated by a boundary delimiter, constructed using Carriage Return Line Feed (CRLF), “–”, and also the value of the boundary parameters. The boundary delimiter must not appear inside any of the encapsulated parts.

Each part has the Name, Type, Content-Type, and Part ID fields.

--BOUNDARY


Content-Type: application/json


Content-Disposition: form-data; name="job"


{


"object":"Contact",


"contentType":"CSV",


"operation":"insert"


}


--BOUNDARY


Content-Type: text/csv


Content-Disposition: form-data; name="content"; filename="content"


(Content of your CSV file)


--BOUNDARY—

Part Configuration

While adding a custom action, for example, for the Freshservice Create Child Ticket With Attachments operation, you can click Attachments to view the list of all the configured parts to be sent to the service provider. You can send a multipart/form-data payload which contains either a file, or text, or a document type.

The parts to be sent to the service provider appear in the input signature. All options including the Add option to add a custom part are disabled if the resource is not of type multipart/form-data. Currently, multipart/form-data payload is supported only at the request level, that is, only in the input signature.

Example to create a ticket with attachments (multipart data) in Freshservice

Before you begin

Basic Flow

  1. Select the project where you want to create the new flow service. You can also create a new project.
  2. Click the Flow services tab and on the Flow services page, click the icon.

  3. Provide a name for the flow service, for example, CreateTicketWithAttachment, and an optional description for the new flow service.

  4. Upload a file from the FTP server to Freshservice. Select the File Transfer Protocol (FTP/FTPS) connector, the getFile operation, and the FTPS_4 account.

  5. Let us upload the hello.txt file available on FTP server in Freshservice. Click Set Value for remoteFile and select the same file in the Set Value - remoteFile dialog box. Click Save.

  6. Select the Freshservice connector. As you are creating a ticket with an attachment, select the createTIcketWithAttachment operation and the account as Freshservice_1.

  7. Click the Edit Mapping icon. Under Pipeline Input, map contentStream to value.

  8. Set the following values on the mapping screen:

    • Set the value for filename as hello.txt.
    • Set the value for email as abc@xxxx.com.
    • Set the value for subject as create ticket.
    • Set the value for description as create ticket with attachment.
    • Set the value for priority as 1.
    • Set the value for status as 2.
    • Set the value for requester_id as 27000450816. This is the agent ID in Freshservice.
    • Set the value for phone as 123456789.
    • Set the value for source as test.
  9. Save and run the flow service.

  10. Go to Freshservice, click Tickets, and check that the ticket is generated.

Create bulk accounts in Salesforce using a multipart predefined operation

For some connectors and operations, for example, for the Salesforce R Bulk v2 Data Loader connector and createAndUploadDataUsingMultipart predefined operation, IBM webMethods Integration supports multipart request body.

Before you begin

Basic Flow

1.Select the project where you want to create the new flow service. You can also create a new project.

2.Click the Flow services tab and on the Flow services page, click the icon.

3.Provide a name and an optional description for the new flow service.

4.Type IO in the search box, select IO, and then select the stringToStream service.

5.Click the mapping icon to map the input and output fields.

6.Set the below value for string:

7.Set the value for encoding as UTF-8.

8.Click the icon to add a new step.

9.Select the Salesforce(R) Bulk v2 Data Loader connector and the createAndUploadDataUsingMultipart predefined operation. Select the SFBulkV2_02Apr account.

10.Click the mapping icon to map the input and output fields.

11.Map inputStream to value. The service output is automatically mapped to the Pipeline Output by a dotted line.

12.Set values for fileroot as shown below:

13.For fileRoot1, set values for name as content, contentType as text/csv, type as FILE, and filename as content.

14.Save the flow service and run it by clicking the Run icon.

15.View the flow service execution results for a successful run.

Built-in Services

IBM webMethods Integration has an extensive library of services for performing common integration tasks such as transforming data values, performing simple mathematical operations, and so on.

Services are invoked at run time. While creating a flow service, you can sequence services and manage the flow of data among them.

Related services are grouped in categories. Input and output parameters are the names and types of fields that the service requires as input and generates as output and these parameters are collectively referred to as a signature.

Service Category Description
Alert Use the Alert services to notify users when predefined conditions, such as password expiry, license key updates, rule violations, or service errors, are met, ensuring timely awareness and response to critical system events.
B2B Utils Use the B2B Utils services to perform generateResponse, constructSubmitInput, parseContent operations in IBM webMethods Integration.
Compress Use Compress services to compress the data before sending the HTTP request and decompress it after receiving the HTTP response.
Date Use Date services to generate and format date values.
Datetime Use Datetime services to build or increment a date/time. The services in datetime provide more explicit timezone processing than similar services in the Date category.
Document Use Document services to perform operations on documents.
E2E Monitoring Use the End-to-End Monitoring services to do the operations specific to IBM webMethods End-to-End Monitoring like setting custom transaction ID.
Flat File Use Flat File services to convert data bytes, data stream, and data string to a document and vice versa.
Flow Use flow services to perform utility-type tasks.
Hashtable Use Hashtable services to create, update, and obtain information about the hashtable.
IO Use IO services to convert data between byte[ ], characters, and InputStream representations. These services are used for reading and writing bytes, characters, and streamed data to the file system. These services behave like the corresponding methods in the java.io.InputStream class. These services can be invoked only by other services. Streams cannot be passed between clients and the server, so these services will not execute if they are invoked from a client.
JSON Use JSON services to convert JSON content into a document and to convert a document into JSON content.
List Use List services to retrieve, replace, or add elements in an Object List, Document List, or String List, including converting String Lists to Document Lists.
Math Use Math services to perform mathematical operations on string-based numeric values. Services that operate on integer values use Java’s long data type (64-bit, two’s complement). Services that operate on float values use Java’s double data type (64-bit IEEE 754). If extremely precise calculations are critical to your application, you should write your own Java services to perform math functions.
MIME Use MIME services to create MIME messages and extract information from MIME messages.
Schema Use Schema services to validate objects and to validate the pipeline.
Storage Use Storage services to insert, retrieve, update, and remove entries from a data store.
String Use String services to perform string manipulation and substitution operations.
Transaction Use Transaction services only in conjunction with the Database Application operations. These services are applicable when the Database Application account is of type Transactional.
Utils Use Utility services to generate a random Universally Unique Identifier (UUID) or to generate a message digest for a given message.
XML Use XML services to convert a document to XML content and XML content to a document.
Reference Data Use Reference Data services to upload reference data that defines the set of permissible values to be used by other data fields.
Note
When deploying a flow service in a multi-instance setup, the service is synchronized across both instances but operates on only one instance during execution. For example, if the flow service includes an alert.emit service, it exists in both instances but functions only within one instance at a time.

Alert services

Use the Alert services to notify users when predefined conditions, such as password expiry, license key updates, rule violations, or service errors, are met, ensuring timely awareness and response to critical system events.

The following Alert services are available:

Service Description
emit Performs an alert when a pre-configured condition is met.
channels Gets all alert channels in the system. Channels help classify alerts and let you subscribe to a specific type of alert.
countAll Gets the count of all alerts in the system, read and unread, or a subset of alerts that meet the filter criteria.
fetchAll Fetch all alerts in the system, including read and unread, or a subset based on filter criteria.
getSettings Gets the settings of the system notifier.
setSettings Updates the settings of the system notifier.
deregisterChannel Deregisters a registered custom channel.
getChannel Gets the details of a specific channel.
registerChannel Registers a custom channel.
updateChannel Updates the settings of a channel.
severities Lists the pre-defined severities that you can associate with an alert channel. The severity associated with an alert lets you assess the relative impact of a business event on the system.

emit

Generates an alert when a pre-configured condition is met. For example, User or Master Password Expiry, License Key Update, Enterprise Gateway Rule Violation, Service Error, and so on. This service is invoked by IBM webMethods Integration components to raise alerts.

Input Parameters

channelID: Integer. Identifier of the channel associated with the alert.

severity: String. Severity associated with the alert channel.

subject: String. Subject of the alert message.

contentType: String. Type of information in the alert. For example, text/plain.

content: String. Content of an alert. For example, Alert {0} Message Size Limit filter failed.\nClient IP Address: {1}\n Request URL : {2}\n Date & Time : {3} content

Output Parameters

alertId: Long. A unique identifier assigned to each alert emitted.

channels

Gets all alert channels in the system. Channels help classify alerts and let you subscribe to a specific type of alert.

Input Parameters

None.

Output Parameters

Channels: Document List. The list of alert channels in IBM webMethods Integration. By default, there are 13 channels. All channels have the following keys:

Usage Notes

The default channels, events when alerts are raised for a channel, and the corresponding severity are described in the following table:

Channel ID Channel Name Events Severity
1 Service Error Service execution errors.
Note
By default, service error notifications are disabled.
Error
2 Server Error Server errors such as HTTP 404.
Note
By default, server error notifications are disabled.
Error
3 Password Management A user password expires.
A user password is about to expire.
Default administrator password is not changed.
Critical
Warning
4 License Management IBM webMethods Integration license expires.
IBM webMethods Integration license is about to expire.
Critical
Warning
5 Certificate Management A security certificate is about to expire. Warning
6 Account Locking Multiple login attempt failures that result in a locked account.
A locked account is unlocked.
Critical
Information
8 Authentication Login failure limit is reached. Error
9 Package Management Package subscription (Delivery)
Package subscription (Release)
Note
By default, package management notifications are disabled.
Information
10 Threat Protection Enterprise Gateway deny rule violation.
Enterprise Gateway allow rule violation.
Critical
Warning
11 Metering Log Errors connecting to the Metering agent server. Error
12 User Management User management related alerts Warning
13 Master Password A master password expires.
Default master password is not changed.
Warning
14 Hybrid Connections Tenant connection disconnected
Tenant connection restored
Account disconnected
Account restored
Error
Information
Error
Information

countAll

Gets the count of all alerts in the system, read and unread, or a subset of alerts that meet the filter criteria.

Input Parameters

Output Parameters

Usage Notes

To get the count of all alerts in the system, read and unread, do not specify the filter criteria as inputs.

fetchAll

Fetch all alerts in the system, including read and unread, or a subset based on filter criteria.

Input Parameters

The default is timestamp.

Output Parameters

Usage Notes To fetch all read and unread alerts in the system, do not specify the filter criteria as inputs. The number of notifications on a page is identified by pageSize and the current page is identified by pageNumber.

getSettings

Gets the settings of the system notifier.

Input Parameters
None.

Output Parameters

setSettings

Updates the settings of the system notifier.

Input Parameters

Output Parameters

message: String. Indicates whether the system notifier settings are updated or not.

Usage Notes

Based on the value of the retentionPeriodInDays parameter, a purge job clears the alerts stored in the database.

deregisterChannel

Deregisters a registered custom channel.

Input Parameters

channelId Integer: Identifier of the channel that you want to deregister.

Output Parameters

Usage Notes

Channel IDs for custom channels are generated by the system and cannot be modified. The first custom channel gets 1001 as the channel ID and subsequent custom channels have consecutive numbers. Once a custom channel is deregistered, the channel ID is no longer available for a new custom channel until IBM webMethods Integration is restarted.

Deregistering a channel also deletes all the alerts for that channel.

getChannel

Gets the details of a specific channel.

Input Parameters

channelId Integer: Identifier of the channel that you want to retrieve.

Output Parameters

registerChannel

Registers a custom channel.

Input Parameters

The default value is true for custom channels as well as system channels other than Service Error and Server Error.

The default value is true for custom channels as well as system channels other than Service Error and Server Error.

Output Parameters

Usage Notes
For custom channels, channel IDs are generated by the system and cannot be modified. The first custom channel gets 1001 as the channel ID and subsequent custom channels have consecutive numbers. Once a custom channel is deregistered, the channel ID is no longer available for a new custom channel until IBM webMethods Integration is restarted.

updateChannel

Updates the settings of a channel.

Output Parameters

message: String. Indicateswhether the channel is successfully updated or not.

Usage Notes

Invoke the alert:updateChannel service to ignore a notification of a specific type or restore an ignored notification from IBM webMethods Integration Administrator.

severities

Lists the pre-defined severities that you can associate with an alert channel. The severity associated with an alert lets you assess the relative impact of a business event on the system.

Input Parameters None.

Output Parameters

B2B Utils services

generateResponse

Generates a response for the processing rule Call an integration action.

Note
generateResponse does not support large document.

Input Parameters

Output Parameters

constructSubmitInput

Prepare the necessary input used for submitting the business documents to IBM webMethods B2B product instance.

Input Parameters

Configuring an AS4 body

Document. To configure an AS4 body document. This is optional.

Configuring AS4 attachments [ ]

Document List. To configure AS4 attachments. This is optional.

Configuring AS4 params

Document. A document that provides parameters on how IBM webMethods B2B recognizes and processes a AS4 document. Configure AS4 params.

Configuring an RNIF body

Document. To configure an RNIF body document.

Configuring an RNIF attachments [ ]

Document List. To Configure a list of attachments to be use in RNIF message. This is optional.

Configuring an RNIF params

Document. A document that provides parameters on how IBM webMethods B2B recognizes and processes a RNIF document. Configure RNIF params.

Output Parameters

Output of constructSubmitInput operation is the input parameters for submit operation. See Submit.

parseContent

Parses request content passed by the processing rule Call an integration action as bytes or string data type. For more information, see Call an integration.

Note
parseContent does not support large document.

Input Parameters

Output Parameters

Compress Services

Use Compress services to compress the data before sending the HTTP request and decompress it after receiving the HTTP response.

The following Compress services are available:

Service Description
compressData Performs compression of data.
decompressData Performs decompression of data.

compressData

Compresses the data before sending the HTTP request using any of the specified compression schemes.

Input Parameters

Output Parameters

decompressData

Decompresses the data based on the response header of the HTTP response.

Input Parameters

Output Parameters

Date Services

Use Date services to generate and format date values.

Pattern String Symbols - Many of the Date services require you to specify pattern strings describing the data’s current format and/or the format to which you want it converted. For services that require a pattern string, use the symbols in the following table to describe the format of your data. For example, to describe a date in the January 15, 1999 format, you would use the pattern string MMMMM dd, yyyy. To describe the format 01/15/99, you would use the pattern string MM/dd/yy.

Symbol Meaning Presentation Example
G era designator Text AD
y year Number 1996 or 96
M month in year Text or Number July or Jul or 07
d day in month Number 10
h hour in am/pm (1-12) Number 12
H hour in day (0-23) Number 0
m minute in hour Number 30
s second in minute Number 55
S millisecond Number 978
E day in week Text Tuesday or Tue
D day in year Number 189
F day of week in month Number 2 (2nd Wed in July)
w week in year Number 27
W week in month Number 2
a am/pm marker Text PM
k hour in day (1-24) Number 24
K hour in am/pm (0-11) Number 0
z time zone Text Pacific Standard Time or PST or GMT-08:00
Z RFC 822 time zone (JVM 1.4 or later) Number -0800 (offset from GMT/UT)
escape for text Delimiter
’ ‘ single quote Literal '

Time Zones - When working with date services, you can specify time zones. The Earth is divided into 24 standard time zones, one for every 15 degrees of longitude. Using the time zone including Greenwich, England (known as Greenwich Mean Time, or GMT) as the starting point, the time is increased by an hour for each time zone east of Greenwich and decreases by an hour for each time zone west of Greenwich. The time difference between a time zone and the time zone including Greenwich, England (GMT) is referred to as the raw offset.

The following table identifies the different time zones for the Earth and the raw offset for each zone from Greenwich, England. The effects of daylight savings time are ignored in this table.

Note
Greenwich Mean Time (GMT) is also known as Universal Time (UT).
ID Raw Offset Name
MIT -11 Midway Islands Time
HST -10 Hawaii Standard Time
AST -9 Alaska Standard Time
PST -8 Pacific Standard Time
PNT -7 Phoenix Standard Time
MST -7 Mountain Standard Time
CST -6 Central Standard Time
EST -5 Eastern Standard Time
IET -5 Indiana Eastern Standard Time
PRT -4 Puerto Rico and U.S. Virgin Islands Time
CNT -3.5 Canada Newfoundland Time
AGT -3 Argentina Standard Time
BET -3 Brazil Eastern Time
GMT 0 Greenwich Mean Time
ECT +1 European Central Time
CAT +2 Central Africa Time
EET +2 Eastern European Time
ART +2 (Arabic) Egypt Standard Time
EAT +3 Eastern African Time
MET +3.5 Middle East Time
NET +4 Near East Time
PLT +5 Pakistan Lahore Time
IST +5.5 India Standard Time
BST +6 Bangladesh Standard Time
VST +7 Vietnam Standard Time
CTT +8 China Taiwan Time
JST +9 Japan Standard Time
ACT +9.5 Australian Central Time
AET +10 Australian Eastern Time
SST +11 Solomon Standard Time
NST +12 New Zealand Standard Time

Examples - You can specify timezone input parameters in the following formats:

The following Date services are available:

Service Description
calculateDateDifference Calculates the difference between two dates and returns the result as seconds, minutes, hours, and days.
compareDates Compares two dates and returns the result as integer.
currentNanoTime Returns the current value of the running Java Virtual Machine’s high-resolution time source, in nanoseconds.
dateBuild Builds a date String using the specified pattern and the specified date services.
dateTimeBuild Builds a date/time string using the specified pattern and the specified date services.
dateTimeFormat Converts date/time (represented as a String) string from one format to another.
elapsedNanoTime Calculates the time elapsed between the current time and the given time, in nanoseconds.
formatDate Formats a Date object as a string.
getCurrentDate Returns the current date as a Date object.
getCurrentDateString Returns the current date as a String in a specified format.
incrementDate Increments a date by a specified period.

calculateDateDifference

Calculates the difference between two dates and returns the result as seconds, minutes, hours, and days.

Input Parameters

Output Parameters

Usage Notes

Each output value represents the same date difference, but in a different scale. Do not add these values together. Make sure your subsequent flow service steps use the correct output, depending on the scale required.

compareDates

Compares two dates and returns the result as an integer.

Input Parameters

Output Parameters

Usage Notes

If the formats specified in the startDatePattern and endDatePattern parameters are different, IBM webMethods Integration takes the units that are not specified in the startDate and endDate values as 0.

That is, if the startDatePattern is yyyyMMdd HH:mm and the startDate is 20151030 11:11 and if the endDatePattern is yyyyMMdd HH:mm:ss.SSSand the endDate is 20151030 11:11:55:111, then the compareDates service considers start date to be before the end date and will return the result as -1.

To calculate the difference between two dates, use the calculateDateDifference service.

currentNanoTime

Returns the current value of the running Java Virtual Machine’s high-resolution time source, in nanoseconds. This method can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time. The value returned represents nanoseconds since some fixed but arbitrary origin time (perhaps in the future, so values may be negative). Use this service in-conjunction with elapsedNanoTime service.

Input Parameters

None.

Output Parameters

dateBuild

Builds a date String using the specified pattern and the specified date services.

Input Parameters

Output Parameters

dateTimeBuild

Builds a date/time string using the specified pattern and the specified date services.

Input Parameters

Output Parameters

dateTimeFormat

Converts date/time (represented as a String) string from one format to another.

Input Parameters

Output Parameters

Usage Notes

As described in the “Notes on Invalid Dates” section, if the pattern yy is used for the year, dateTimeFormat uses a 50-year moving window to interpret the value of the year.

If currentPattern does not contain a time zone, the value is assumed to be in the default time zone.

If newPattern contains a time zone, the default time zone is used.

elapsedNanoTime

Calculates the time elapsed between the current time and the given time, in nanoseconds.

Input Parameters

Output Parameters

formatDate

Formats a Date object as a string.

Input Parameters

Output Parameters

getCurrentDate

Returns the current date as a Date object.

Input Parameters

None.

Output Parameters

getCurrentDateString

Returns the current date as a String in a specified format.

Input Parameters

Output Parameters

incrementDate

Increments a date by a specified amount of time.

Input Parameters

Output Parameters

Usage Notes

The addYears, addMonths, addDays, addHours, addMinutes, addSeconds, and addMilliSeconds input parameters can take positive or negative values. For example, If startDate is 10/10/2001, startDatePattern is MM/dd/yyyy, addYears is 1, and addMonths is -1, endDate will be 09/10/2002.

If you specify only the startDate, startDatePattern, and endDatePattern input parameters and do not specify any of the optional input parameters to increment the period, the incrementDate service just converts the format of startDate from startDatePattern to endDatePattern and returns it as endDate.

The format of the date specified in the startDate parameter must match the format specified in the startDatePattern and the format of the date specified in the endDate parameter must match the endDatePattern format.

Datetime Services

Use Datetime services to build or increment a date/time. The services in datetime provide more explicit timezone processing than similar services in the date category.

Providing Time Zones

You can specify timezone input parameters to the datetime services in the following formats:

The following Datetime services are available:

Service Description
build Builds a date/time string using the specified pattern and the supplied date/time elements.
increment Increments or decrements a date and time by a specified amount of time.

build

Builds a date/time string using the specified pattern and the supplied date/time elements.

Input Parameters

Output Parameters

Usage Notes

The build service replaces the date:dateBuild and date:dateTimeBuild services which are deprecated.

If you specify a parameter that does not exist in the supplied pattern, the service ignores that parameter.

If you do not specify a timezone, useSystemTimeZone is set to false, and the pattern includes a time zone, the service ends with an exception.

If a time zone is provided as input to the service either in the timezone parameter or by setting useSystemTimeZone to true, the build service calculates the date/time starting with a “zoned” date/time. The resulting values can differ when daylight savings time transitions are in effect. If no time zone is provided as input to the service either by not specifying timezone or by setting useSystemTimeZone to false, then the build service calculates the date/time starting with an “unzoned” date/time.

The build service is similar to date:dateBuild and date:dateTimeBuild, however, the build service allows the building of a date/time that does not include a time zone. Furthermore, the build service assembles a date/time using each of the provided parameters. Consequently the build service can build a date/time with a value that would be invalid in the current time zone, such as a date/time that would fall into the gap of a daylight saving time transition. This is unlike the date:dateBuild and date:dateTimeBuild services which build a local java.util.Date object that uses the timezone of the machine running IBM webMethods Integration. The date:dateBuild and date:dateTimeBuild service then applies the offset between the local timezone and the specified timezone.

increment

Increments or decrements a date and time by a specified amount of time.

Input Parameters

Output Parameters

Usage Notes

The increment service replaces the date:incrementDate service which is deprecated.

The increment service can be used to decrement a date and time by specifying negative numbers. The addYears , addMonths , addDays , addHours , addMinutes , addSeconds , and addMilliSeconds input parameters can take positive or negative values.

The service ends with an exception if the format of the date specified in the startDate parameter does not match the format specified in the startDatePattern.

If endDatePattern includes a time zone, such as “z”, then the input string and startDatePattern must also have time zone fields, or timeZone must be set, or useSystemTimeZone must be true. Otherwise the service ends with an error.

If you specify only the startDate, startDatePattern, and endDatePattern input parameters and do not specify any of the optional input parameters to increment the period, the increment service just converts the format of startDate from startDatePattern to endDatePattern and returns it as endDate.

If you specify a value for timezone, the service ignores the useSystemTimeZone parameter value.

If you specify a value for timezone and the startDate includes a time zone, then the service uses the supplied timezone to convert the startDate time zone.

If you do not specify a value for timezone and the startDate includes a time zone, then the service uses the time zone in the startDate and ignores the useSystemTimeZone parameter.

If you do not specify a value for timezone, the startDate does not include a time zone, and useSystemTimeZone parameter is true, then the service uses the system time zone.

If startDate does not include a time zone, you do not specify a value for timezone, and useSystemTimeZone is false, the resulting endDate will not include a time zone.

The increment service is similar to date:incrementDate, however, the increment service provides more specific handling of time zones. To match the behavior of date:incrementDate, set useSameInstant to true.

Document Services

Use Document services to perform operations on documents.

The following Document services are available:

Service Description
bytesToDocument Converts an array of bytes to a document.
deleteDocuments Deletes the specified documents from a set of documents.
documentListToDocument Constructs a document from a document list by generating key/value pairs from the values of two elements that you specify in the document list.
documentToBytes Converts a document to an array of bytes.
documentToDocumentList Expands the contents of a document into a list of documents.
Each key/value pair in the source document is transformed to a single document containing two keys (whose names you specify). These two keys will contain the key name and value of the original pair.
findDocuments Searches a set of documents for entries matching a set of Criteria.
groupDocuments Groups a set of documents based on specified criteria.
insertDocument Inserts a new document in a set of documents at a specified position.
removeNullFields Removes null fields from a given document.
searchDocuments Searches a set of documents for entries matching a set of Criteria.
sortDocuments Sorts a set of input documents based on the specified sortCriteria.

bytesToDocument

Converts an array of bytes to a document. This service can only be used with byte arrays created by executing the documentToBytes service.

Input Parameters

Output Parameters

Usage Notes

Use this service with the documentToBytes service, which converts a document into a byte array. You can pass the resulting byte array to the bytesToDocument service to convert it back into the original document.

In order for the document-to-bytes-to-document conversion to work, the entire content of the document must be serializable. Every object in the document must be of a data type known to IBM webMethods Integration, or it must support the java.io.Serializable interface.

If IBM webMethods Integration encounters an unknown object in the document that does not support the java.io.Serializable interface, that object’s value will be lost. It will be replaced with a string containing the object’s class name.

deleteDocuments

Deletes the specified documents from a set of documents.

Input Parameters

Output Parameters

Usage Notes

The deleteDocuments service returns an error if the indices parameter value is less than zero or more than the number of documents in the documents input parameter.

documentListToDocument

Constructs a document from a document list by generating key/value pairs from the values of two elements that you specify in the document list.

Input Parameters

Output Parameters

Usage Notes

The following example illustrates how the documentListToDocument service would convert a document list that contains three documents to a single document containing three key/value pairs. When you use the documentListToDocument service, you specify which two elements from the source list are to be transformed into the keys and values in the output document. In the following example, the values from the pName elements in the source list are transformed into key names, and the values from the pValue elements are transformed into the values for these keys.

A documentList containing these three documents:

Key Value
pName cx_timeout
pValue 1000
Key Value
pName cx_max
pValue 2500
Key Value
pName cx_min
pValue 10

Would be converted to a document containing these three keys:

Key Value
cx_timeout 1000
cx_max 2500
cx_min 10

documentToBytes

Converts a document to an array of bytes.

Input Parameters

Output Parameters

Usage Notes

Use the documentToBytes service with the bytesToDocument service, which converts the byte array created by this service back into the original document.

The documentToBytes service is useful when you want to write a document to a file, an input stream, or a cache.

In order for the document-to-bytes-to-document conversion to work, the entire content of the document must be serializable. Every object in the document must be of a data type known to IBM webMethods Integration, or it must support the java.io.Serializable interface. If IBM webMethods Integration encounters an unknown object in the document that does not support the java.io.Serializable interface, that object’s value will be lost. IBM webMethods Integration will replace it with a string containing the object’s class name.

documentToDocumentList

Expands the contents of a document into a list of documents.

Each key/value pair in the source document is transformed to a single document containing two keys (whose names you specify). These two keys will contain the key name and value of the original pair.

Input Parameters

Output Parameters

Usage Notes

The following example shows how a document containing three keys would be converted to a document list containing three documents. In this example, the names pName and pValue are specified as names for the two new keys in the document list.

A document containing these three keys:

Key Value
cx_timeout 1000
cx_max 2500
cx_min 10

Would be converted to a document list containing these three documents:

Key Value
pName cx_timeout
pValue 1000
Key Value
pName cx_max
pValue 2500
Key Value
pName cx_min
pValue 10

findDocuments

Searches a set of documents for entries matching a set of criteria.

Input Parameters

Output Parameters

groupDocuments

Groups a set of documents based on specified criteria.

Input Parameters

Output Parameters

Usage Notes

The following example illustrates how to specify the values for the groupCriteria parameter:

key compareStringsAs pattern
name string
age numeric
birthdate datetime yyyy-MM-dd

The input documents will be grouped based on name, age, and birth date.

insertDocument

Inserts a new document in a set of documents at a specified position.

Input Parameters

Output Parameters

removeNullFields

Removes null fields from a given document. Optionally, by specifying trimStringFields and removeEmptyStringFields, you can trim leading and trailing spaces in a string field, and after trimming the fields, if the string field length is zero, they can be removed. For array fields, it reduces the size of the array by the number of null fields. After removing all the null fields, if the size is zero, the array field is removed from the given document.

Note
Use this operation carefully as it is a destruction operation and removes the fields from the given document. For trimming string fields, a space character is defined as any character whose codepoint is less than or equal to U+0020 (the space character).

Input Parameters

Output Parameters

searchDocuments

Searches a set of documents for entries matching a set of Criteria.

Input Parameters

Output Parameters

Usage Notes

For example, if you want to search a set of documents for documents where BirthDate is 10th January 2008, the values for the searchCriteria parameter would be:

key value compareStringsAs pattern
Birthdate 2008-01-10 datetime yyyy-MM-dd

sortDocuments

Sorts a set of input documents based on the specified sortCriteria.

Input Parameters

Output Parameters

Usage Notes

For example, if you want to sort a set of documents based on name, age, and then on birth date, the values for sortCriteria parameter would be:

key order compareStringsAs pattern
Name ascending string  
Age descending numeric  
Birthdate ascending datetime yyyy-MM-dd

Flat File Services

Use Flat File services to convert data bytes, data stream, and data string to a document and vice versa.

The following Flat File services are available:

Service Description
delimitedDataBytesToDocument Converts delimited data bytes (byte array) to a document.
delimitedDataStreamToDocument Converts delimited data stream to a document.
delimitedDataStringToDocument Converts delimited data string to a document.
documentToDelimitedDataBytes Converts a document to delimited data bytes (byte array object).
documentToDelimitedDataStream Converts a document to a delimited data stream.
documentToDelimitedDataString Converts a document to a delimited data string.

delimitedDataBytesToDocument

Converts delimited data bytes (byte array) to a document.

Input Parameters

Output Parameters

delimitedDataStreamToDocument

Converts delimited data stream to a document. The permissible size of the content stream is based on your tenancy.

Input Parameters

Output Parameters

delimitedDataStringToDocument

Converts delimited data string to a document.

Input Parameters

Output Parameters

documentToDelimitedDataBytes

Converts a document to delimited data bytes (byte array object).

Input Parameters

Output Parameters

documentToDelimitedDataStream

Converts a document to a delimited data stream.

Input Parameters

Output Parameters

documentToDelimitedDataString

Converts a document to a delimited data string.

Input Parameters

Output Parameters

Flow Services

Use flow services to perform utility-type tasks.

The following flow services are available:

Service Description
clearPipeline Removes all fields from the pipeline. You may optionally specify fields that should not be cleared by this service.
countProcessedDocuments Counts the number of documents processed by a flow service. Details about the processed documents can be viewed in the Execution Results screen.
getHTTPRequest Gets information about the HTTP request, received by IBM webMethods Integration.
getLastError Obtains detailed information about the last error that was trapped within a flow service.
getLastFailureCaught Returns information about the last failure that was caught by a CATCH step.
getSessionInfo Obtains detailed information about the current logged-in user session. Also provides the current flow service name and the execution result reference identifier.
getRetryCount Retrieves the retry count and the maximum retry count for a service.
logCustomMessage Logs a message, which can be viewed in the Execution Results screen.
setCustomContextID Associates a custom value with an auditing context. You can use the custom value to search for flow service executions based on the custom ID in the IBM webMethods Integration Monitor screen.
setHTTPResponse Sets the HTTP response information to be returned by IBM webMethods Integration.
sleep Causes the currently executing flow service to pause for the specified number of seconds.
throwExceptionForRetry Throws an ISRuntimeException and instructs the to re-execute a service using the original service input.

clearPipeline

Removes all fields from the pipeline. You may optionally specify fields that should not be cleared by this service.

Input Parameters

Output Parameters

None.

countProcessedDocuments

Counts the number of documents processed by a flow service. Details about the processed documents can be viewed in the Execution Results screen.

Input Parameters

Output Parameters

None.

Usage Notes

To increment the number of documents processed by a list, use the sizeOfList service in the List service category.

getHTTPRequest

Retrieves information about the HTTP request, received by IBM webMethods Integration.

Input Parameters

None.

Output Parameters

getLastError

Obtains detailed information about the last error that was trapped within a flow service.

Input Parameters

None.

Output Parameters

Usage Notes

You can use this service in the catch section of the try-catch block. Each execution of a flow service or a service (whether the flow service or the service succeeds or fails) updates the value returned by getLastError. Consequently, getLastError itself resets the value of lastError. Therefore, if the results of getLastError will be used as input to subsequent flow services, map the value of lastError to a variable in the pipeline.

If a map has multiple transformers, then a subsequent call to getLastError will return the error associated with the last failed transformer in the map, even if it is followed by successful transformers.

getLastFailureCaught

Returns information about the last failure that was caught by a CATCH step.

Input Parameters

None.

Output Parameters

Usage Notes

If a CATCH step can handle multiple failures, use the getLastFailureCaught service to determine which failure the step caught.

You can rethrow a caught failure by using the getLastFailureCaught service to determine the failure caught by the CATCH step, then use an EXIT step that is configured to signal failure to rethrow the failure. getLastFailureCaught need not be executed within a CATCH step. The service returns the caught failure any time after it has been invoked.

getSessionInfo

Obtains detailed information about the current logged-in user session. Also provides the current flow service execution result reference identifier.

Input Parameters

None.

Output Parameters


​ - CustomContextID: String - Returns the current flow service execution context ID. You can set the context ID in a flow service by using the setCustomContextID service available under the Flow category. ​
​ - integrationName: String - The name of the flow service. If flow service A has a referenced flow service B, and if the getSessionInfo service is called in flow service B, then integrationName will be A but if flow service B is executed independently, then integrationName will be B. ​
​ - executionResultReference: String - Returns the current flow service execution result reference identifier. For example, you can pass the identifier to an on-premises operation and trace the flow service execution.

getRetryCount

Retrieves the retry count and the maximum retry count for a flow service.

The retry count indicates the number of times the IBM webMethods Integration system has re-executed a flow service. For example, a retry count of 1 indicates that the IBM webMethods Integration system tried to execute the flow service twice (the initial attempt and then one retry).

The maximum retry count indicates the maximum number of times the IBM webMethods Integration system can re-execute the flow service if it continues to fail because of a transient error.

Input Parameters

None.

Output Parameters

Usage Notes

Although the getRetryCount service can be invoked at any point in a flow service, the getRetryCount service retrieves retry information for the flow service when invoked by a subscriber. The getRetryCount service does not retrieve retry information for a nested flow service (a flow service that is invoked by another flow service).

The maximum number of times IBM webMethods Integration retries a flow service depends on the retry properties set in the subscriber that invokes the flow service.

logCustomMessage

Logs a message, which can be viewed in the Execution Results screen.

Input Parameters

Output Parameters

None.

setCustomContextID

Associates a custom value with an auditing context. This custom value can be used to search for flow service executions in the Monitor screen.

Input Parameters

Output Parameters

None.

Usage Notes

setHTTPResponse

Sets the HTTP response information to be returned by IBM webMethods Integration.

Input Parameters

Output Parameters

None.

Note
When working with a flow service, always set the responseString parameter in the setHTTPResponse service as the last step. This is so because the flow service does not run in debug mode as the setHTTPResponse service stops it when the responseString parameter is set. However, the setHTTPResponse service can be used at any step in a flow service if responseString is not being set.

sleep

Causes the currently executing flow service to pause for the specified number of seconds.

Input Parameters

Output Parameters

None.

throwExceptionForRetry

Throws an exception and instructs IBM webMethods Integration to re-execute the flow service using the original service input.

Input Parameters

Output Parameters

None.

Usage Notes

Use the throwExceptionForRetry service to handle transient errors that might occur during flow service execution. A transient error is an error that arises from a condition that might be resolved quickly, such as the unavailability of a resource due to network issues or failure to connect to a database. The flow service might execute successfully if IBM webMethods Integration waits and then retries the flow service. If a transient error occurs, the flow service can catch this error and invoke throwExceptionForRetry to instruct the to retry the service.

The throwExceptionForRetry service must be used for transient errors only.

Only top-level services or subscribers can be retried. That is, a service can be retried only when it is invoked directly by a client request or by a subscriber. The service cannot be retried when it is invoked by another flow service (that is, when it is a nested flow service).

You can invoke the getRetryCount service to retrieve the current retry count and the maximum specified retry attempts.

Hashtable Services

Use Hashtable services to create, update, and obtain information about the hashtable.

The following Hashtable services are available:

Service Description
containsKey Checks for the existence of a hashtable element.
createHashtable Creates a hashtable object.
get Gets the value for a specified key in the hashtable.
listKeys Lists all the keys stored in the hashtable.
put Adds a key/value pair in the hashtable.
remove Removes a key/value pair from the hashtable.
size Gets the number of elements in the hashtable.

containsKey

Checks for the existence of a hashtable element.

Input Parameters

Output Parameters

createHashtable

Creates a hashtable object.

Input Parameters

None.

Output Parameters

get

Gets the value for a specified key in the hashtable.

Input Parameters

Output Parameters

listKeys

Lists all the keys stored in the hashtable.

Input Parameters

Output Parameters

put

Adds a key/value pair in the hashtable.

Input Parameters

Output Parameters

remove

Removes a key/value pair from the hashtable.

Input Parameters

Output Parameters

size

Gets the number of elements in the hashtable.

Input Parameters

Output Parameters

IO Services

Use IO services to convert data between byte[ ], characters, and InputStream representations. These services are used for reading and writing bytes, characters, and streamed data to the file system and behave like the corresponding methods in the java.io.InputStream class. These services can be invoked only by other services. Streams cannot be passed between clients and the server, so these services will not run if they are invoked from a client.

The following IO services are available:

Service Description
bytesToStream Converts a byte[ ] to java.io.ByteArrayInputStream.
close Closes an InputStream or a reader object and releases the resources.
createByteArray Creates a byte array of the specified length.
mark Marks the current position in the InputStream or reader object.
markSupported Enables you to test whether your InputStream or reader object supports the mark and reset operations.
read Reads a specified number of bytes from the InputStream and stores them into a buffer.
readAsString Reads the data from a reader object and converts it to a string.
reset Repositions the InputStream or the reader object to the position at the time the mark service was last invoked on the stream.
skip Skips over and discards the specified number of bytes or characters from the input stream or a reader object.
streamToBytes Creates a byte[ ] from data that is read from an InputStream.
streamToReader Converts a java.io.InputStream to a java.io.Reader object.
streamToString Creates a string from data that is read from an InputStream.
stringToReader Converts a string object to a String Reader object.
stringToStream Converts a string to a binary stream.

bytesToStream

Converts a byte[ ] to java.io.ByteArrayInputStream.

Input Parameters

Output Parameters

Usage Notes

This service constructs stream from the byte array using the constructor ByteArrayInputStream(byte[ ]). This constructor does not make a copy of the byte array, so any changes to bytes will be reflected in the data read from the stream.

close

Closes an InputStream or a reader object and releases the resources.

Input Parameters

Note
You can use either inputStream or reader to specify the input object. If both the input parameters are provided, then both the objects will be closed.

Output Parameters

None.

Usage Notes

If the InputStream is already closed, invoking this service has no effect. However, leaving an InputStream open may cause errors that may not be recoverable. Use the close service to explicitly close the input stream when a service leaves it open.

createByteArray

Creates a byte array of the specified length.

Input Parameters

Output Parameters

Usage Notes

The read service reads data from an InputStream into a byte array. You can use this service to create the byte array. Invoking this service is the equivalent of the Java code new byte[length].

mark

Marks the current position in the InputStream or reader object. A subsequent call to reset repositions this stream at the last marked position. Marking and respositioning the input stream allows subsequent service calls to re-read the same bytes.

Input Parameters

Note
You can use either stream or reader to specify the input object. If both stream and reader input parameters are provided, then both the objects will be marked.

Output Parameters

Usage Notes

If the InputStream does not support the mark operation, invoking this service has no effect.

Either of the optional input parameters, stream or reader, is required.

markSupported

Enables you to test whether your InputStream or reader object supports the mark and reset operations.

Input Parameters

Output Parameters

Usage Notes

Either of the input parameters, stream or reader, is required.

read

Reads a specified number of bytes from the InputStream and stores them into a buffer.

Input Parameters

Output Parameters

readAsString

Reads the data from a reader object and returns the contents as a string.

Input Parameters

Output Parameters

Usage Notes

The readAsString service does not automatically close the reader object. To close the reader, use the close service.

readerToString

Reads the data from a reader object and converts it to a string.

Input Parameters

Output Parameters

Usage Notes

The readerToString service does not automatically close the reader object. To close the reader, use the close service.

reset

Repositions the InputStream or the reader object to the position at the time the mark service was last invoked on the stream.

Input Parameters

Output Parameters

Usage Notes

If the InputStream does not support the reset operation, invoking this service has no effect.

Either of the input parameters, stream or reader, is required.

skip

Skips over and discards the specified number of bytes or characters from the input stream or a reader object.

Input Parameters

Note
You can use either stream or reader to specify the input object. If both stream and reader input parameters are provided, then the stream and reader object data will be skipped.

Output Parameters

Usage Notes

The Skip service uses the Java methodskip, which might skip some smaller number of bytes, possibly zero (0). This happens due to conditions such as reaching the end of file before n bytes have been skipped. For more information about the skip method, see the Java documentation on the InputStream class.

Either of the optional input parameters, stream or reader, is required.

If both stream and reader input parameters are specified and if an exception occurs during the stream object usage, then the operations are not performed on the reader object also.

streamToBytes

Creates a byte[ ] from data that is read from an InputStream.

Input Parameters

Output Parameters

Usage Notes

This service reads all of the bytes from stream until the end of file is reached, and then it closes the InputStream.

streamToReader

Converts a java.io.InputStream to a java.io.Reader object.

Input Parameters

Output Parameters

streamToString

Creates a string from data that is read from an InputStream.

Input Parameters

Output Parameters

stringToReader

Converts a string object to a StringReader object.

Input Parameters

Output Parameters

stringToStream

Converts a string to a binary stream.

Input Parameters

Output Parameters

JSON Services

Use JSON services to convert JSON content into a document and to convert a document into JSON content.

The following JSON services are available:

Service Description
closeArrayIterator Closes the iteration. The iterator object used in an iteration cannot be reused after this service runs.
documentToJSONBytes Converts a document to JSON bytes (byte array).
documentToJSONStream Converts a document to a JSON stream.
documentToJSONString Converts a document to a JSON string.
getArrayIterator Returns a batch iterator object.
getNextBatch Gets the next batch of array elements by parsing the array paths in the iterator object returned by the getArrayIterator service.
jsonBytesToDocument Converts JSON content in bytes (byte array) to a document.
jsonStreamToDocument Converts content from the JSON content stream to a document.
jsonStringToDocument Converts content from the JSON string to a document.

closeArrayIterator

Closes the iteration. The iterator object used in an iteration cannot be reused after this service runs.

Input Parameters

Output Parameters

None.

documentToJSONBytes

Converts a document to JSON bytes (byte array).

Input Parameters

Output Parameters

documentToJSONStream

Converts a document to a JSON stream.

Input Parameters

Output Parameters

documentToJSONString

Converts a document to a JSON string.

Input Parameters

Output Parameters

getArrayIterator

Returns a batch iterator object.

Input Parameters




"topping": [{ 
            "toppingA": [{ 
                    "toppingA1": ["None71", "Glazed82"] 
... 
                }]}]
                
Note
This parameter must have only array paths. You must not enter individual array elements or other fields.
Array paths must follow the JSON pointer syntax.

Output Parameters

Usage Notes

None.

getNextBatch

Gets the next batch of array elements by parsing the array paths in the iterator object returned by the getArrayIterator service. This service returns the array elements in batches based on the batch size provided in the input. The batch size can vary across invocations of this service. A batch is a set of elements that can be retrieved from an array path at once, based on the batch size. To retrieve the remaining elements in the array path or elements from the next array path in the iterator, invoke the service in a loop until there are no more array paths to iterate.

Input Parameters

Output Parameters

Usage Notes

The getNextBatch service completes the retrieval of elements from one array in the iterator and starts retrieving from the next array that matches in the subsequent iteration. This is explained in the following example:

Suppose you want the service to parse a JSON file with 2 arrays, for example, A and B with 6 and 2 elements each. Set the batchSize input parameter to 5 and invoke the service in a loop until the service returns the hasNext parameter as false. In the first batch of the output, the first 5 elements of the array A are returned and in the next batch, only the last element of the array A is returned, even though the batch size is 5. At this point, the hasNext parameter is true because array B is not parsed yet. In the next batch, the service returns both the elements of array B. Since there are no more elements left either in the array A or B, the hasNext parameter becomes false.

Guidelines

jsonBytesToDocument

Converts JSON content in bytes (byte array) to a document.

Input Parameters

Output Parameters

jsonStreamToDocument

Converts content from the JSON content stream to a document. The permissible size of the content stream is based on your tenancy.

Input Parameters

Output Parameters

jsonStringToDocument

Converts content from the JSON content string to a document.

Input Parameters

Output Parameters

List Services

Use List services to retrieve, replace, or add elements in an Object List, Document List, or String List, including converting String Lists to Document Lists.

The following List services are available:

Service Description
addItemToVector Adds an item or a list of items to a java.util.Vector object.
appendToDocumentList Adds documents to a document list.
appendToStringList Adds Strings to a String list.
sizeOfList Returns the number of elements in a list.
stringListToDocumentList Converts a String list to a document list.
vectorToArray Converts a java.util.Vector object to an array.

addItemToVector

Adds an item or a list of items to a java.util.Vector object.

Input Parameters

Note
You can use either item or itemList to specify the input object. If both item and itemList input parameters are specified, the item as well as the list of items will be added to the vector object.

Output Parameters

Usage Notes

Either of the optional input parameters, item or itemList, is required.

appendToDocumentList

Adds documents to a document list.

Input Parameters

Output Parameters

Usage Notes

The documents contained in fromList and fromItem are not actually appended as entries to toList. Instead, references to the documents in fromList and fromItem are appended as entries to toList. Consequently, any changes made to the documents in fromList and fromItem also affect the resulting toList.

appendToStringList

Adds Strings to a String list.

Input Parameters

Output Parameters

Usage Notes

The Strings contained in fromList and fromItem are not actually appended as entries to toList. Instead, references to the Strings in fromList and fromItem are appended as entries to toList. Consequently, any changes made to the Strings in fromList and fromItem also affect the resulting toList.

sizeOfList

Returns the number of elements in a list.

Input Parameters

Output Parameters

Usage Notes

For example, if fromList consists of:

The result would be:

stringListToDocumentList

Converts a String list to a document list.

Input Parameters

Output Parameters

Usage Notes

Creates a document list containing one document for each element in the fromList. Each document will contain a single String element named key.

vectorToArray

Converts a java.util.Vector object to an array.

Input Parameters

Output Parameters

Math Services

Use Math services to perform mathematical operations on string-based numeric values. Services that operate on integer values use Java’s long data type (64-bit, two’s complement). Services that operate on float values use Java’s double data type (64-bit IEEE 754). If extremely precise calculations are critical to your application, you should write your own Java services to perform math functions.

The following Math services are available:

Service Description
absoluteValue Returns the absolute value of the input number.
addFloatList Adds a list of floating point numbers (represented in a string list) and returns the sum.
addFloats Adds one floating point number (represented as a String) to another and returns the sum.
addIntList Adds a list of integers (represented in a String list) and returns the sum.
addInts Adds one integer (represented as a String) to another and returns the sum.
addObjects Adds one java.lang.Number object to another and returns the sum.
divideFloats Divides one floating point number (represented as a String) by another (num1/num2) and returns the quotient.
divideInts Divides one integer (represented as a String) by another (num1/num2) and returns the quotient.
divideObjects Divides one java.lang.Number object by another (num1/num2) and returns the quotient.
max Returns the largest number from a list of numbers.
min Returns the smallest number from a list of numbers.
multiplyFloatList Multiplies a list of floating point numbers (represented in a String list) and returns the product.
multiplyFloats Multiples one floating point number (represented as String) by another and returns the product.
multiplyIntList Multiplies a list of integers (represented in a String list) and returns the product.
multiplyInts Multiplies one integer (represented as a String) by another and returns the product.
multiplyObjects Multiplies one java.lang.Number object by another and returns the product.
randomDouble Returns the next pseudorandom, uniformly distributed double between 0.0 and 1.0.
roundNumber Returns a rounded number.
subtractFloats Subtracts one floating point number (represented as a String) from another and returns the difference.
subtractInts Subtracts one integer (represented as a String) from another and returns the difference.
subtractObjects Subtracts one java.lang.Number object from another and returns the difference.
toNumber Converts a string to numeric data type.

absoluteValue

Returns the absolute value of the input number.

Input Parameters

Output Parameters

addFloatList

Adds a list of floating point numbers (represented in a string list) and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in numList are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

addFloats

Adds one floating point number (represented as a String) to another and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

addIntList

Adds a list of integers (represented in a String list) and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in numList are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

addInts

Adds one integer (represented as a String) to another and returns the sum.

Input Parameters

Output Parameters

Usage Notes

Ensure that the result of your calculation is less than 64 bits in width (the maximum width for the long data type). If the result exceeds this limit, it will generate a data overflow.

Ensure that the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

addObjects

Adds one java.lang.Number object to another and returns the sum.

Input Parameters

Output Parameters

Usage Notes

This service accepts the following sub-classes of java.lang.Number: java.lang.Byte, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short.

This service applies the following rules for binary numeric promotion to the operands in order:

These promotion rules mirror the Java rules for numeric promotion of numeric types.

divideFloats

Divides one floating point number (represented as a String) by another (num1/num2) and returns the quotient.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

divideInts

Divides one integer (represented as a String) by another (num1/num2) and returns the quotient.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

divideObjects

Divides one java.lang.Number object by another (num1/num2) and returns the quotient.

Input Parameters

Output Parameters

Usage Notes

This service accepts the following sub-classes of java.lang.Number: java.lang.Byte, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short.

This service applies the following rules for binary numeric promotion to the operands in order:

These promotion rules mirror the Java rules for numeric promotion of numeric types.

max

Returns the largest number from a list of numbers.

Input Parameters

Output Parameters

min

Returns the smallest number from a list of numbers.

Input Parameters

Output Parameters

multiplyFloatList

Multiplies a list of floating point numbers (represented in a String list) and returns the product.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in numList are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

multiplyFloats

Multiples one floating point number (represented as String) by another and returns the product.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

multiplyIntList

Multiplies a list of integers (represented in a String list) and returns the product.

Input Parameters

Output Parameters

Usage Notes

Make sure the result of your calculation is less than 64 bits in width (the maximum width for the long data type). If the result exceeds this limit, it will generate a data overflow.

Make sure the strings that are passed to the service in numList are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

multiplyInts

Multiplies one integer (represented as a String) by another and returns the product.

Input Parameters

Output Parameters

Usage Notes

Make sure the result of your calculation is less than 64 bits in width (the maximum width for the long data type). If the result exceeds this limit, it will generate a data overflow.

Make sure the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

multiplyObjects

Multiplies one java.lang.Number object by another and returns the product.

Input Parameters

Output Parameters

Usage Notes

This service accepts the following sub-classes of java.lang.Number: java.lang.Byte, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short.

This service applies the following rules for binary numeric promotion to the operands in order:

These promotion rules mirror the Java rules for numeric promotion of numeric types.

randomDouble

Returns the next pseudorandom, uniformly distributed double between 0.0 and 1.0.

Random number generators are often referred to as pseudorandom number generators because the numbers produced tend to repeat themselves over time.

Input Parameters

Output Parameters

roundNumber

Returns a rounded number.

Input Parameters

Output Parameters

subtractFloats

Subtracts one floating point number (represented as a String) from another and returns the difference.

Input Parameters

Output Parameters

Usage Notes

Make sure the strings that are passed to the service in num1andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

subtractInts

Subtracts one integer (represented as a String) from another and returns the difference.

Input Parameters

Output Parameters

Usage Notes

Make sure the result of your calculation is less than 64 bits in width (the maximum width for the long data type). If the result exceeds this limit, it will generate a data overflow.

Make sure the strings that are passed to the service in num1 andnum2 are in a locale-neutral format (that is, using the pattern -####.##). Passing locally formatted strings may result in unexpected results. For example, calling addFloats in a German locale with the arguments 1,23 and 2,34 will result in the value 357, not 3.57 or 3,57.

subtractObjects

Subtracts one java.lang.Number object from another and returns the difference.

Input Parameters

Output Parameters

Usage Notes

This service accepts the following sub-classes of java.lang.Number: java.lang.Byte, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short.

This service applies the following rules for binary numeric promotion to the operands. The following rules are applied in order:

These promotion rules mirror the Java rules for numeric promotion of numeric types.

toNumber

Converts a string to numeric data type.

Input Parameters

Output Parameters

MIME Services

Use MIME services to create MIME messages and extract information from MIME messages.

The following MIME services are available:

Service Function
addBodyPart Adds a body part (header fields and content) to a specified MIME object.
addMimeHeader Adds one or more header fields to a specified MIME object.
createMimeData Creates a MIME object.
getBodyPartContent Retrieves the content (payload) from the specified MIME object.
getBodyPartHeader Returns the list of header fields for the specified body part.
getContentType Returns the value of the Content-Type message header from the specified MIME object.
getEnvelopeStream Generates an InputStream representation of a MIME message from a specified MIME object.
getMimeHeader Returns the list of message headers from a specified MIME object.
getNumParts Returns the number of body parts in the specified MIME object.
getPrimaryContentType Returns the top-level portion of a MIME object’s Content-Type value.
getSubContentType Returns the sub-type portion of a MIME object’s Content-Type value.
mergeHeaderAndBody Concatenates the contents of the header and body mapped to the input.

addBodyPart

Adds a body part (header fields and content) to a specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

The way in which the contenttype and encoding parameters are applied depends on whether the finished message is single-part or multipart.

For single-part messages:

For multipart messages:

addMimeHeader

Adds one or more header fields to a specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

If you add MIME headers before you add multiple body parts, the header fields will be added to each of the body parts. If you do not want this behavior, either drop mimeHeader from the pipeline immediately after you execute addMimeHeader, or invoke addMimeHeader after you’ve added all body parts to the MIME object.

Be aware that the contenttype and encoding parameters used by the addBodyPart service will override any Content-Type or Content-Transfer-Encoding settings in mimeData. Moreover, in certain cases, the getEnvelopeStream will override these settings when it generates a multipart message. For information about how the Content-Type or Content-Transfer-Encoding headers are derived at run time, see the Usage Notes under addBodyPart.

createMimeData

Creates a MIME object.

If no input parameter is passed to this service, the service creates an empty MIME object. Otherwise, the service creates a MIME object containing the elements (header fields and content) from the MIME message in input.

Input Parameters

Output Parameters

Usage Notes

All of the other MIME services operate on the mimeData IData object produced by this service. They do not operate directly on MIME message streams.

Important
You can examine the contents of mimeData during testing and debugging. However, because the internal structure of mimeData is subject to change without notice, do not explicitly set or map data to/from these elements in your service. To manipulate or access the contents of mimeData, use only the MIME services that is provided.

getBodyPartContent

Retrieves the content (payload) from the specified MIME object.

You use this service for both single-part and multi-part messages.

To retrieve content from a multi-part message, you set the index (to select the part by index number) or contentID (to select the part by contentID value) parameter to specify the body part whose content you want to retrieve. To get the content from a single-part message, you omit the index and contentID parameters or set index to 0.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

If you omit index or contentID when retrieving content from a multi-part message, getBodyPartContent returns the payload from the first body part. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.

getBodyPartHeader

Returns the list of header fields for the specified body part.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

If you omit index or contentID, getBodyPartHeader returns the message headers from the first body part. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.

getContentType

Returns the value of the Content-Type message header from the specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

getEnvelopeStream

Generates an InputStream representation of a MIME message from a specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

If you omit index or contentID, getEnvelopeStream generates the MIME message from the entire contents of the mimeData. If you use index or contentID to select a body part that does not exist in mimeData, content will be null.

getEnvelopeStream automatically inserts the MIME-Version and Message-ID message headers into the MIME message it puts into envStream.

getMimeHeader

Returns the list of message headers from a specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

getNumParts

Returns the number of body parts in the specified MIME object.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

getPrimaryContentType

Returns the top-level portion of a MIME object’s Content-Type value.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

getSubContentType

Returns the sub-type portion of a MIME object’s Content-Type value.

Input Parameters

Output Parameters

Usage Notes

This service operates on the MIME object (mimeData) produced by createMimeData.

mergeHeaderAndBody

Concatenates the contents of the header and body mapped to the input.

You can use this service to reassemble the message into its original form so that it can be used as input to the createMimeData service (or any other service that requires the entire http response as an InputStream).

Input Parameters

Output Parameters

Usage Notes

Use this service to merge the Headers and Body to get the original MIME message.

Schema Services

Use Schema services to validate objects and to validate the pipeline.

The following Schema services are available:

Service Description
validate Validates an object using an IS document type or a schema.
validatePipeline Validates the pipeline against a document type.

validate

Validates an object using an IS document type, XML document type, or an IS schema. .

Input Parameters

Output Parameters

Usage Notes

validatePipeline

Validates the pipeline against a document type.

Input Parameters

Output Parameters

Storage Services

Use Storage services to insert, retrieve, update, and remove entries from a data store.

When using the storage services, keep in mind that the short-term store is not intended to be used as a general-purpose storage engine. Rather, it is primarily provided to support shared storage of application resources and transient data in IBM webMethods Integration. It is recommended not to use the short-term store to process high volumes, large data records, or to permanently archive records.

Note
User specific data which may be considered as personal data will be stored and retained till the retention period defined in Execution Results.

These services are a tool for maintaining state information in the short-term store. It is up to the developer of the flow service to make sure that the flow service keeps track of its state and correctly handles restarts.

Locking Considerations

The following sections describe in general how the storage services handle locking requests.

Entry Locking

To maintain data integrity, the short-term store uses locking to ensure that multiple threads do not modify the same entry at the same time. For insertions and removals, the short-term store sets and releases the lock. For updates, the client must set and release the lock. Using locking improperly, that is, creating a lock but not releasing it, can cause deadlocks in the short-term store.

The following guidelines can help you avoid short-term store deadlocks:

Data Store Locking

When a storage service locks an entry, the service also implicitly locks the data store in which the entry resides. This behavior prevents another thread from deleting the entire data store and the entries it contains while your thread is working with the entry. When the locked entry is unlocked, the implicit lock on the data store is also released.

Be careful when explicitly unlocking data stores. Consider the following example:

  1. User_A locks an item. This creates two locks: an explicit lock on the entry, and an implicit lock on the data store.

  2. User_A later unlocks the data store explicitly while still holding the lock on the entry.

  3. User_B locks, then deletes the data store, including the entry locked by User_A in the first step.

When User_A explicitly unlocked the data store in step 2, User_B was able to delete the entry the User_A was working with.

Automatic Promotion to Exclusive Lock

If a storage service tries to acquire an exclusive lock on an object, but finds a shared lock from the same thread already in place on the object, the service will try to promote the lock to an exclusive lock.

If a storage service that requires an exclusive lock encounters a shared or exclusive lock held by another thread, it will wait until the object becomes available. If the object remains locked for the period specified by the waitlength parameter passed by the service, the service will fail.

Sample Flow service for Checkpoint Restart

The following diagram shows how to create checkpoint restarts into your flow services. It explains the logic of a flow service and shows where the various storage services are used to achieve checkpoint restarts.

The following Storage services are available:

Service Description
add Inserts a new entry into a data store.
deleteStore Deletes a data store and all its contents. Any data in the data store is deleted. If the data store does not exist, the service takes no action.
get Retrieves a value from a data store and locks the entry and the data store on behalf of the thread that invoked the service.
keys Obtains a list of all the keys in a data store.
lock Locks an entry and/or data store on behalf of the thread invoking this service.
put Inserts or updates an entry in a data store. If the key does not exist in the data store, the entry is inserted.
remove Removes an entry from a data store.
unlock Unlocks an entry or a data store.

add

Inserts a new entry into a data store.

If the key already exists in the data store, the service does nothing.

Input Parameters

Output Parameters

deleteStore

Deletes a data store and all its contents. Any data in the data store is deleted. If the data store does not exist, the service takes no action.

Input Parameters

Output Parameters

Usage Notes

This service obtains an exclusive lock on the data store, but no locks on the individual entries in the data store. If this service finds a shared lock from the same thread on the data store, the service will automatically promote the lock to an exclusive lock. The exclusive lock prevents other threads from acquiring locks on the data store or entries within the data store during the delete operation.

get

Retrieves a value from a data store and locks the entry and the data store on behalf of the thread that invoked the service.

Important
This service does not automatically release the lock on the data store or entry after performing the get operation, so you need to ensure that the lock is released by calling the put or unlock services. If you do not release the lock, IBM webMethods Integration will release the lock at the end of the flow service execution.

Input Parameters

Output Parameters

Usage Notes

keys

Obtains a list of all the keys in a data store.

Input Parameters

Output Parameters

lock

Locks an entry and/or data store on behalf of the thread invoking this service.

Important
When you lock an entry or data store using this service, you must release the lock by using a put or an explicit unlock. If you do not release the lock, IBM webMethods Integration will release the lock at the end of the flow service execution. Further, be careful when releasing locks with the unlock service. If you release a lock on a data store, another thread can obtain a lock on the data store and delete it, and the entries it contains, even if your thread still has locks on one or more of the entries.

Input Parameters

Output Parameters

None.

Usage Notes

put

Inserts or updates an entry in a data store. If the key does not exist in the data store, the entry is inserted.

If the requested entry is not currently locked by the thread that invoked this service, the put service will automatically attempt to lock the entry for the duration of the put operation.

The service obtains an exclusive lock on the entry and a shared lock on the data store. If the service finds a shared lock from the same thread on the entry, the service will automatically promote the shared lock to an exclusive lock.

This service releases the lock when the put operation has completed.

Input Parameters

Output Parameters

Usage Notes

When storing and retrieving the flow state in the short-term store for checkpoint restart purposes, ensure that the value of key is unique to the transaction.

remove

Removes an entry from a data store. This service obtains an exclusive lock on the entry and a shared lock on the data store.

Input Parameters

Output Parameters

unlock

Unlocks an entry or a data store.

When a flow service retrieves an entry using the get service, the entry is locked to prevent modification by other users before the flow service completes. The entry remains locked until the lock owner invokes a put service. To unlock a service without using the put service, use the unlock service.

In addition, if a flow service uses the lock service to lock an entry or data store, you must use the unlock or put service to release the lock.

Important
Be careful when releasing locks with this service. If you release a lock on a data store, another thread can obtain a lock on the data store and delete it, and the entries it contains, even if the original thread still has locks on one or more of the entries.

Input Parameters

Output Parameters

None.

String Services

Use String services to perform string manipulation and substitution operations.

The following String services are available:

Service Description
base64Decode Decodes a Base-64 encoded string into a sequence of bytes.
base64Encode Converts a sequence of bytes into a Base64-encoded String.
bytesToString Converts a sequence of bytes to a String.
compareStrings Performs a case-sensitive comparison of two strings, and indicates whether the strings are identical.
concat Concatenates two strings.
fuzzyMatch A given string is not exactly matched against a set of strings. If the match is above similarityThreshold, it returns the matchedValue. If more than one string has not exactly matched, then the first matched string is returned.
HTMLDecode Replaces HTML character entities with native characters.
HTMLEncode Replaces HTML-sensitive characters with equivalent HTML character entities.
indexOf Returns the index of the first occurrence of a sequence of characters in a string.
isAlphanumeric Determines whether a string consists entirely of alphanumeric characters (in the ranges A–Z, a–z, or 0–9).
isDate Determines whether a string follows a specified date pattern.
isNullEmptyOrWhitespace Determines if a string is null, empty, or only whitespace.
isNullOrBlank Checks a string for a null or a blank value.
isNumber Determines whether the contents of a string can be converted to a float value.
length Returns the length of a string.
lookupDictionary Looks up a given key in a hash table and returns the string to which that key is mapped.
lookupTable Locates a key in a String Table and returns the string to which that key is mapped.
makeString Builds a single string by concatenating the elements of a String List.
messageFormat Formats an array of strings into a given message pattern.
numericFormat Formats a number into a given numeric pattern.
objectToString Converts an object to string representation using the Java toString() method of the object.
padLeft Pads a string to a specified length by adding pad characters to the beginning of the string.
padRight Pads a string to a specified length by adding pad characters to the end of the string.
replace Replaces all occurrences of a specified substring with a substitute string.
stringToBytes Converts a string to a byte array.
substitutePipelineVariables Replaces a pipeline variable with its corresponding value.
substring Returns a substring of a given string.
tokenize Tokenizes a string using specified delimiter characters and generates a String List from the resulting tokens.
toLower Converts all characters in a given string to lowercase.
toUpper Converts all characters in a given string to uppercase.
trim Trims leading and trailing white space from a given string.
URLDecode