Built-in Services

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

• name: String. (Optional when only body is sent) Name of the payload content.

• xmlInputContent: Object. XML content to submit to the IBM webMethods B2B product instance for processing. This is sent as SOAP BODY.

• readContentAs: String. Data type in which xmlInputContent field value is accepted.

  • bytes. xmlInputContent is read as bytes.
  • string. xmlInputContent is read as string.
  • stream. xmlInputContent is read as stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.

• encoding: String. (Optional) Type of character set used for encoding xmlInputContent value. This can be any IANA registered character set. The default value is UTF-8.

• partInfo: Document. (Optional) AS4 payload part information.

  • schemaLocation: String. (Optional) URI of the schema. The value of this parameter maps to the location attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.

  • schemaVersion: String. (Optional) Version of the schema. The value of this parameter maps to the version attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.
  • schemaNamespace: String. (Optional) Target namespace of the schema. The value of this parameter maps to the namespace attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.
  • description: String. (Optional) Description of the content. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/Description element.
  • properties[]: Document List. (Optional) List of name and value pairs that are sent along with the message. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties element.
    Note: For the final AS4 payload of MimeType application/octet-stream, then add the property name PayloadMimeType and value as application/octet-stream.
  • name: String. Name of the property. The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.
  • value: String. Value of the property. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.

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

• name: String. Name of the attachment content.
• inputContent: Object. Content of the attachment. It is sent as SOAP attachments.
• readContentAs: String. Data type in which inputContent field value is passed.
  • bytes. inputContent is read as bytes.
  • string. inputContent is read as string.
  • stream. inputContent is read as stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.

• contentType: String. Content type of the attachment. For example, application/zip if the attachment is .zip file.

• encoding: String. (Optional) Encoding of the attachment. The default value is UTF-8.

• partInfo: Document. (Optional) AS4 attachment part information.

  • schemaLocation: String. (Optional) URI of the schema. The value of this parameter maps to the location attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.
  • schemaVersion: String. (Optional) Version of the schema. The value of this parameter maps to the version attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.
  • schemaNamespace: String. (Optional) Target namespace of the schema. The value of this parameter maps to the namespace attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/Schema element.
  • description: String. (Optional) Description of the content. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/Description element.
  • Properties[]: Document List. (Optional) List of name value pairs that are sent along with the message. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties element.
    Note: For the final AS4 payload of MimeType application/octet-stream, then add the property name PayloadMimeType and value as application/octet-stream.
  • name: String. Name of the property. The value of this parameter maps to the name attribute of the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.
  • value: String. Value of the property. The value of this parameter maps to the Messaging/UserMessage/PayloadInfo/PartInfo/PartProperties/Property element.

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

• messageId: String. (Optional) Unique identifier of the message. When value is not specified, the system generates a unique messageId. When the messageID is generated, the value of this parameter maps to Messaging/UserMessage/MessageInfo/MessageId.
• soapAction: String. (Optional) Value of the action parameter in the MIME type.
• pmodeId: String. (Optional for Push request) TPA agreement ID.
• push: Document. (Required when DoctypeName is ebMS 3.0 UserMessage) AS4 push document.
  • sync: Boolean. (Optional) Synchronous or Asynchronous push request. Default value is false. Valid values are:

    true. Synchronous push reply (Used in MEP binding Two-Way/Sync for replying).

    false. Asynchronous push request (Used in MEP bindings for requesting).

  • refToMessageId: String. (Required when sync is true). Identifier used in two-way MEPs where the responding MSH user message refers to the initiating MSH user message.
  • toPartyIdRole: String. (Required when pmodeId or agreementRef is not specified) Initiator or responder role of the party in the message exchange.
  • fromPartyIdRole: String. (Required when pmodeId or agreementRef is not specified) Initiator or responder role of the party in the message exchange.
  • agreementRef: String. (Required when pmodeId is not specified) The value to use for the submit request. When pmodeId and agreementRef value is empty, then a tuple of From/ PartyId, From/Role, To/PartyId, To/Role, Service, and Action is used to identify the TPA agreement. For no agreementRef element in the final payload, agreementRef and pmodeId values in the service input and TPA agreement field should be empty.
  • service: String. (Required when PmodeId or agreementRef is not specified) Name of the service use to identify the RequestUM leg used for the current transaction. IBM webMethods B2B uses the service and action parameters to determine which RequestUM leg to use for the current transaction. IBM webMethods B2B compares the value of this parameter to the value of leg/businessInfo/service that is configured in all RequestUM legs of the TPA. The RequestUM leg that contains a match for both the service and action parameters is the leg that will be used for the current transaction. When there is only one RequestUM leg configured in the TPA, the service parameter does not have to be defined.
  • action: String. (Required when PmodeId or agreementRef is not specified) Name of action use to identify the RequestUM leg used for the current transaction. IBM webMethods B2B uses the service and action parameters to determine which RequestUM leg to use for the current transaction. IBM webMethods B2B compares the value of this parameter to the value of leg/businessInfo/action that is configured in all RequestUM legs of the TPA. The RequestUM leg that contains a match for both service and action is the leg that will be used for the current transaction. When there is only one RequestUM leg configured in the TPA, the action parameter does not have to be defined.
  • serviceType: String. (Optional) Name of the service type that indicates how the sender and receiver will interpret the service element. When no value is enter for this parameter, the service parameter must be a URI.
  • messageProperties: Document List. (Optional) List of name and value pairs that are sent along with the message. These pairs map to the zero or more Property child elements within Messaging/UserMessage/MessageProperties.

    name: String. The name of property.

    value: String. The value of property.

    type: String. (Optional) The type of property.

    endpointUrl: String. Endpoint address of the recipient. It retrieves from the operation retrievePeppolParticipantDetails .

• pull: Document. (Required when DoctypeName is ebMS 3.0 PullRequest Signal) AS4 pull document.
  • mpc: String. (Optional) Indicates MPC (Message partitioning channel) from where to pull the queued message. Default MPC is used when not specified.
  • simpleSelectionItems[]: Document List. (Optional) Select a list of simple elements.

    element: String. The name of the element that has to be retrieved. This parameter refers to refToMessageId, conversationId, agreementRef, service, and action.

    elementvalue: String. The value of the element.

    attributeList[]: Document List. (Optional) A list of attributes.

    element: String. The name of the attribute.

    elementvalue: String. The value of the attribute.

  • complexSelectionItems[]: Document List. (Optional) Select a list of complex elements.

    element: String. The name of the element that has to be retrieved. This parameter refers to From, To, and MessageProperties.

    elementvalue: String. The value of the element.

    attributeList: Document List. (Optional) A list of attributes.

    element: String. The name of the attribute.

    elementvalue: String. The value of the attribute.

    childItems[]: Document List. (Optional) A list of child items.

    element: String. The name of the child item.

    elementvalue: String. The value of the child item.

    attributeList[]: Document List. (Optional) List of attributes.

    element: String. The name of the attribute.

    elementvalue: String. The value of the attribute.

Document. To configure an RNIF body document.

• xmlInputContent: Object. XML content to submit to the IBM webMethods B2B product instance for processing.

• readContentAs: String. Data type in which inputContent field value is passed.

  • bytes. xmlInputContent is read as bytes.
  • string. xmlInputContent is read as string.
  • stream. xmlInputContent is read as stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.

• encoding: (Optional) String. Encoding of the content body.

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

• name: String. Name of the attachment content

• inputContent: Object. Content of the attachment.

• readContentAs: String. Data type in which inputContent field value is passed.

  • bytes. inputContent is read as bytes.
  • string. inputContent is read as string.
  • stream. inputContent is read as stream. IBM recommends you to use readContentAs as stream if the size of the payload is over 5 MB.

• contentType: String. Content type of the attachment.

• encoding: (Optional) String. Encoding of the attachment.

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

• rnif20: Document Configure the following parameters:

  • pipInfo: (Optional) Document. Document that represents RNIF 2.0 Partner Interface Processes Information (PIP)

    senderFocalRole: String. Validator of GlobalPartnerRoleClassificationCode tag describing fromRole in the service header. For valid values, see the fromService and fromRole details in the PIP specification corresponding to the executing PIP, activity, or action.

    receiverFocalRole: String. Validator of GlobalPartnerRoleClassificationCode tag describing toRole in the service header. For valid values, see the toService and toRole details in the PIP specification corresponding to the executing PIP, activity, or action.

    processCode String. Code or name of the PIP. For example, 3A4.

    processVersion: String. Version of the PIP process. Select either 1.1 or 1.4.

    transactionCode: String. Transaction associated with each RosettaNet PIP document.

    actionCode: String. Query action associated with each RosettaNet PIP document.

    enableSyncResponse: (Optional) Boolean. The flag to indicate that the transaction is expecting a sync response. Valid values are:

    true: The transaction is expecting a sync response.

    false: The transaction is not expecting a sync response. This is by default.

  • response: (Optional) Document. Response is a composite object containing the parameters.

    messageTrackingID: String. Unique instance identifier to identify message.

    inReplyToGlobalBusinessActionCode: (Optional) String. Action associated with request RosettaNet PIP document, for which IBM webMethods B2B sends the response.

    initiatingPartnerLocationID: String. Location ID of the partner. The initiating partner location ID: //ServiceHeader/ProcessControl/KnownInitiatingPartner/PartnerIdentification/locationID/Value for which IBM webMethods B2B sends the response.

• rnif11: Document. Configure the following parameters:

  • pipInfo: (Optional) Document. Document that represents RNIF 1.1 Partner Interface Processes Information (PIP).

    senderFocalRole: String. Validator of the GlobalPartnerRoleClassificationCode tag describing fromRole in the service header. For valid values, see the fromService and fromRole details in the PIP specification corresponding to the executing PIP, activity, or action.

    receiverFocalRole: String. Validator of the GlobalPartnerRoleClassificationCode tag describing toRole in the service header. For valid values, see the toService and toRole details in the PIP specification corresponding to the executing PIP, activity, or action.

    processCode: String. Code or name of the PIP. For example, 3A4.

    processVersion: String. Version of the PIP process. Select either 1.1 or 1.4.

    transactionCode: String. Transaction associated with each RosettaNet PIP document.

    actionCode: String. Query action associated with each RosettaNet PIP document.

  • response: (Optional) Document. Response is a composite object containing the parameters.

    actionIdentityInstanceIdentifier: String. Unique instance identifier to identify message.

    inReplyToGlobalBusinessActionCode: (Optional) String. Action associated with request RosettaNet PIP document, for which IBM webMethods B2B sends the response.

Output Parameters

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

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.

Input Parameters

• inputContent: String. Content passed in the integration request.

• loadContentAs: String. Data type in which outputContent field value is passed.

  • bytes. outputContent is generated as bytes.
  • string. outputContent is generated as a string.

• encoding: String. Type of character set used for encoding inputContent value. This can be any IANA registered character set. Default UTF-8.

  Output Parameters

  • outputContent: Object. Content data corresponds to the data type option set for the loadContentAs field.

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

Input Parameters

• data: Document - Data that you want the compressData service to compress. Specify data using one of the following keys. When you use more than one key, string is appended first, bytes is appended second, and stream is appended last. IBM webMethods Integration uses the first key that it encounters.

  • string: string Optional - Text that you want the compressData service to compress.
  • bytes: byte[] Optional - Data that you want the compressData service to compress.
  • stream:java.io.InputStream Optional - Data that you want the compressData service to compress.

• encoding: String. Optional - Name of a registered, IANA character set that specifies the encoding to use when converting the String to an array of bytes (for example: ISO-8859-1).

• compressionScheme: String - The compression method you want the compressData service to apply to compress the data. The supported compression schemes are gzip and deflate .

• loadAs: string - Form in which you want the compressData service to store the output data. Set to:

  • bytes to store the data as a byte[].
  • stream to store the data as a java.io.InputStream.

Output Parameters

• compressedData: Document - Compressed data after applying the compression scheme.

  • bytes: byte[] Conditional - Compressed data represented as a byte[ ]. bytes is returned only when the loadAs input parameter is set to bytes.
  • stream: java.io.InputStream Conditional - Compressed data represented as an InputStream. stream is returned only when the loadAs input parameter is set to stream.

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

Input Parameters

• data: Document. Data that you want the decompressData service to decompress. Specify data using one of the following keys.

  • bytes: byte[] Optional - Data that you want the decompressData service to decompress.
  • stream: java.io.InputStream Optional - Data that you want the decompressData service to decompress.

• compressionScheme: String - The compression scheme you want the decompressData service to apply to decompress the data. The supported compression schemes are gzip and deflate .

• loadAs: string - Form in which you want the decompressData service to store the returned document. Set to:

  • bytes to return the data as a byte[].
  • stream to return the data as a java.io.InputStream.

Output Parameters

• decompressedData: Document. Decompressed data after applying the compression algorithm.

  • bytes: byte[] Conditional - Decompressed data represented as a byte[]. bytes is returned only when the loadAs input parameter is set to bytes.
  • stream: java.io.InputStream Conditional - The decompressed data represented as an InputStream. stream is returned only when the loadAs input parameter is set to stream.

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

Input Parameters

• startDate: String - Starting date and time.

• endDate: String - Ending date and time.

• startDatePattern: String - Format in which the startDate parameter is to be specified (for example, yyyyMMdd HH:mm:ss.SSS).

• endDatePattern: String - Format in which the endDate parameter is to be specified (for example, yyyyMMdd HH:mm:ss.SSS).

Output Parameters

• dateDifferenceSeconds: String - The difference between the startingDateTime and endingDateTime, truncated to the nearest whole number of seconds.

• dateDifferenceMinutes: String - The difference between the startingDateTime and endingDateTime, truncated to the nearest whole number of minutes.

• dateDifferenceHours: String - The difference between the startingDateTime and endingDateTime, truncated to the nearest whole number of hours.

• dateDifferenceDays: String - The difference between the startingDateTime and endingDateTime, truncated to the nearest whole number of days.

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.

Compares two dates and returns the result as an integer.

Input Parameters

• startDate: String - Starting date to compare against endDate.

• endDate: String - Ending date to compare against startDate.

• startDatePattern: String - Format in which the startDate parameter is specified (for example, yyyyMMdd HH:mm:ss.SSS).

• endDatePattern: String - Format in which the endDate parameter is specified (for example, yyyyMMdd HH:mm:ss.SSS).

Output Parameters

• result: String. Checks whether startDate is before, the same, or after the endDate based on the values as follows:

  • +1: The startDate is after the endDate.
  • 0: The startDate is the same as the endDate.
  • -1: The startDate is before the endDate.

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.

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

• nanoTime: java.lang.Long - The value returned represents the time elapsed since an arbitrary fixed point in nanoseconds, which is not necessarily related to the actual current date and time.

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

Input Parameters

• pattern: String - Pattern representing the format in which you want the date returned. If you do not specify pattern, dateBuild returns null. If pattern contains a time zone and timezone is not specified, the default time zone is used.

• year: String Optional - The year expressed in yyyy or yy format (for example, 01 or 2001). If you do not specify year or you specify an invalid value, dateBuild uses the current year.

• month: String Optional - The month expressed as a number (for example, 1 for January, 2 for February). If you do not specify month or you specify an invalid value, dateBuild uses the current month.

• dayofmonth: String Optional - The day of the month expressed as a number (for example, 1 for the first day of the month, 2 for the second day of the month). If you do not specify dayofmonth or you specify an invalid value, dateBuild uses the current day.

• timezone: String Optional - Time zone in which you want the output date and time expressed. Specify a time zone code as shown in the “Time Zones” section, for example, EST for Eastern Standard Time. If you do not specify timezone, the value of the server's "user timezone" property is used. If this property has not been set, GMT is used.

• locale: String Optional - Locale in which the date is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

Output Parameters

• value: String - The date specified by year, month, and dayofmonth, in the format of pattern.

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

Input Parameters

• pattern: String - Pattern representing the format in which you want the time returned. For pattern-string notation, see the “Pattern String Symbols” section. If you do not specify pattern, dateTimeBuild returns null. If pattern contains a time zone and the timezone parameter is not set, the default time zone is used.

• year: String Optional - The year expressed in yyyy or yy format (for example, 01 or 2001). If you do not specify year or you specify an invalid value, dateTimeBuild uses the current year.

• month: String Optional - The month expressed as a number (for example, 1 for January, 2 for February). If you do not specify month or you specify an invalid value, dateTimeBuild uses the current month.

• dayofmonth: String Optional - The day of the month expressed as a number (for example, 1 for the first day of the month, 2 for the second day of the month). If you do not specify dayofmonth or you specify an invalid value, dateTimeBuild uses the current day.

• hour: String Optional - The hour expressed as a number based on a 24-hour clock. For example, specify 0 for midnight, 2 for 2:00 A.M., and 14 for 2:00 P.M. If you do not specify hour or you specify an invalid value, dateTimeBuild uses 0 as the hour value.

• minute: String Optional - Minutes expressed as a number. If you do not specify minute or you specify an invalid value, dateTimeBuild uses 0 as the minute value.

• second: String Optional - Seconds expressed as a number. If you do not specify second or you specify an invalid value, dateTimeBuild uses 0 as the second value.

• millis: String Optional - Milliseconds expressed as a number. If you do not specify millis or you specify an invalid value, dateTimeBuild uses 0 as the millis value.

• timezone: String Optional - Time zone in which you want the output date and time expressed. Specify a time zone code as shown in the “Time Zones” section, for example, EST for Eastern Standard Time. If you do not specify timezone, the value of the server's "user timezone" property is used. If this property has not been set, GMT is used.

• locale: String Optional - Locale in which the date is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

Output Parameters

• value: String - Date and time in format of pattern.

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

Input Parameters

• inString: String - Date/time that you want to convert. Important: If inString contains a character in the last position, that character is interpreted as 0. This can result in an inaccurate date. For information about invalid dates, see the “Notes on Invalid Dates” section.

• currentPattern: String - Pattern string that describes the format of inString.

• newPattern: String - Pattern string that describes the format in which you want inString returned.

• locale: String Optional - Locale in which the date is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

• lenient: String Optional - A flag indicating whether an exception will appear if the inString value does not adhere to the format specified in currentPattern parameter. Set to:

  • true to perform a lenient check. This is the default. In a lenient check, if the format of the date specified in the inString parameter does not match the format specified in the currentPattern parameter, the date in the format specified in the currentPattern parameter will be interpreted and returned. If the interpretation is incorrect, the service will return an invalid date.

  • false to perform a strict check. In a strict check, an exception will appear if the format of the date specified in the inString parameter does not match the format specified in the currentPattern parameter.

Output Parameters

• value: String - The date/time given by inString, in the format of newPattern.

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.

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

Input Parameters

• nanoTime: java.lang.Long - Time in nanoseconds. If nanoTime is less than zero, then the service treats it as zero.

Output Parameters

• elapsedNanoTime: java.lang.Long - The difference between the current time in nanoseconds and nanoTime. If nanoTime is greater than the current nano time, the service returns zero.

• elapsedNanoTimeStr: String - The difference between the current time in nanoseconds and nanoTime. The difference is expressed as a String, in this format: [years] [days] [hours] [minutes] [seconds] [millisec] [microsec] <nanosec>. If nanoTime is greater than the current nano time, the service returns zero.

Formats a Date object as a string.

Input Parameters

• date: java.util.Date Optional - Date/time that you want to convert.

• pattern: String - Pattern string that describes the format in which you want the date returned.

• timezone: String Optional - Time zone in which you want the output date and time expressed. Specify a time zone code as shown in the Time Zones section, for example, EST for Eastern Standard Time. If you do not specify timezone, the user's time zone is used, else GMT is used.

• locale: String Optional - Locale in which the date is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

Output Parameters

• value: String - The date/time given by date in the format specified by pattern.

Returns the current date as a Date object.

Input Parameters

None.

Output Parameters

• date: java.util.Date - Current date.

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

Input Parameters

• pattern: String - Pattern representing the format in which you want the date returned.

• timezone: String Optional - Time zone in which you want the output date and time expressed. Specify a time zone code as shown in the “Time Zones” section, for example, EST for Eastern Standard Time. If you do not specify timezone, the value of the server's "user timezone" property is used. If this property has not been set, GMT is used. Alternatively, you can also specify the timezone as a full name.

  For regions where Daylight Saving Time (DST) is observed, use the full name of the timezone for accurate time representation. For example, specifying the EST timezone code yields the current time as Eastern Standard Time without applying DST. To obtain Eastern Standard Time with DST adjustment, use America/New_York.

• locale: String Optional - Locale in which the date is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

Output Parameters

• value: String - Current date in the format specified by pattern.

Increments a date by a specified amount of time.

Input Parameters

• startDate: String - Starting date and time.

• startDatePattern: String - Format in which the startDate parameter is specified (for example, yyyyMMdd HH:mm:ss.SSS).

• endDatePattern: String Optional - Pattern representing the format in which you want the endDate to be returned. If no endDatePattern is specified, the endDate will be returned in the format specified in the startDatePattern parameter.

• addYears: String Optional - Number of years to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addMonths: String Optional - Number of months to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addDays: String Optional - Number of days to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addHours: String Optional - Number of hours to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addMinutes: String Optional - Number of minutes to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addSeconds: String Optional - Number of seconds to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addMilliSeconds: String Optional. Number of milliseconds to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• timezone: String Optional - Time zone in which you want the endDate to be expressed. Specify a time zone code, for example, EST for Eastern Standard Time. If you do not specify timezone, the value of the server's "user timezone" property is used. If this property has not been set, GMT is used.

• locale: String Optional - Locale in which the endDate is to be expressed. For example, if locale is en (for English), the pattern EEE d MMM yyyy will produce Friday 23 August 2002, and the locale of fr (for French) will produce vendredi 23 août 2002.

Output Parameters

• endDate: String - The end date and time, calculated by incrementing the startDate with the specified years, months, days, hours, minutes, seconds, and/or milliseconds. The endDate will be in the endDatePattern format, if specified. If no endDatePattern is specified or if blank spaces are specified as the value, the endDate will be returned in the format specified in the startDatePattern parameter.

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.

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

Input Parameters

• pattern: String - The pattern with which to format the string. For more information about these pattern letters and symbols, see the Oracle Java API documentation for the DateTimeFormatter class.

• year: String Optional - The year expressed as a 4-digit Integer. If you do not specify year, the year will be from the current date which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for year, the service will end with an error from the JDK.

• month: String Optional - The month expressed as an Integer where January is 1. If you do not specify month, the month will be from the current date which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for month, the service will end with an error from the JDK.

• dayOfMonth: String Optional - The day of the month expressed as an Integer, starting with 1 as the first day of the month. If you do not specify dayOfMonth, the day of the month will be from the current date which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for day, the service will end with an error from the JDK.

• hour: String Optional - The hour of the day expressed as an Integer from 0 through 23. If you do not specify hour, the hour will be from the current time which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for hour, the service will end with an error from the JDK.

• minute: String Optional - The minute expressed as an Integer from 0 through 59. If you do not specify minute, the minute will be from the current time which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for minute, the service will end with an error from the JDK.

• second: String Optional - The seconds of the hour expressed as an Integer from 0 through 59. If you do not specify second, the second will be from the current time which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for second, the service will end with an error from the JDK.

• millis: String Optional - The number of milliseconds expressed as a Long. If you do not specify millis, the millis will be from the current time which is determined by the JVM in which IBM webMethods Integration runs. If you specify an invalid value for millis, the service will end with an error from the JDK.

• timezone: String Optional - The time zone. If you specify a value for timezone, the service ignores the useSystemTimeZone parameter value. It is recommended to supply the full name for timezones, such as Asia/Tokyo, or use UTC. If pattern includes a timezone, you must specify timezone input parameter value or set useSystemTimeZone to true.

• useSystemTimeZone: String Optional - Indicates whether the service uses the time zone of the IBM webMethods Integration JVM if timezone was not specified. Set to:

  • true to use the time zone of IBM webMethods Integration when timezone is not specified.

  • false if you do not want the service to use the timezone of IBM webMethods Integration if timezone was not set. The default is false.

  If pattern includes a timezone, you must specify the timezone input parameter value or set useSystemTimeZone to true.

  To match the behavior of date:dateTimeBuild which produced a date/time that always included a time zone set useSystemTimeZone to true. This ensures that if timezone is not specified, the resulting date/time will include a time zone.

• locale: String Optional - The locale in which to express the date.

Output Parameters

• value: String - The formatted date and time.

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.

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

Input Parameters

• startDate: String - Starting date and time.

• startDatePattern: String - Pattern in which the startDate value is specified. For more information about these pattern letters and symbols, see the Oracle Java API documentation for the DateTimeFormatter class.

• endDatePattern: String - Pattern in which to format the resulting date/time. For more information about these pattern letters and symbols, see the Oracle Java API documentation for the DateTimeFormatter class. If no endDatePattern is specified, the endDate will be returned in the format specified in the startDatePattern parameter.

• timezone: String Optional - The time zone to use for parsing startDate and formatting endDate. The service uses timezone to parse the startDate String and convert it from the time zone specified in the input, if one was provided. For example, if the timezone input parameter is MST and the startDate is "2019-02-21 11:30:00 EST", then the service converts the startDate time from EST to MST. The service uses timezone when formatting endDate as a String. That is, the timezone determines the time zone in which the service expresses the endDate.

• locale: String Optional - Locale in which the endDate is to be expressed.

• addYears: String Optional - The number of years to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addMonths: String Optional - The number of months to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addDays: String Optional - The number of days to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addHours: String Optional - The number of hours to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addMinutes: String Optional - The number of minutes to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addSeconds: String Optional - The number of seconds to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• addMilliseconds: String Optional - The number of milliseconds to add to startDate. The value must be an integer between -2147483648 and 2147483647.

• useSystemTimeZone: String Optional - Whether to use the system time zone to increment the date/time when the startDate value does not have a time zone. Set to:

  • false if the startDate does not include a time zone, the timezone parameter was not set, and you want to increment the date/time without being affected by a time zone. This is the default.

  • true to use the system time zone when incrementing the startDate.

  When useSystemTimeZone is false and no timezone is provided, the resulting endDate will not include a timezone. To match the behavior of date:incrementDate, which produced a date/time that always included a time zone, set useSystemTimeZone to true.|

• useSameInstant: String Optional - Whether to use the same Instant, where Instant represents a moment on the timeline in UTC, or the same unzoned date/time when applying a different time zone. Using the same Instant will usually result in changes to the unzoned date/time when the time zone and its offset are applied. Not using the same Instant will result in the unzoned date/time being unchanged when the time is applied. If useSameInstant is true, the increment service uses the Instant (the absolute time with no time zones) to determine how the timezone value is used.

  If useSameInstant is false, the increment service uses the unzoned date/time and only changes the time zone. The default is true.

Output Parameters

• endDate: String - The incremented date and time.

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.

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

• documentBytes: Object - An array of bytes (byte[]) to convert to a document.

  • If documentBytes is null, the service does not return a document or an error message.

  • If documentBytes is not a byte array, the service throws an exception.

  • If documentBytes is zero-length, the service produces an empty document.

Output Parameters

• document: Document - A document.

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.

Deletes the specified documents from a set of documents.

Input Parameters

• documents: Document List - Set of documents that contain the documents you want to delete.

• indices: String List - Index values of documents to be deleted from the documents parameter document list.

Output Parameters

• documents: Document List - List of documents whose indices do not match the values in indices parameter.

• deletedDocuments: Document List - List of deleted documents.

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.

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

• documentList: Document List - Set of documents that you want to transform into a single document.

• name: String - Name of the element in the documentList parameter whose value provides the name of each key in the resulting document.

• value: String - Name of the element in the documentList parameter whose values will be assigned to the keys specified in name. This element can be of any data type.

Output Parameters

• document: - Document Document containing the key/value pairs generated from the documentList parameter.

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:

Would be converted to a document containing these three keys:

Converts a document to an array of bytes.

Input Parameters

• document: Document - Document to convert to bytes.

  • If document is null, the service does not return an output or an error message.

  • If document is not a document, the service throws an exception.

  • If document contains no elements, the service produces a zero-length byte array.

Output Parameters

• documentBytes: Object - A serialized representation of the document as an array of bytes (byte[]).

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.

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

• document: Document - Document to transform.

• name: String - Name to assign to the key that will receive the key name from the original key/value pair. In the example above, this parameter was set to pName.

• value: String - Name to assign to the key that will receive the value from the original key/value pair. In the example above, this parameter was set to pValue.

Output Parameters

• documentList: Document List - List containing a document for each key/value pair in the document parameter. Each document in the list will contain two keys, whose names were specified by the name and value parameters. The values of these two keys will be the name and value (respectively) of the original pair.

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:

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

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

Input Parameters

• documents: Document List - Set of documents from which the documents meeting the retrieve criteria are to be returned.

• matchCriteria: Document - Criteria on which the documents in the documents parameter are to be matched. Parameters for matchCriteria are: path: Name of the element in documentList whose value provides the value for the search text. The value for key can be a path expression. For example, "Family/Chidren[0]/ BirthDate" retrieves the birthday of the first child from the input Family document list.

  • compareValueAs Optional - Allowed values are string, numeric, and datetime. The default value is string.

  • datePattern Optional - Pattern will be considered only if compareValueAs is of type datetime. Default value is MM/dd/yyyy hh:mm:ss a.

  • joins - List of join criteria. Each join criteria consists of:

    operator - Allowed values are equals, doesNotEqual, greaterThan, greaterThanEqual, lessThan, lessThanEqual, equalsIgnoreCase, contains, doesNotContain, beginsWith, doesNotBeginWith, endsWith, doesNotEndWith.

    value Optional - Allowed values are string, numeric, and datetime. The default value is string.

    joinType - Specifies the way two joins can be linked. Values are “and” or “or”. Default value is “and”.

Output Parameters

• result documents: Document List - List of documents that match the retrieve criteria.

Groups a set of documents based on specified criteria.

Input Parameters

• documents: Document List - Set of documents to be grouped based on the specified criteria.

• groupCriteria: Document List - The criteria on which the input documents are to be grouped. Valid values for the groupCriteria parameter are:

  • key - Key in the pipeline. The value for key can be a path expression. For example, "Family/Chidren[0]/BirthDate" retrieves the birthday of the first child from the input Family document list.

  • compareStringsAs. Optional - Valid values for compareStringsAs are string, numeric, and datetime. The default value is string.

  • pattern. Optional - Pattern will be considered only if the compareStringsAs parameter is of type datetime.

Output Parameters

• documentGroups: Document List - List of documents where each element represents a set of documents grouped based on the criteria specified.

Usage Notes

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

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

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

Input Parameters

• documents: Document List - Set of documents in which a new document is to be inserted.

• insertDocument: Document. The new document to be inserted to the set of documents specified in the documents parameter.

• index: String. Optional. The position in the seat which the document is to be inserted. The index parameter is zero-based. if the value for the index parameter is not specified, the document will be inserted at the end of the document list specified in the documents parameter.

Output Parameters

• documents: Document List. Document list after inserting the new document.

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.

Input Parameters

• document: Documents. A document from where fields having value null are removed.

• trimStringFields: If specified, for fields whose type is String, would remove the leading and trailing space characters. Default value is false.

• removeEmptyStringFields: If specified, if a string field is empty, it is removed from the given document. If both trimStringFields and removeEmptyStringFields are true, then after removing the spaces, if there are no characters in the string, it is removed from the document. Default value is false.

Output Parameters

• document: Document. Returns the document having non-null fields.

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

Input Parameters

• documents: Document List. Set of documents from which the documents meeting the search criteria are to be returned.

• searchCriteria: Document. Criteria on which the documents in the documents parameter are to be searched. Valid values for searchCriteria parameters are:

  • key: Name of the element in documentList whose value provides the value for the search text. The value for key can be a path expression. For example, Family/Chidren[0]/BirthDate retrieves the birthday of the first child from the input Family document list.

  • value: Optional. Any search text. If no value is specified, the service searches for null in the document list.

  • compareStringsAs: Optional. Allowed values are string, numeric, and datetime. The default value is string.

  • pattern: Optional. Pattern will be considered only if the compareStringsAs value is of type datetime.

• sorted: String Optional - The value of the sorted parameter is true if the document list is already sorted based on the search criteria and same search key; otherwise false. If the value for the sorted parameter is set to true, the required documents are searched faster.

Output Parameters

• resultdocuments: Document List - List of documents which are matching the search criteria.

• documentListIndices: String List - Positions of search documents in the document list.

• documents: Document List - List of documents that were input.

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:

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

Input Parameters

• documents: Document List - Set of documents that are to be sorted.

• sortCriteria: Document List - Criteria based on which the documents in the documents parameter are to be sorted. Valid values for sortCriteria parameters are:

  • key -. Name of the element in documentList whose value provides the value based on which the documents are to be sorted. The value for key can be a path expression. For example, "Family/Chidren[0]/BirthDate" retrieves the birthday of the first child from the input Family document list.
  • order: Optional - Allowed values are ascending and descending. The default value is ascending.
  • compareStringsAs: Optional - Allowed values are string, numeric, and datetime. Default value is string.
  • pattern: Optional - The value for pattern will be considered only if the compareStringsAs value is of type datetime.

Output Parameters

• documents: Document List - The documents sorted based on the sort criteria specified in the sortCriteria parameter.

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:

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

Input Parameters

• delimitedDataBytes: java.lang.Byte[] - Delimited data in bytes (Byte array) to convert to a document.
• fieldQualifier: String Optional - The delimiter to use for separating entries in delimitedDataBytes. Default is comma (,).
• textQualifier: String Optional - The character to use for quoted elements. Default is double quote (").
• useHeaderRowForFieldNames: String Optional - Consider first line as header row and use the delimited data of this line as property names in the output document.

  Set to:

  • true - The delimited data of first line will be used as the property name in the output document. This is the default.
  • false - column1, column2...columnN will be used as the property name in the output document.

• skipBOMBytes: Optional - The default value is False. Set the parameter to True to ensure proper file parsing and avoid integration issues. When the value is set to true, it automatically skips the ByteOrderMark bytes from the input stream which includes an encoded ByteOrderMark as its first bytes.

• encoding: String Optional - The encoding to use while parsing the delimited data.

Output Parameters

• document: Document - Document resulting from the conversion of delimitedDataBytes. This document contains document array rows[] corresponding to the delimited data.

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

Input Parameters

• delimitedDataStream: java.io.InputStream - Delimited data in an input stream to convert to a document.
• fieldQualifier: String Optional - The delimiter to use for separating entries in delimitedDataStream. Default is comma (,).
• textQualifier: String Optional - The character to use for quoted elements. Default is double quote (").
• useHeaderRowForFieldNames: String Optional - Consider first line as header row and use the delimited data of this line as property names in the output document.

  Set to:

  • true - The delimited data of first line will be used as the property name in the output document. This is the default.
  • false - column1, column2...columnN will be used as the property name in the output document.
• skipBOMBytes: Optional - Automatically skips the ByteOrderMark bytes from the input stream which includes an encoded ByteOrderMark as its first bytes.
• encoding: String Optional - The encoding to use while parsing the delimited data.

Output Parameters

• document: Document - Document resulting from the conversion of delimitedDataStream. This document contains document array rows[] corresponding to the delimited data.

Converts delimited data string to a document.

Input Parameters

• delimitedDataString: String - Delimited string to convert to a document.

• fieldQualifier: String Optional - The delimiter to use for separating entries in delimitedDataString. Default is comma (,).

• textQualifier: String Optional - The character to use for quoted elements. Default is double quote (").

• useHeaderRowForFieldNames: String Optional - Consider first line as header row and use the delimited data of this line as property names in the output document.

  Set to:

  • true - The delimited data of first line will be used as the property name in the output document. This is the default.

  • false - column1, column2...columnN will be used as the property name in the output document.

• encoding: String Optional - The encoding to use while parsing the delimited data.

Output Parameters

• document: Document - Document resulting from the conversion of delimitedDataString. This document contains document array rows[] corresponding to the delimited data.

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

Input Parameters

• document: Document - Document to be converted to delimited data bytes (byte array object). This document contains document array rows[] corresponding to the delimited data.

• fieldQualifier: String Optional - The delimiter to use for separating entries in delimitedDataBytes. Default is comma (,).

• textQualifier: String Optional - The character to use for quoted elements. Default is double quote (").

• useFieldNamesForHeaderRow: String Optional - The first line in the output delimited data delimitedDataBytes will be constructed using the property names in the input document array document\rows[].

  Set to:

  • true - Property names in the input document array document\rows[] will be used as the first row in the output delimitedDataBytes.

  • false - column1, column2...columnN will be used as the first row in the output delimitedDataBytes.

• encoding: String Optional - The encoding to use while parsing the delimited data.

Output Parameters

• delimitedDataBytes: Object - Delimited data byte array object resulting from the conversion of a document.

Converts a document to a delimited data stream.

Input Parameters

• document: Document - Document to be converted to delimited data stream. This document contains document array rows[] corresponding to the delimited data.

• fieldQualifier: String Optional - The delimiter to use for separating entries in delimitedDataStream. Default is comma (,).

• textQualifier: String Optional - The character to use for quoted elements. Default is double quote (").

• useFieldNamesForHeaderRow: String Optional - The first line in the output delimited data delimitedDataStream will be constructed using the property names in the input document array document\rows[].

  Set to:

  • true - Property names in the input document array document\rows[] will be used as the first row in the output delimitedDataStream.

  • false - column1, column2...columnN will be used as the first row in the output delimitedDataStream.

• encoding: String Optional - The encoding to use while parsing the delimited data.

Output Parameters

• delimitedDataStream: java.io.InputStream - Delimited data stream resulting from the conversion of a document.

Converts a document to a delimited data string.

Input Parameters

• document: Document - Document to be converted to delimited data string. This document contains document array rows[] corresponding to the delimited data.

• fieldQualifier: String Optional - The delimiter to use for separating entries in delimitedDataString. Default is comma (,).

• textQualifier: String Optional - The character to use for quoted elements. Default is double quote (").

• useFieldNamesForHeaderRow: String Optional - The first line in the output delimited data delimitedDataString will be constructed using the property names in the input document array document\rows[].

  Set to:

  • true- Property names in the input document array document\rows[] will be used as the first row in the output delimitedDataString.

  • false - column1, column2...columnN will be used as the first row in the output delimitedDataString.

• encoding: String Optional - The encoding to use while parsing the delimited data.

Output Parameters

• delimitedDataString: String - Delimited data byte string resulting from the conversion of a document.

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

Input Parameters

• preserve: String List Optional - Field names that should not be cleared from the pipeline.

Output Parameters

None.

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

• status: String Optional - Valid values are success or fail. Set status to success to count the number of successfully processed documents, else set it to fail. Default value is success.

• incrementBy: String Optional - Increment the number of documents processed by a flow service. Every time the service is used, successful or failed documents are incremented by the given value. Default value is 1.

Output Parameters

None.

Usage Notes

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

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

Input Parameters

None.

Output Parameters

• httpRequest: Document - Contains the HTTP request received by IBM webMethods Integration and includes following details:

  • headers: Document - Contains the header fields from the HTTP request.

  • requestURL: String - URL used by the client to invoke the service.

  • method: String - HTTP method used by the client to request the top-level service. Possible values are GET, PUT, POST, PATCH, and DELETE.

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

Input Parameters

None.

Output Parameters

• lastError: Document - Information about the last error, which contains details of the time, error, user, block, and call stack information.

  • time: String - Date and time the event occurred, in the format yyyy/MM/dd HH:mm:ss.SSS

  • error: String Optional - Error message of the exception.

  • localizedError: String Optional - Error message in the language that corresponds to the server locale.

  • user: String - User who executed the flow service.

  • block: Document - Contains the following fields:

    name: String - flow service, Operation, or Service name.

    type: String - Connector, flow service, or Service.

    details: String Optional - Account and Application name if the Block Type is Application.

  • callStack: Document List - The call stack information describing where the error occurred including details of the block. Each document represents a block on the call stack. The first document in the list represents the block that threw the error and the last document in the list represents the top level block. It contains the following fields:

    name: String - flow service, Operation or Service

    name.type: String - Connector, flow service, or Service.

  • errorDetails: Document Optional - Additional exception information.

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.

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

Input Parameters

None.

Output Parameters

• failure: Object - Last failure caught by a CATCH step. The failure parameter is null if no failure has been caught.

• failureMessage: String, Conditional - Message associated with the failure. The service returns a failureMessage output parameter only if a failure has been caught.

• failureName: String, Conditional - Exception class name. The service returns a failureName output parameter only if a failure has been caught.

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 started.

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

• $session: Document - Returns information about the current logged-in user session. Also provides the current flow service name and the execution result reference identifier.

  • tenantId: String - Tenant Identifier.

  • stageId: String - The stage ID where the current flow service resides.

  • user: Document - Returns user details.

    name: String - Name of the user who is executing the service.

​ ​ - 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.

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

• retryCount: String - The number of times the IBM webMethods Integration system has re-executed the flow service.

• maxRetryCount: String The maximum number of times the IBM webMethods Integration system can re-execute the flow service.

Usage Notes

Although the getRetryCount service can be started at any point in a flow service, the getRetryCount service retrieves retry information for the flow service when started by a subscriber. The getRetryCount service does not retrieve retry information for a nested flow service (a flow service that is started 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.

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

Input Parameters

• message: String - Custom message to be logged, which can be viewed in the Execution Results screen.

Output Parameters

None.

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

• id: String Optional - The custom value for the current auditing context. Specify a value that you want to associate with the auditing context. The ID length must be less than or equal to 36 characters. In the event that an ID exceeds 36 characters, only the first 36 characters are stored.

Output Parameters

None.

Usage Notes

• Each client request creates a new auditing context. The auditing context is the lifetime of the top-level service. Once the custom context identifier is set, IBM webMethods Integration includes that value in each service audit record it logs in the current context. Calls to this service affect audit logging only for the current request.
• This service is useful when IBM webMethods Integration is configured to log to a database. When the server logs information about a service to the database, it includes the custom context identifier in the service log. On the IBM webMethods Integration Monitor screen, you can use the custom value as search criteria to locate and view all corresponding service audit records.
• If IBM webMethods Integration is configured to log to a file system, IBM webMethods Integration writes the custom context identifier with the service audit records to a file. This file is not accessible on the Monitor screen. You cannot query service records when logging to a file.
• If this service is started without a specified value for id, IBM webMethods Integration writes a null value for the custom context identifier field for all subsequent service audit records that it logs in the current context.

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

Input Parameters

• httpResponse: Document - Contains the HTTP response that will be returned by IBM webMethods Integration and includes following details:

  • headers: Document Optional - Contains the header fields to be returned in the HTTP response.
  • responseCode: String Optional - HTTP status code to be returned to the client. The response codes and phrases are defined in https://tools.ietf.org/html/rfc7231#section-6. If you provide a value for responseCode that is not listed in RFC 7321, Section 6, you must also provide a value for reasonPhrase.
  • responsePhrase: String Optional - HTTP reason phrase to be returned to the client. If no reason is provided, the default reason phrase associated with responseCode will be used. You must provide a reasonPhrase for any responseCode that is not listed in RFC 7321, Section 6.
  • responseString: String Optional - Response to be returned to the client, specified as a string.
  • responseBytes: byte[] Optional - Response to be returned to the client, specified as a byte array.
  • responseStream: java.io.InputStream Optional - Response to be returned to the client, specified as an InputStream.

Output Parameters

None.

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

Input Parameters

• seconds: String - The number of seconds to pause the currently executing flow service. The value must be an integer between 1 second and 60 seconds.

Output Parameters

None.

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

Input Parameters

• wrappedException: Object Optional - Any exception that you want to include as part of this exception. This might be the exception that causes the throwExceptionForRetry service to execute. For example, if a Salesforce connector fails to connect to the server due to connection timeout you can use this service inside Catch block to retry the flow service again.

• message: String Optional - A message to be logged as part of this exception.

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 started directly by a client request or by a subscriber. The service cannot be retried when it is started 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.

Checks for the existence of a hashtable element.

Input Parameters

• hashtable: java.util.Hashtable - Hashtable in which to check for the existence of a hashtable element.
• key: String - Hashtable element to be checked for.

Output Parameters

• containsKey: String - Indicates whether the specified hashtable element exists.

  A value of:

  • true - Indicates that the element exists.

  • false - Indicates that the element does not exist.

Creates a hashtable object.

Input Parameters

None.

Output Parameters

• hashtable: java.util.Hashtable - The new hashtable object.

Gets the value for a specified key in the hashtable.

Input Parameters

• hashtable: java.util.Hashtable - Hashtable from which to retrieve the specified value.

• key: String - Key of the hashtable element whose value is to be retrieved.

Output Parameters

• value: Object - Value of the input hashtable element.

Lists all the keys stored in the hashtable.

Input Parameters

• hashtable: java.util.Hashtable - Hashtable from which the keys are to be listed.

Output Parameters

• keys: String[] - List of keys stored in the input hashtable.

Adds a key/value pair in the hashtable.

Input Parameters

• hashtable: java.util.Hashtable - Hashtable to which the key/value pair is to be added.

• key: String - Key of the element to be added to the hashtable.

• value: Object - Value of the element to be inserted into the hashtable.

Output Parameters

• hashtable: java.util.Hashtable - Hashtable object after the insertion of the key/value pair.

Removes a key/value pair from the hashtable.

Input Parameters

• hashtable: java.util.Hashtable - Hashtable from which to remove the key/value pair.

• key: String - Key of the hashtable element to be removed.

Output Parameters

• hashtable: java.util.Hashtable - Hashtable object after the key/value pair is removed.

• value: Object - Value of the hashtable element that was removed. Returns null if the input key is not found in the hashtable.

Gets the number of elements in the hashtable.

Input Parameters

• hashtable: java.util.Hashtable - Hashtable from which the number of elements stored in it is to be retrieved.

Output Parameters

• size: String - Number of elements in the hashtable.

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

Input Parameters

• bytes: byte[ ] - The byte array to convert.
• length: String Optional - The maximum number of bytes to read and convert. If length is not specified, the default value for this parameter is the length of the input byte array.
• offset: String Optional - The offset into the input byte array from which to start converting. If no value specified, the default value is zero.

Output Parameters

• stream: java.io.ByteArrayInputStream - An open InputStream created from the contents of the input bytes parameter.

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.

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

Input Parameters

• inputStream: java.io.InputStream. Optional - An open InputStream.

• reader: java.io.Reader.Optional - An open reader object.

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.

Creates a byte array of the specified length.

Input Parameters

• length: String. The length of the byte array to be created.

Output Parameters

• bytes: Object The new byte array.

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].

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

• stream: java.io.InputStream. Optional - The InputStream.

• reader: java.io.Reader. Optional - The reader object.

• limit: String - The maximum number of bytes that can be read before the mark position becomes invalid. If more than this number of bytes are read from the stream after the mark service is started, the reset service will have no effect.

Output Parameters

• stream: java.io.InputStream. Conditional - The InputStream. Returned only if the input parameter is stream.

• reader: java.io.Reader. Conditional - The reader object. Returned only if the input parameter is reader.

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.

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

Input Parameters

• stream: java.io.InputStream. Optional - The InputStream.

• reader: java.io.Reader. Optional - The reader object.

Output Parameters

• stream: java.io.InputStream. Conditional - The InputStream. Returned only if the input parameter is stream.

• supported: String - Indicates whether the stream supports the mark and reset operations. A value of:

  • true indicates that the InputStream supports the mark and reset operations.

  • false indicates that the InputStream does not support the mark and reset operations.

• reader: java.io.Reader. Conditional - The reader object. Returned only if the input parameter is reader.

Usage Notes

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

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

Input Parameters

• stream: Object - The InputStream. Object from which the service is to read bytes.

• offset: String. Optional - The offset into the byte array in the buffer to which the data is written. If no value is supplied, this defaults to 0.

• length: String. Optional - The maximum number of bytes to read from the InputStream. If no value is supplied, the default is the length of buffer. If the value supplied for length is greater than the length of buffer, an exception will be thrown.

• buffer: Object - The buffer into which data is written. This is a byte array, which can be created from a flow service by invoking createByteArray.

Output Parameters

• stream: Object - The InputStream. If any bytes were read from the stream, the stream is repositioned after the last byte read.

• buffer: Object - The buffer into which data was written.

• bytesRead: String - The number of bytes read from the InputStream and copied to buffer. If there is no more data because the end of the stream has been reached, bytesRead will be -1.

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

Input Parameters

• reader: java.io.Reader - The reader object.

• length: String - The maximum number of characters to read from the input reader object.

Output Parameters

• reader: java.io.Reader - The reader object.

• lengthRead: String - The number of characters read from the input reader object. If there is no more data because the end of the stream has been reached, lengthRead will be -1.

• value: String - The data read from the reader object, or null if end of stream has been reached.

Usage Notes

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

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

Input Parameters

• reader: java.io.Reader - The reader object.

Output Parameters

• string: String - Data read from the reader object.

Usage Notes

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

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

Input Parameters

• stream: java.io.InputStream. Optional - The InputStream.

• reader: java.io.Reader. Optional - The reader object.

Output Parameters

• stream: java.io.InputStream. Conditional - The InputStream. Returned only if the input parameter is stream.

• reader: java.io.Reader. Conditional - The reader object. Returned only if the input parameter is reader.

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.

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

Input Parameters

• stream: java.io.InputStream. Optional - The InputStream.

• reader: java.io.Reader. Optional - The reader object.

• length: String - The number of bytes or characters to skip.

Output Parameters

• stream: java.io.InputStream. Conditional - The InputStream. Returned only if the input parameter is stream.

• reader: java.io.Reader. Conditional - The reader object. Returned only if the input parameter is reader.

• bytesSkipped: String. Conditional - The actual number of bytes that were skipped. Returned only if the input parameter is stream.

• charactersSkipped: String. Conditional - The number of characters that were skipped. Returned only if the input parameter is reader.

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.

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

Input Parameters

• stream: java.io.InputStream - The InputStream that you want to convert.

Output Parameters

• bytes: byte[ ] - The bytes read from stream.

Usage Notes

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

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

Input Parameters

• inputStream: java.io.InputStream - The InputStream to convert to a reader object.

• encoding: String. Optional - Name of a registered, IANA character set (for example, ISO-8859-1). If you specify an unsupported encoding, the system throws an exception. If no value is specified or if the encoding is set to autoDetect, the default operating system encoding is used.

Output Parameters

• reader: java.io.Reader - The reader object read from inputStream.

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

Input Parameters

• inputStream: java.io.InputStream - The InputStream to convert to a string.

• encoding: String Optional - Name of a registered, IANA character set (for example, ISO-8859-1). If you specify an unsupported encoding, the system throws an exception. If no value is specified the encoding will be UTF-8.

Output Parameters

• string: String - Data read from inputStream and converted to a string.

Converts a string object to a StringReader object.

Input Parameters

• string: String - The string to convert to a StringReader object.

Output Parameters

• reader: java.io.StringReader - The StringReader object.

Converts a string to a binary stream.

Input Parameters

• string: String - The string object to be converted.

• encoding: String - Optional. Name of a registered, IANA character set, for example, ISO-8859-1. If you specify an unsupported encoding, the system throws an exception. If no value is specified, the encoding will be UTF-8.

Output Parameters

• inputStream: java.io.ByteArrayInputStream - An open InputStream created from the contents of string.

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

Input Parameters

• iterator: Object - The iterator object returned by the getNextBatch service.

Output Parameters

None.

Converts a document to JSON bytes (byte array).

Input Parameters

• document: Document - The document to be converted to JSON bytes (byte array).

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.

  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.

  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.

  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.

  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.

  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.

  • null to use the dateEncoding setting already in effect for the HTTP client making the request.

• encodeStringAsNumber: String. Optional.

  • true, to convert all the numbers in the string format to numbers by removing the quotes.

  • false, to retain all the numbers without converting.

  The default value is false.

• encodeStringAsBoolean: String. Optional.

  • true, to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false, to retain all the boolean values without converting. The default value is false.

Output Parameters

• jsonBytes: Object - JSON bytes (byte array) resulting from the conversion of a document.

Converts a document to a JSON stream.

Input Parameters

• document: Document - The document to be converted to a JSON stream.

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.

  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.

  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.

  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.

  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.

  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.

  • null to use the dateEncoding setting already in effect for the HTTP client making the request.

• encodeStringAsNumber: String. Optional.

  • true, to convert all the numbers in the string format to numbers by removing the quotes.

  • false, to retain all the numbers without converting.

  The default value is false.

• encodeStringAsBoolean: String. Optional.

  • true, to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false, to retain all the boolean values without converting. The default value is false.

Output Parameters

• jsonStream: java.io.InputStream - JSON stream resulting from the conversion of a document.

Converts a document to a JSON string.

Input Parameters

• document: Document - The document to be converted to a JSON string.

• prettyPrint: String - Formats the jsonString output parameter for human readability by adding carriage returns and indentation to the JSON content.

  Set to:

  • true to format the jsonString output field for human readability.

  • false to leave the jsonString output field in its unformed state.

  The service will not add any additional carriage returns or indentation to the JSON content.

• encodeDateAs: String. Optional. Specifies how java.util.Date instances in the document are encoded in the returned JSON.

  • long to encode java.util.Date instances as timestamps, specifically the number of milliseconds since Jan 1, 1970 00:00:00.

  • ISO8601 to encode java.util.Date instances as strings in a standard ISO format of: YYYY-MM-DD'T'HH:mm:ss.sssZ.

  • ISO_LOCAL_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • ISO_DATE to encode java.util.Date instances as strings in a standard ISO format with the offset if available.

  • ISO_ZONED_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format with the offset and zone if available.

  • ISO_INSTANT to encode java.util.Date instances as strings in a standard ISO format in UTC.

  • BASIC_ISO_DATE to encode java.util.Date instances as strings in a standard ISO format without an offset.

  • RFC_1123_DATE_TIME to encode java.util.Date instances as strings in a standard ISO format.

  • null to use the dateEncoding setting already in effect for the HTTP client making the request.

• encodeStringAsNumber: String. Optional.

  • true, to convert all the numbers in the string format to numbers by removing the quotes.

  • false, to retain all the numbers without converting.

  The default value is false.

• encodeStringAsBoolean: String. Optional.

  • true, to convert all the boolean values in the string format to Boolean by removing the quotes.

  • false, to retain all the boolean values without converting.

    The default value is false.

Output Parameters

• jsonString: Object - JSON string resulting from the conversion of a document.

Returns a batch iterator object.

Input Parameters

• jsonStream: Object - JSON content to be converted to a document (an IData object).

• arrayPaths: String List - The paths of the arrays to be parsed in the JSON input stream. Only the array elements from the paths mentioned in this parameter are considered even though the JSON stream might have more data. For example, to retrieve toppingA1 from the following JSON content, provide the array path as, /topping/0/toppingA/0/toppingA1.

                    "topping": [{
                    "toppingA": [{
                    "toppingA1": ["None71", "Glazed82"]
                    ...
                    }]}]

                

• containsKey: String - Indicates whether the specified hashtable element exists. A value of:

  • true - Indicates that the element exists.

  • false - Indicates that the element does not exist.

• decodeRealAsDouble: String. Optional - Converts real numbers from jsonStream to either a Float or Double Java wrapper type. Set to:

  • true to convert real numbers to Double Java wrapper type. This is the default.

  • false to convert real numbers to Float Java wrapper type.

• decodeIntegerAsLong: String. Optional - Converts integers from jsonStream to either a Long or Integer Java wrapper type. Set to:

  • true to convert integers to Long Java wrapper types. This is the default.

  • false to convert integers to Integer Java wrapper types.

• decodeRealAsString: String. Optional - Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the value specified in decodeRealAsDouble. This is the default value.

• unescapeSpecialChars: String. Optional - Controls whether IBM webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\\', '\"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document. This is the default.

  • false to keep these characters as is in the output document.

Output Parameters

• iterator: Object - A batch iterator object that has the list of arrays to be parsed in the JSON input stream. This object is passed as input to the getNextBatch service.

Usage Notes

None.

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

• iterator: Object - The iterator object returned by the getArrayIterator service.

• batchSize: Object - Number of array elements that the service should retrieve in one batch.

Output Parameters

• batch: Document - IData object that contains the following keys.

  • arrayPath: String - The path of the array elements retrieved in a batch. Since the service can iterate over multiple arrays, each batch contains the array path parsed in current iteration to help you identify the array to which the elements in the batch belong.

  • documents []: Document List - If array elements in the batch are JSON objects, they are returned as documents.

  • values []: Object List - If array elements in the batch are not JSON objects, they are returned as values.

• iterationStatus: Document - IData object that contains the following keys.

  • hasNext: String - Indicates whether there are more array elements in the iterator beyond this batch, which the service can retrieve. The value can be true or false.

  • iteration: String - Indicates the current iteration. It starts from 1. If the service runs N times to get all the array elements, then this value is N.

  • numberOfElementsInBatch: String - Indicates the number of elements in the current batch. This value is same as batchSize. However, this value can be less than the batch size for the last batch. For example, if there are 7 elements in an array and the batch size is 5, then the last batch will have only 2 elements.

  • totalElementsParsed: String - Indicates the number of array elements parsed until the current iteration. For example, if the number of elements parsed in the first iteration is 10, second iteration is 20, and third iteration is 7, then in the third iteration, the value of this parameter is 37.

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

• If two array paths overlap, the path that the service finds first in the input JSON stream is parsed and the other path is ignored. If you provide arrayPath[0] as /a/b and arrayPath[1] as /a/b/0/c to parse the following array, arrayPath[1] is ignored as the paths overlap and the first path retrieves all elements.

  {
                              "a": {
                              "b": [{
                              "f1": "v1",
                              "c": [1, 2, 3]
                              }]
                              }
                              }

• If an invalid array path is provided in the input, the getNextBatch service does not return any result on parsing the array.

• If the arrayPaths input parameter is not set, then the getNextBatch service parses the input considering that the input stream has a single anonymous array at the root level.

• If the arrayPaths input parameter is set, then it cannot contain null or empty elements.

• If one or more array paths are invalid, then the getArrayIterator service still creates an iterator object containing these paths. However, the getNextBatch service ignores the invalid paths.

  If all the paths are invalid, the getNextBatch service returns the documents and values parameters as null, the hasNext parameter as false, and all other output parameters as 0.

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

Input Parameters

• jsonBytes: java.lang.Byte[] - JSON content in bytes (byte array) to convert to a document.

• decodeRealAsDouble - String Optional - Converts real numbers from jsonBytes to either a Float or Double Java wrapper type.

  Set to:

  • true to convert real numbers to Double Java wrapper types.

  • false to convert real numbers to Float Java wrapper types.

  Default value is true.

• decodeIntegerAsLong: String Optional - Converts integers from jsonBytes to either a Long or Integer Java wrapper type.

  Set to:

  • true to convert integers to Long Java wrapper types.

  • false to convert integers to Integer Java wrapper types.

  Default value is true.

• decodeRealAsString: String. Optional. Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the values specified in decodeRealAsDouble.

  Default value is false.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that IBM webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to empty IData. The subsequent encoding of empty IData creates a JSON text of “{}”. This JSON content is different from the original JSON content (null) as the original null value gets converted to JSON text of "{}".

  • false to convert the null value to IData.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether IBM webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output Parameters

• document: Document - Document resulting from the conversion of jsonBytes.

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

Input Parameters

• jsonStream: java.io.InputStream - JSON content in an input stream to convert to a document.

• decodeRealAsDouble - String Optional - Converts real numbers from jsonStream to either a Float or Double Java wrapper type.

  Set to:

  • true to convert real numbers to Double Java wrapper types.

  • false to convert real numbers to Float Java wrapper types.

  Default value is true.

• decodeIntegerAsLong: String Optional - Converts integers from jsonStream to either a Long or Integer Java wrapper type.

  Set to:

  • true to convert integers to Long Java wrapper types.

  • false to convert integers to Integer Java wrapper types.

  Default value is true.

• decodeRealAsString: String. Optional. Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the values specified in decodeRealAsDouble.

  Default value is false.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that IBM webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to empty IData. The subsequent encoding of empty IData creates a JSON text of “{}”. This JSON content is different from the original JSON content (null) as the original null value gets converted to JSON text of "{}".

  • false to convert the null value to IData.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether IBM webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output Parameters

• document: Document - Document resulting from the conversion of jsonStream.

Converts content from the JSON content string to a document.

Input Parameters

• jsonString: String - JSON content string to convert to a document.

• decodeRealAsDouble - String Optional - Converts real numbers from jsonString to either a Float or Double Java wrapper type.

  Set to:

  • true to convert real numbers to Double Java wrapper types.

  • false to convert real numbers to Float Java wrapper types.

  Default value is true.

• decodeIntegerAsLong: String Optional - Converts integers from jsonString to either a Long or Integer Java wrapper type.

  Set to:

  • true to convert integers to Long Java wrapper types.

  • false to convert integers to Integer Java wrapper types.

  Default value is true.

• decodeRealAsString: String. Optional. Converts real numbers in the jsonStream to String. Set to:

  • true to convert real numbers to String.

  • false to not convert real numbers to String. The real numbers are then converted to either Float or Double Java wrapper type depending on the values specified in decodeRealAsDouble.

  Default value is false.

• decodeNullRootAsEmpty: String. Optional. Converts a null value that IBM webMethods Integration retrieves from JSON content to either IData or empty IData. Set to:

  • true to convert the null value to empty IData. The subsequent encoding of empty IData creates a JSON text of “{}”. This JSON content is different from the original JSON content (null) as the original null value gets converted to JSON text of "{}".

  • false to convert the null value to IData.

  Default value is false.

• unescapeSpecialChars: String. Optional. Controls whether IBM webMethods Integration unescapes the special characters '\n', '\r', '\t', '\b', '\f', '\', '"' while parsing JSON documents. Set to:

  • true to unescape these special characters (that is, '\n' will be replaced with new line, similarly other characters will also be replaced) in the output document.

  • false to keep these characters as is in the output document.

  Default value is true.

Output Parameters

• document: Document - Document resulting from the conversion of jsonString.

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

Input Parameters

• vector: java.util.Vector Optional - The vector object to which you want to add an item or list of items. If no value is specified, the service creates a new java.util.Vector object to which the item(s) will be added.
• item: Object Optional - Item to be added to the vector object.

• itemList: Object[ ] Optional - List of items to be added to the vector object.

• addNulls: String Optional - Specifies whether a null item can be added to the vector object. Set to:

  • false to prevent null values from being added to the vector object. This is the default.

  • true to allow null values to be added to the vector object.

Output Parameters

• vector: java.util.Vector - Updated vector object with the list of items added or an empty vector in case no items are added.

Usage Notes

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

Adds documents to a document list.

Input Parameters

• toList: Document List Optional - List to which you want to append documents. If you do not specify toList, the service creates a new list.

• fromList: Document List Optional - Documents you want to append to the end of toList.

• fromItem: Document Optional - Document you want to append to the end of toList. If you specify both fromList and fromItem, the service adds the document specified in fromItem after the documents in fromList.

Output Parameters

• toList: Document List - The toList document list with the documents in fromList and fromItem appended to it.

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.

Adds Strings to a String list.

Input Parameters

• toList: String List Optional - List to which you want to append Strings. If the value of toList is null, a null pointer exception error is thrown. If you do not specify toList, the service creates a new list.

• fromList: String List Optional - List of Strings to add to toList. Strings are added after the entries of toList.

• fromItem: String Optional - String you want to append to the end of toList. If you specify both fromList and fromItem, the service adds the String specified in fromItem after the Strings specified in fromList.

Output Parameters

• toList: String List - The toList String list with the Strings from fromList and fromItem appended to it.

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.

Returns the number of elements in a list.

Input Parameters

• fromList: Document List, String List, or Object List Optional - List whose size you want to discover. If fromList is not specified, the service returns a size of 0.

Output Parameters

• size: String - Number of entries in fromList.

• fromList: Document List, String List, or Object List - Original list.

Usage Notes

For example, if fromList consists of:

• fromList[0] = "a"
• fromList[1] = "b"
• fromList[2] = "c"

The result would be:

• size="3"

Converts a String list to a document list.

Input Parameters

• fromList: String List Optional - List of Strings (a String[ ]) that you want to convert to a list of documents. If fromList is not specified, the service returns a zero length array for toList.

• key: String Optional - Key name to use in the generated document list.

Output Parameters

• toList: Document List - Resulting document list.

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.

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

Input Parameters

• vector: java.util.Vector - The object to be converted to an array.
• stronglyType: String Optional - If this option is specified, the service expects all items in the vector to have the same Java type as the first non-null item in the vector. If the service detects an item of a different type, an error appears. Set to:
  • false to convert the vector to an object array. This is the default.
  • true to convert the vector to a strongly typed array holding the same type of objects.

Output Parameters

• array: Object[ ] - Converted object array.

Returns the absolute value of the input number.

Input Parameters

• num: String - Number whose absolute value is to be returned.

Output Parameters

• positiveNumber: String - Absolute value of the input number.

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

Input Parameters

• numList: String List - Numbers (floating point numbers represented in a string list) to add.

Output Parameters

• value: String - Sum of the numbers in numList. If a sum cannot be produced, value contains one of the following:

  • Infinity - The computation produces a positive value that overflows the representable range of a float type.
  • -Infinity- The computation produces a negative value that overflows the representable range of a float type.
  • 0.0 - The computation produces a value that underflows the representable range of a float type (for example, adding a number to infinity).
  • NaN - The computation produces a value that cannot be represented as a number (for example, any operation that uses NaN as input, such as 10.0 + NaN = NaN).

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.

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

Input Parameters

• num1: String - Number to add.

• num2: String - Number to add.

• precision: String Optional - Number of decimal places to which the sum will be rounded. The default value is null.

Output Parameters

• value: String - Sum of the numbers in num1 and num2. If a sum cannot be produced, value contains one of the following:

  • Infinity - The computation produces a positive value that overflows the representable range of a float type.

  • -Infinity - The computation produces a negative value that overflows the representable range of a float type.

  • 0.0 - The computation produces a value that underflows the representable range of a float type (for example, adding a number to infinity).

  • NaN - The computation produces a value that cannot be represented as a number (for example, any operation that uses NaN as input, such as 10.0 + NaN = NaN).

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.

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

Input Parameters

• numList: String List - Numbers (integers represented as Strings) to add.

Output Parameters

• value: String - Sum of the numbers in numList.

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.

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

Input Parameters

• num1: String - Number (integer represented as a String) to add.

• num2: String - Number (integer represented as a String) to add.

Output Parameters

• value: String - Sum of num1 and num2.

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.

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

Input Parameters

• num1: java.lang.Number - Number to add. See the Usage Notes for supported sub-classes.

• num2: java.lang.Number - Number to add. See the Usage Notes for supported sub-classes.

Output Parameters

• value: java.lang.Number - Sum of the numeric values of num1 and num2.

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:

• If either operand is of type Double, the other is converted to Double.
• Otherwise, if either operand is of type Float, the other is converted to Float.
• Otherwise, if either operand is of type Long, the other is converted to Long.
• Otherwise, both operands are converted to type Integer.

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

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

Input Parameters

• num1: String - Number (floating point number represented as a String) that is the dividend.

• num2: String - Number (floating point number represented as a String) that is the divisor.

• precision: String Optional - Number of decimal places to which the quotient will be rounded. The default value is null.

Output Parameters

• value: String - The quotient of num1 / num2. If a quotient cannot be produced, value contains one of the following:

  • Infinity - The computation produces a positive value that overflows the representable range of a float type.

  • -Infinity - The computation produces a negative value that overflows the representable range of a float type.

  • 0.0 - The computation produces a value that underflows the representable range of a float type (for example, dividing a number by infinity).

  • NaN - The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as dividing zero by zero or any operation that uses NaN as input, such as 10.0 + NaN = NaN).

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.

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

Input Parameters

• num1: String - Number (integer represented as a String) that is the dividend.

• num2: String - Number (integer represented as a String) that is the divisor.

Output Parameters

• value: String - The quotient of num1 / num2.

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.

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

Input Parameters

• num1: java.lang.Number - Number that is the dividend. See the Usage Notes for supported sub-classes.

• num2: java.lang.Number - Number that is the divisor. See the Usage Notes for supported sub-classes.

Output Parameters

• value: java.lang.Number - Quotient of num1 / num2.

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:

• If either operand is of type Double, the other is converted to Double.
• Otherwise, if either operand is of type Float, the other is converted to Float.
• Otherwise, if either operand is of type Long, the other is converted to Long.
• Otherwise, both operands are converted to type Integer.

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

Returns the largest number from a list of numbers.

Input Parameters

• numList: String List - List of numbers from which the largest number is to be returned.

Output Parameters

• maxValue: String - Largest number from the list of numbers.

Returns the smallest number from a list of numbers.

Input Parameters

• numList: String List - List of numbers from which the smallest number is to be returned.

Output Parameters

• minValue: String - Smallest number from the list of numbers.

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

Input Parameters

• numList: String List - Numbers (floating point numbers represented as Strings) to multiply.

Output Parameters

• value: String - Product of the numbers in numlist. If a product cannot be produced, value contains one of the following:

  • Infinity: The computation produces a positive value that overflows the representable range of a float type.

  • -Infinity: The computation produces a negative value that overflows the representable range of a float type.

  • 0.0 - The computation produces a value that underflows the representable range of a float type (for example, multiplying a number by infinity).

  • NaN - The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as multiplying zero by zero or any operation that uses NaN as input, such as 10.0 + NaN = NaN).

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.

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

Input Parameters

• num1: String - Number (floating point number represented as a String) to multiply.

• num2: String - Number (floating point number represented as a String) to multiply.

• precision: String Optional - Number of decimal places to which the product will be rounded. The default value is null.

Output Parameters

• value: String - Product of the numeric values of num1 and num2. If a product cannot be produced, value contains one of the following:

  • Infinity - The computation produces a positive value that overflows the representable range of a float type.

  • -Infinity |The computation produces a negative value that overflows the representable range of a float type.

  • 0.0 |The computation produces a value that underflows the representable range of a float type (for example, multiplying a number by infinity).

  • NaN |The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as multiplying zero by zero or any operation that uses NaN as input, such as 10.0 + NaN = NaN).

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.

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

Input Parameters

• numList: String List - Numbers (floating point numbers represented as Strings) to multiply.

Output Parameters

• value: String - Product of the numbers in numList.

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.

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

Input Parameters

• num1: String - Number (integer represented as a String) to multiply.
• num2: String - Number (integer represented as a String) to multiply.

Output Parameters

• value: String - Product of num1 and num2.

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.

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

Input Parameters

• num1: java.lang.Number - Number to multiply. See the Usage Notes for supported sub-classes.
• num2: java.lang.Number - Number to multiply. See the Usage Notes for supported sub-classes.

Output Parameters

• value: java.lang.Number - Product of num1 and num2.

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:

• If either operand is of type Double, the other is converted to Double.
• Otherwise, if either operand is of type Float, the other is converted to Float.
• Otherwise, if either operand is of type Long, the other is converted to Long.
• Otherwise, both operands are converted to type Integer.

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

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

• fractionLength: String - Specifies the number of digits for the generated random number. For example, if you specify 7, the random number generated will be 0.6536596.

Output Parameters

• number: String - Generated random number.

Returns a rounded number.

Input Parameters

• num: String - Number to be rounded.
• numberOfDigits: String - Specifies the number of digits to which you want to round the number.
• roundingMode: String Optional - Specifies the rounding method. Valid values for the roundingMode parameter are RoundHalfUp , RoundUp, RoundDown, RoundCeiling, RoundFloor, RoundHalfDown, and RoundHalfEven. The default value is RoundHalfUp.

Output Parameters

• roundedNumber: String - The rounded number.

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

Input Parameters

• num1: String - Number (floating point number represented as a String).
• num2: String - Number (floating point number represented as a String) to subtract from num1.
• precision: String Optional - Number of decimal places to which the difference will be rounded. The default value is null.

Output Parameters

• value: String - Difference of num1 - num2. If a difference cannot be produced, value contains one of the following:
• Infinity - The computation produces a positive value that overflows the representable range of a float type.
• -Infinity - The computation produces a negative value that overflows the representable range of a float type.
• 0.0 - The computation produces a value that underflows the representable range of a float type (for example, subtracting a number from infinity).
• NaN - The computation produces a value that cannot be represented as a number (for example, the result of an illegal operation such as multiplying zero by zero or any operation that uses NaN as input, such as 10.0 - NaN = NaN).

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.

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

Input Parameters

• num1: String - Number (integer represented as a String).
• num2: String - Number (integer represented as a String) to subtract from num1.

Output Parameters

• value: String - Difference of num1 - num2.

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.

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

Input Parameters

• num1: java.lang.Number - Number. See the Usage Notes for supported sub-classes.
• num2: java.lang.Number - Number to subtract from num1. See the Usage Notes for supported sub-classes.

Output Parameters

• value: java.lang.Number - Difference of num1 - num2.

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:

• If either operand is of type Double, the other is converted to Double.
• Otherwise, if either operand is of type Float, the other is converted to Float.
• Otherwise, if either operand is of type Long, the other is converted to Long.
• Otherwise, both operands are converted to type Integer.

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

Converts a string to numeric data type.

Input Parameters

• num: String - Number (represented as a string) to be converted to numeric format.
• convertAs: String Optional - Specifies the Java numeric data type to which the num parameter is to be converted. Valid values for the convertAs parameter are java.lang.Double, java.lang.Float, java.lang.Integer, java.math.BigDecimal,java.math.BigInteger, java.lang.Long. The default value is java.lang.Double .

Output Parameters

• num: java.lang.Number - Converted numeric object.

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

Input Parameters

• mimeData: Document - MIME object to which you want to add a body part. (This IData object is produced by createMimeData).

• content: java.io.InputStream or Object - Content that you want to add to the MIME object. content can be an InputStream or another MIME object. Use an InputStream to add an ordinary payload. Use a MIME object to add a payload that is itself a MIME message.

• isEnvStream:String - Flag that specifies whether content is to be treated as a MIME entity.

• mimeHeader: Document - Specifies the part headers that you want to add with this body part. Key names represent the names of the header fields. The values of the keys represent the values of the header fields. For example, if you wanted to add the following header fields:

  • X-Doctype: RFQ

  • X-Severity: 10

  You would set mimeHeader as follows:

  key	Value
  X-Doctype	RFQ
  X-Severity	10

  Be aware that the following MIME headers are automatically inserted by getEnvelopeStream when it generates the MIME message:

  • Message-ID

  • MIME-Version

  Additionally, you use the content, encoding, and description parameters to set the following fields:

  • Content-Type

  • Content-Transfer-Encoding

  • Content-Description

  If you set these header fields in mimeHeader and you create a single-part message, the values in contenttype, encoding, and description, if specified, will override those in mimeHeader. See usage notes.

• contenttype: String Optional - The value of the Content-Type header for this body part. For single-part messages, this value overrides the Content-Type value in mimeHeader, if one is present. Defaults to text/plain. See usage notes.

• encoding: String Optional - Specifies how the body part is to be encoded for transport and sets the value of the Content-Transfer-Encoding header. For single-part messages, this value overrides the Content-Transfer-Encoding value in mimeHeader, if one is present. Defaults to 7bit. See usage notes.

• `binary` to specify that content contains binary information that needs no encoding.

• quoted-printable` to specify that content contains 7 or 8-bit, line-oriented text that you want to encode using the quoted-printable encoding sheme.
• `base64` to specify that content contains an arbitrary sequence of octets that you want to encode using the base64 encoding scheme.
• `uuencode` to specify that content contains an arbitrary sequence of octets that you want to encode using the uuencode encoding scheme.

• description: String Optional - Specifies the value of the Content-Description header for this body part.

• multipart: String Optional - Flag that determines how addBodyPart behaves if mimeData already contains one or more body parts. By default, addBodyPart simply appends a new body part to mimeData if it already contains a payload. (This allows you to construct multi-part messages.) However, you can override this behavior if you want to either replace the existing payload with the new body part or throw an exception under these circumstances (see replace parameter, below). Set to:

  • yes to append a new body part to mimeData. This is the default.

  • no to replace the existing payload with the new body part. (Depending on the value of replace, this setting may cause addBodyPart to throw an exception.)

• replace: String Optional - Flag that specifies whether addBodyPart replaces the existing payload or throws an exception when it receives a mimeData that already contains a payload. This parameter is only used when multipart is set to no. Set to:

  • yes to replace the existing payload with the new body part. This is the default.

  • no to throw an exception.

Output Parameters

• mimeData: Document - MIME object to which the body part was added.

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:

• contenttype specifies the Content-Type for the entire MIME message. It overrides any value assigned to the Content-Type header in mimeHeader. If Content-Type is not specified in contenttype or mimeHeader, the value of the Content-Type header defaults to text/plain.

• encoding specifies the Content-Transfer-Encoding for the entire MIME message. It overrides any value assigned to the Content-Transfer-Encoding header in mimeHeader. If Content-Transfer-Encoding is not specified in encoding or mimeHeader, the value of the Content-Transfer-Encoding header defaults to 7bit.

For multipart messages:

• contenttype specifies the Content-Type for an individual body part. The Content-Type for the entire MIME message is automatically set to multipart/mixed, or to multipart/subType if a subtype was specified when the MIME object was created. See createMimeData.

• encoding specifies the Content-Transfer-Encoding for an individual body part. The Content-Transfer-Encoding header in mimeHeader, if present, specifies the encoding for the entire MIME message. If Content-Transfer-Encoding is not specified in mimeHeader, or if the specified value is not valid for a multipart message, the value of the Content-Transfer-Encoding header defaults to 7bit. (7bit, 8bit, and binary are the only encoding values valid for multipart messages.)

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

Input Parameters

• mimeData: Document - MIME object to which you want the header fields added. (This IData object is produced by createMimeData).

• mimeHeader: Document - Header fields that you want to add to the MIME object. Key names represent the names of the header fields. The values of the keys represent the values of the header fields. For example, to add the following header fields:

  • X-Doctype: RFQ

  • X-Severity: 10

  You would set mimeHeader as follows:

  key	Value
  X-Doctype	RFQ
  X-Severity	10

  Be aware that the following MIME headers are automatically inserted by getEnvelopeStream when it generates the MIME message:

  • Message-ID

  • MIME-Version

  If you set these values in mimeHeader, getEnvelopeStream will overwrite them at run time.

Output Parameters

• mimeData: Document - MIME object to which the header fields were added.

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.

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.

• If you are building a MIME message, you use this service to create an empty MIME object. You populate the empty MIME object with header fields and content, and then pass it to getEnvelopeStream, which produces the finished MIME message.

• If you are extracting data from a MIME message, you use this service to parse the original MIME message into a MIME object so that you can extract its header fields and content using other services.

Input Parameters

• input: java.io.InputStream Optional - MIME entity you want to parse. If input is not provided, createMimeData creates an empty MIME object.

• mimeHeader: Document Optional - Specifies header fields that you want to add to the MIME object. Key names represent the names of the header fields. The values of the keys represent the values of the header fields.

You would set mimeHeader as follows:

• subType: String Optional - String that specifies the subtype portion of the Content Type header, when the message is a multipart message and you want something other than the default value of mixed. For example, if you want the Content Type header to be multipart/related in the resulting message, set subType to related. subType is ignored if the resulting message is not a multipart message.

• decodeHeaders: String Optional - Specifies how the MIME header is to be decoded. Set to:

  • " "(empty String) to decode headers based on the value of the global watt property watt.server.mime.decodeHeaders. This is the default.

  • NONE to specify that the MIME header or body part headers do not need decoding.

  • ONLY_MIME_HEADER to decode the MIME header only.

  • ONLY_BODY_PART_HEADERS to decode the body part headers only.

  • BOTH to decode the MIME header and the body part headers.

Output Parameters

• mimeData: Document - MIME object. If input was passed to createMimeData, mimeData will contain the parsed MIME message. If input was not passed to createMimeData, mimeData will be empty.

• encrypted: String Conditional - Indicates whether input was an encrypted message. This parameter is not present when the service creates a new, empty MIME object. A value of:

  • true indicates that the message is encrypted (the original message stream is in stream).

  • false indicates that the message is not encrypted.

• signed: String Conditional - Flag whose value indicates whether input was a signed message. This parameter is not present when the service creates a new, empty MIME object. A value of:

  • true indicates that the message is signed (the original message stream is in stream).

  • false indicates that the message is not signed.

• certsOnly: String Conditional - Flag whose value indicates whether input contained only digital certificates. This parameter is not present when the service creates a new, empty MIME object. A value of:

  • true indicates that the message contains only certificates.

  • false indicates that the message contains a regular payload.

• stream: java.io.InputStream Conditional - InputStream containing the original MIME message from input. This parameter is present only when input is an S/MIME message.

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.

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

• mimeData: Document - MIME object whose content you want to retrieve. (This IData object is produced by createMimeData).

• index: String Optional - Index number of the body part whose content you want to retrieve (if you want to retrieve the content from a specific body part). The first body part is index number zero.

• contentID: String Optional - Value of the Content-ID header field of the body part whose content you want to retrieve (if you want to retrieve the payload from a specific body part).

Output Parameters

• content: IData - The payload of the specified body part.

• encrypted: String - Flag whose value indicates whether content is an encrypted MIME message. A value of:

  • true indicates that content is an encrypted message.

  • false indicates that content is not an encrypted message.

• signed: String - Flag indicating whether content is a signed MIME message. A value of:

  • true indicates that content is a signed MIME message.

  • false indicates that content is not a signed MIME message.

• certsOnly String - Flag whose value indicates whether content is a certs-only MIME message. A value of:

  • true indicates that content is a certs-only message.

  • false indicates that content is not a certs-only message.

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.

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

Input Parameters

• mimeData:Document - MIME object whose message headers you want to retrieve. (This IData object is produced by createMimeData).
• index: String Optional - Index number of the body part whose header fields you want to retrieve. The first body part is index zero.

• contentID: String Optional - Value of the Content-ID header field of the body part whose header fields you want to retrieve.

• decodeHeaders: String Conditional - Flag whose value indicates whether to decode encoded headers in the MIME object. Set to:

  • true to indicate that the headers should be decoded.

  • false to indicate that the headers should not be decoded. This is the default.

Output Parameters

• mimeHeader: Document - IData object containing the message headers. Key names represent the names of the header fields. The value of a key represents the value of that header field. For example, if the original message contained the following message header fields:

  • Content-Type: text/xml
  • X-Doctype: RFQ
  • X-Severity: 0

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.

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

Input Parameters

• mimeData: Document - MIME object whose Content-Type you want to discover (This IData object is produced by createMimeData).

Output Parameters

• contentType: String - Value of the MIME object's Content-Type header field. Note that this service returns only the media type and subtype portion of this header field's value. It does not return any parameters the value may include. For example, if the message's Content-Type header were:

  • Content-Type: text/plain;charset=UTF8

  contentType would contain:

  • text/plain

Usage Notes

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

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

Input Parameters

• mimeData: Document - MIME object from which you want to generate the MIME message(This IData object is produced by createMimeData).
• index: String Optional - Index number of the body part for which you want to generate the MIME message (if you want to generate the message from a specific body part). The first body part is index number zero.
• contentID: String Optional - Value of the Content-ID header field of the body part from which you want to generate the MIME message (if you want to generate the message from a specific body part).

• returnMimeMessage: String. Optional. Specifies whether the MIME message is returned as a javax.mail.internet.MimeMessage object when any of the body parts in the message exceed the large data threshold. Set to: - yes to return the MIME message in the mimeMessage output parameter as a MimeMessage when the large data threshold is exceeded. This is the default. - no to return the MIME message as an InputStream in the envStream output parameter when the large data threshold is exceeded.

• suppressHeaders: String List Optional - Names of header fields that are to be omitted from message. You can use this option to exclude header fields that getEnvelopeStream generates by default, such as Content-Type and content-encoding.

• createMultipart: String Optional - Specifies whether a multipart message is to be created, even if mimeData contains only one body part. Set to:

  • yes to create a multipart message (Content-Type message header is set to "multipart/mixed").

  • no to create a message based on the number of body parts in mimeData. This is the default.

    If the message contains only one body part, Content-Type is set according to the contenttype setting specified when that body part was added to mimeData.

    If the message contains multiple body parts, Content-Type is automatically set to "multipart/mixed."

Output Parameters

• envStream: java.io.InputStream - The MIME message as an InputStream.

• mimeMessage: javax.mail.internet.MimeMessage. Conditional. This service returns a mimeMessage instead of an envStream if any of the body parts have data mimeMessage greater than the specified threshold.

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.

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

Input Parameters

• mimeData: Document - MIME object whose message headers you want to retrieve (This IData object is produced by createMimeData).

Output Parameters

• mimeHeader: Document Conditional - An IData object containing the message headers. Key names represent the names of the header fields. The value of a key represents the value of the header fields. For example, if the original message contained the following message header fields:

   Message-ID: <002e01c0f150$6f33010a@sgx.com>
                              From: "Purch01@GSX.com" <Purch01@GSX.com>To:
                              <EXPEst@exprint.com>
                              MIME-Version: 1.0
                              Content-Type: text/xml
                              X-Doctype: RFQ
                              X-Severity: 0

  getMimeHeader would return the following:

  Key	Value
  Message-ID	<002e01c0f150$6f33010a@sgx.com>
  From	"Purch01@GSX.com" <Purch01@GSX.com>
  To	<EXPEst@exprint.com>
  MIME-Version	1.0
  Content-Type	text/xml
  X-Doctype	RFQ
  X-Severity	0

Usage Notes

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

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

Input Parameters

• mimeData:Document - MIME object whose parts you want to count (This IData object is produced by createMimeData).

Output Parameters

• numParts: String - The number of body parts in the MIME object.

Usage Notes

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

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

Input Parameters

• mimeData: Document - MIME object whose Content-Type you want to discover (This IData object is produced by createMimeData).

Output Parameters

• primContentType: String - Message's top-level Content-Type. For example, if the message's Content-Type header were:

  • Content-Type: multipart/mixed

  primContentType would contain:

  • multipart

Usage Notes

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

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

Input Parameters

• mimeData: Document - MIME object whose sub-type you want to discover (This IData object is produced by createMimeData).

Output Parameters

• subContentType: String - Message's sub-type. For example, if the message's Content-Type header were:

  • Content-Type: multipart/mixed

  primContentType would contain:

  • mixed

Usage Notes

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

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

• headerLines: Document - IData object containing the message headers (The message headers are returned in the lines document inside the header output parameter).

• body: Document - IData object containing the body of the message. This document must contain the body of the message in one of the following keys:

  • bytes: byte[ ] Optional - Body of the message.

  • stream: java.io.InputStream Optional - The body of the message.

Output Parameters

• stream: java.io.InputStream - InputStream containing the reassembled tap message.

Usage Notes

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

This service enables you to free up space in the Tspace by releasing body parts stored in it by the pub.mime:addBodyPart service. You need to provide a reference to the body part to be released.

Input Parameters

mimeData: Document. MIME object whose reference you want to release from the Tspace. (This IData object is produced by pub.mime:createMimeData.)

index: String. Optional. Index number of the body part whose content you want to release (if you want to release the content from a specific body part). The first body part is index number zero. Note: If contentID is specified, index is ignored.

contentID: String. Optional. Value of the Content-ID header field of the body part that you want to release (if you want to release the payload from a specific body part).

Output Parameters

releasedReferenceInTSpace: Boolean. Returns true if the reference was released and false if not.

Usage Notes

Before invoking this service, ensure that the body part has a reference in the Tspace.

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

Input Parameters

• object: Document. Where Document is an IData to be validated.

• conformsTo: Select the list of document types from the project.

• maxErrors: String. Optional. Number of errors to be collected. Default value is 1. When the number of errors found is equal to maxErrors, the validation processor stops validation and returns the result. If maxErrors is set to -1, the validation processor returns all errors.

• ignoreContent: String. Optional. Flag that specifies whether the validation processor will validate content keys of the type String or String List. Set to:

  • true to ignore content (that is, do not validate keys of these types).
  • false to validate content. This is the default.

• failIfInvalid: String. Optional. Flag that indicates whether the service should fail and throw an exception if the object is invalid. Set to:

  • true to indicate that the service should fail if the object is invalid.
  • false to indicate that service should signal success and return errors to the pipeline if the object is invalid. This is the default. .

Output Parameters

• isValid: String. Flag that indicates whether or not the validation was successful. A value of:

  • true indicates that the validation was successful.
  • false indicates that the validation was unsuccessful.

• errors: Document List. Errors encountered during validation. Each document will contain the following information:

  • pathName: String. Location of the error in XQL.
  • errorCode: String. Error code (for example, VV-001).
  • errorMessage: String. Error message (for example, Missing Object).

Usage Notes

• When validating supplied XML against an IS document type, IBM webMethods Integration uses the Java regular expression compiler by default.
• When validating against an IS document type, if the Allow null property is set to false for a field in the document type and the corresponding element in the instance document carries the attribute xsi:nil, IBM webMethods Integration displays the [] Undefined Object found error.
• When validating against an IS document type, if the Allow null property is set to false for a field in the document type and the corresponding element in the instance document contains content or contains child elements, IBM webMethods Integration displays the [] FieldName cannot have content or child elements since xsi:nil is true error.
• When validating XML, IBM webMethods Integration uses the W3C recommendation XML Schema Part 2: Datatypes.

Validates the pipeline against a document type.

Input Parameters

• conformsTo: Select the list of document types of a project.

• maxErrors: String. Optional. Number of errors to be collected. Default value is 1. When the number of errors found is equal to maxErrors, the validation processor stops validation and returns the result. If maxErrors is set to -1, the validation processor returns all errors.

• ignoreContent: String. Optional. Flag that specifies whether the validation processor will validate content keys of the type String, String List, or String Table. Set to:

  • true to ignore content (that is, do not validate keys of these types).
  • false to validate content. This is the default.

• failIfInvalid: String. Optional. Flag that indicates whether the service should fail and throw an exception if the object is invalid. Set to:

  • true to indicate that service should fail if object is invalid.
  • false to indicate that service should simply signal success and return errors to the pipeline if object is invalid. This is the default.

Output Parameters

• isValid: String. Flag that indicates whether or not the validation was successful. A value of:

  • true indicates that the validation was successful.
  • false indicates that the validation was unsuccessful.

• errors: Document List. Errors encountered during validation. Each document will contain the following information:

  • pathName: String. Location of the error in XQL.
  • errorCode: String. Error code (for example, VV-001).
  • errorMessage: String. Error message (for example, Missing Object).

Inserts a new entry into a data store.

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

Input Parameters

• storeName: String - Name of the data store in which to insert the entry.

• key: String - Key under which the entry is to be inserted.

• value: Document - Value to be inserted.

Output Parameters

• result: String - Flag indicating whether the entry was successfully added.

  A value of:

  • true indicates that the new entry was inserted successfully.
  • false indicates that the entry was not inserted (usually because an entry for key already exists).
• error: String - Error message generated while inserting the new entry into the data store.

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

• storeName: String - Name of the data store to delete.

• waitLength: String Optional - Length of time, in milliseconds, that you want to wait for this data store to become available for deletion if it is already locked by another thread.

Output Parameters

• count: String - Number of data store entries that were deleted. If the store does not exist, this value is 0.

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.

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

Input Parameters

• storeName: String - Name of the data store from which you want to retrieve the entry.

• key: String - Key of the entry whose value you want to retrieve.

• waitLength: String Optional - Length of time, in milliseconds, that you want to wait for this entry to become available if it is already locked by another thread.

• lockMode: String Optional - Type of lock you want to place on the entry.

  Set to:

  • Exclusive - To prevent other threads from reading or updating the entry while you are using it. The service also obtains a shared lock on the data store. An exclusive lock on an entry allows you to modify the entry.

  • Read - Is obsolete. If this value is specified, the service obtains a shared lock.

  • Share - To prevent other threads from obtaining an exclusive lock on the entry. The service also obtains a shared lock on the data store. A shared lock on an entry allows you to read, but not modify, the entry. This is the default.

Output Parameters

• value: Document - Retrieved entry. If the requested entry does not exist, the value of this parameter is null.

Usage Notes

• If you request an exclusive lock and the service finds a shared lock from the same thread on the entry, the service will automatically promote the shared lock on the entry to an exclusive lock.

• When this service locks an entry, it also acquires a shared lock on the associated data store to prevent another thread from deleting the data store, and the entries it contains, while your thread has the entry locked.

• 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.

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

Input Parameters

• storeName: String - Name of the data store from which you want to obtain a list of keys.

Output Parameters

• keys[]: String List - Keys for the data store specified in storeName.

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

Input Parameters

• storeName: String - Name of the data store containing the entry.

• key: String Optional - Key of the entry that you want to lock. If key is not supplied and you request:

  • A shared lock, the service obtains a shared lock on the data store, allowing other threads to read and modify entries, but not to delete them.
  • An exclusive lock, the service obtains an exclusive lock on the data store, preventing other threads from locking the data store and the entries, thereby preventing those threads from reading, modifying, or deleting the entries or the data store.

  If both storeName and key are specified and you request:

  • A shared lock, the service obtains a shared lock on the data store and the entry.
  • An exclusive lock, the service obtains a shared lock on the data store and an exclusive lock on the entry.

• waitLength: String Optional - Length of time, in milliseconds, that you want to wait for this entry to become available if it is already locked by another thread.

• lockMode: String Optional - Type of lock you want to place on the entry or data store.

  Set to:

  • Exclusive - To prevent other threads from obtaining a lock on the data store or entry. An exclusive lock on an entry allows you to modify the entry, and prevents other threads from reading or modifying the entry. An exclusive lock on a data store also locks the entries in the data store. In addition, an exclusive lock on a data store allows you to delete the data store.

  • Read - Is obsolete. If this value is specified, the service obtains a shared lock.

  • Share - To prevent other threads from obtaining an exclusive lock on an entry or a data store. A shared lock on an entry allows you to read, but not modify, the entry. A shared lock on a data store prevents another thread from deleting the data store. This is the default.

Output Parameters

None.

Usage Notes

• If you have not specified a key, and your flow service does not invoke put or unlock, or your flow service throws an exception before invoking put or unlock, the entire data store remains locked.
• If the key does not exist in the data store at the time your flow service executes, the lock service inserts the key with an empty value and takes the lock on the entry.
• If you request an exclusive lock on an entry, the service obtains an exclusive lock on the entry and a shared lock on the data store. If this service finds a shared lock from the same thread on the entry, the service will automatically promote the shared lock on the entry to an exclusive lock.
• If you request a shared lock on an entry, the service obtains a shared lock on the entry and a shared lock on the data store.
• If you request a shared lock on an entry or a data store and this service finds an exclusive lock from the same thread, the existing exclusive lock will be reused. The exclusive lock will not be demoted to a shared lock.
• If you request an exclusive lock on a data store, and this service finds a shared lock from the same thread on the data store, the service will automatically promote the shared lock on the data store to an exclusive lock.

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 started 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

• storeName: String - Name of the data store into which you want to insert or update the entry.

• key: String - Key where you want to insert or update the entry.

• value: Document - Value to be inserted or updated.

• waitLength: String Optional - Length of time, in milliseconds, that you want to wait for this entry to become available if it is already locked by another thread. If the wait length expires before a lock is obtained, the service fails and throws an exception. This parameter is used only when your service did not explicitly lock the entry beforehand.

Output Parameters

• error: String - Error message generated while inserting the new entry into the data store.

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.

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

• storeName: String - Name of the data store from which to remove an entry.

• key: String - Key of the entry that you want to remove.

• waitLength: String Optional - Length of time, in milliseconds, that you want to wait for this entry to become available for deletion if it is already locked by another thread.

Output Parameters

• result: String - Flag indicating whether the entry was successfully removed.

  A value of:

  • true indicates that the entry was removed successfully.

  • false indicates that the entry was not removed (usually because an entry for key does not exist).

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.

Input Parameters

• storeName: String - Name of the data store in which to unlock an entry.

• key: String Optional - Key of the entry that you want to unlock. If key is not supplied, the lock will be removed from the data store specified in storeName, but any locks on entries in the data store will remain.

Output Parameters

None.

Decodes a Base-64 encoded string into a sequence of bytes.

Input Parameters

• string: String - A Base64-encoded String to decode into bytes.

• encoding: String Optional - Specifies the encoding method. Default value is ASCII.

Output Parameters

• value: byte[] - The sequence of bytes decoded from the Base64-encoded String.

Converts a sequence of bytes into a Base64-encoded String.

Input Parameters

• bytes: byte[] - Sequence of bytes to encode into a Base64-encoded String.

• useNewLine: String Optional - Flag indicating whether to retain or remove the line breaks.

  Set to:

  • true to retain the line breaks. This is the default.

  • false to remove the line breaks.

• encoding: String Optional - Specifies the encoding method. Default value is ASCII.

Output Parameters

• value: String - Base64-encoded String encoded from the sequence of bytes.

Usage Notes

By default, the base64Encode service inserts line breaks after 76 characters of data, which is not the canonical lexical form expected by implementations such as MTOM. You can use the useNewLine parameter to remove the line breaks.

Converts a sequence of bytes to a String.

Input Parameters

• bytes: byte[] - Sequence of bytes to convert to a String.

• encoding: String Optional - Name of a registered, IANA character set (for example, ISO-8859-1). If you specify an unsupported encoding, the system throws an exception. To use the default encoding, set encoding to autoDetect.

• ignoreBOMChars: String Optional - Flag indicating whether or not the byte order mark (BOM) characters in the input sequence of bytes are removed before converting the byte array to string.

  Set to:

  • true to remove the byte order mark (BOM) characters before converting the input sequence of bytes to string, if the byte array contains BOM characters.

  • false to include the byte order mark (BOM) characters while converting the input sequence of bytes to string. The default is false.

Output Parameters

• string: String - String representation of the contents of bytes.

Performs a case-sensitive comparison of two strings and indicates whether the strings are identical.

Input Parameters

• inString1: String Optional - String to compare against inString2. This input variable can be null.
• inString2: String Optional - String to compare against inString1. This input variable can be null.

Output Parameters

• isEqual: String - Indicates whether or not inString1 and inString2 are identical.

  • true indicates that inString1 and inString2 are identical.

  • false indicates that inString1 and inString2 are not identical.

Concatenates two strings.

Input Parameters

• inString1: String - String to which you want to concatenate another string.

• inString2: String - String to concatenate to inString1.

Output Parameters

• value: String - Result of concatenating inString1 with inString2 (inString1 + inString2).

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.

Input Parameters

• inString: String (Required) - Text to be matched. Text should not be empty or null.

• matchData []: String (Required) - Array of strings, which are used for matching. If the string array value is either empty or null, it is not used for matching.

• similarityThreshold: String (Optional) - If the inexact match score is above the given threshold, then service output contains the matchedValue parameter. Default value is 0.65. Valid values should be between 0.0 and 1.0. Value 0.0 represents no match and value 1.0 represents an exact match.

• algorithm: String (Optional) - The algorithm used for an inexact match. Default value is Levenshtein. Supported algorithms are Levenshtein and JaroWinkler.

Output Parameters

• matchedValue: String (Optional) - If the inexact match is above similarityThreshold, then the returned value contains the matched string.

• similarity: String (Optional) - If the inexact match is above similarityThreshold, then it contains a similarity score. It provides the measure of how close the match is. The returned value can be between 0.0 and 1.0. Value 0.0 represents no match and value 1.0 represents an exact match.

Usage Notes

Search the web for more information about Levenshtein and JaroWinkler algorithms.

Replaces HTML character entities with native characters.

Specifically, this service:

Input Parameters

• inString: String - An HTML-encoded String.

Output Parameters

• value: String - Result from decoding the contents of inString. Any HTML character entities that existed in inString will appear as native characters in value.

Replaces HTML-sensitive characters with equivalent HTML character entities.

Specifically, this service:

These translations are useful when displaying text in an HTML context.

Input Parameters

• inString: String - The character you want to encode in HTML.

Output Parameters

• value: String - Result from encoding the contents of inString. Any HTML-sensitive characters that existed in inString, for example, > or &, will appear as the equivalent HTML character entities in value.

Returns the index of the first occurrence of a sequence of characters in a string.

Input Parameters

• inString: String - String in which you want to locate a sequence of characters.

• subString: String - Sequence of characters to locate.

• fromIndex: String Optional - Index of inString from which to start the search. If no value is specified, this parameter contains 0 to indicate the beginning of the string.

Output Parameters

• value: String - Index of the first occurrence of subString in inString. If no occurrence is found, this parameter contains -1.

Determines whether a string consists entirely of alphanumeric characters (in the ranges A–Z, a–z, or 0–9).

Input Parameters

• inString: String Optional - String to be checked for alphanumeric characters.

Output Parameters

• isAlphanumeric: String - Indicates whether or not all the characters in inString are alphanumeric.

  • true indicates that all the characters in inString are alphanumeric.

  • false indicates that not all the characters in inString are alphanumeric.

The service returns false if inString is not specified.

Determines whether a string follows a specified date pattern.

Input Parameters

• inString: String Optional - String to be checked for adherence to the specified date pattern.

• pattern: String - Date format for specifying the inString parameter (for example, yyyyMMdd HH:mm:ss.SSS). For more information about the pattern strings that can be specified for the date, see the “Pattern String Symbols” section.

Output Parameters

• isDate: String - Indicates whether or not inString follows the specified date pattern.

  • true indicates that inString follows the specified date pattern.

  • false indicates that inString does not follow the specified date pattern.

The service returns false if inString is not specified.

Usage Notes

The service returns an error if both inString and pattern are not specified.

You can specify any random string (for example, 111212) as both inString and pattern. The service returns true if the same user-defined string is specified as both inString and pattern. This is because the java.text.SimpleDateFormat class parses the user-defined input string and pattern to a valid date when the particular input values are identical.

Determines if a string is null, empty, or only whitespace.

Input Parameters

• inString: String. Optional. String to be checked.

• *ifPresent: Boolean. Optional.

  • If the value is set to true, the service checks whether inString is present or not, and only then proceeds with validation of the input.
  • If the value is set to false, the service throws an exception when inString is absent. Else, the service proceeds to validate the input.

Output Parameters

• isNullEmptyOrWhitespace: String. Indicates whether inString is null, empty, or only whitespace.

  • true indicates that inString has a null value, is empty, or is only whitespace.
  • false indicates that inString is not null, not empty, or is not only whitespace.

Examples

Service with inString = " \t\n\r\n" and ifPresent = true, returns true

Service with inString=" \t\n\r\n" and ifPresent = false, returns true

Service with inString = "abcd" and ifPresent = true, returns false

Service with inString = "abcd" and ifPresent = false, returns false

Service with ifPresent = true, returns true

Service with ifPresent = false, throws an exception.

Usage Notes

string:isNullEmptyOrWhitespace replaces string:isNullOrBlank which is deprecated.

Checks a string for a null or a blank value.

Input Parameters

• inString: String Optional - String to be checked for a null or a blank value.

• ifPresent: Boolean Optional - Set to one of the following values:

  • true indicates the service checks whether inString is present or not, and only then proceeds with validation of the input.
  • false indicates the service throws an exception when inString is absent. Else, the service proceeds to validate the input.

Output Parameters

• isNullorBlank: String - Indicates whether or not inString has a null or a blank value.

  • true indicates that inString has either a null or a blank value.

  • false indicates that inString contains a value that is not null.

  If inString is not specified, the service considers the string to be blank and returns true.

Determines whether the contents of a string can be converted to a float value.

Input Parameters

• inString: String Optional - String to be checked for conversion to float.

Output Parameters

• isNumber: String - Indicates whether or not inString can be converted to a float value.
  • true indicates that inString can be converted to a float value.
  • false indicates that inString cannot be converted to a float value.

The service returns false if inString is not specified.

Returns the length of a string.

Input Parameters

• inString: String - String whose length you want to discover.

Output Parameters

• value: String - The number of characters in inString.

Looks up a given key in a hash table and returns the string to which that key is mapped.

Input Parameters

• hashtable: java.util.Hashtable - Hash table that uses String objects for keys and values.

• key: String - Key in hashtable whose value you want to retrieve. The key is case sensitive.

Output Parameters

• value: String - Value of the string to which key is mapped. If the requested key in hashtable is null or if key is not mapped to any value in hashtable, the service returns null.

Locates a key in a String Table and returns the string to which that key is mapped.

Input Parameters

• lookupTable: String [] []. A multi-row, multi-column string table in which to search.
• keyColumnIndex: String. Index of the "key" column. Default is 0.
• valueColumnIndex: String. Index of the "value" column. Default is 1.
• key: String. Key to locate.

• ignoreCase: String. Optional. Flag indicating whether to perform a case-sensitive or case-insensitive search.

  Set to:

  • true to perform a case-insensitive search.

  • false to perform a case-sensitive search. This is the default.

• useRegex: String. Optional. Flag indicating whether the values in the table are to be interpreted as regular expressions.

Output Parameters

• value- String First value in the "value" column whose key matches key. If no match is found, this parameter is null.

Builds a single string by concatenating the elements of a String List.

Input Parameters

• elementList[]: String List - Strings to concatenate.

• separator: String - String to insert between each non-null element in elementList.

Output Parameters

• value: String - Result from concatenating the strings in elementList. Strings are separated by the characters specified in separator.

Formats an array of strings into a given message pattern.

Input Parameters

• pattern: String - Message that includes "placeholders" where elements from argumentList are to be inserted. The message can contain any sequence of characters. Use the {n} placeholder to insert elements from argumentList, where n is the index of the element that you want to insert.

  For example, the following pattern string inserts elements 0 and 1 into the message: Test results: {0} items passed, {1} items failed.

• argumentList: String List Optional - List of strings to use to populate pattern. If argumentList is not supplied, the service will not replace placeholders in pattern with actual values.

Output Parameters

• value: String - Result from substituting argumentList into pattern. If pattern is empty or null, this parameter is null.

Formats a number into a given numeric pattern.

Input Parameters

• num: String - The number to format.

• pattern: String - A pattern string that describes the way in which num is to be formatted:

  This symbol...	Indicates...
  0	A digit.
  #	A digit. Leading zeroes will not be shown.
  .	A placeholder for a decimal separator.
  ,	A placeholder for a grouping separator.
  ;	A separation in format.
  -	The default negative prefix.
  %	That num will be multiplied by 100 and shown as a percentage.
  X	Any character used as a prefix or suffix (for example, A, $ ).
  '	That special characters are to be used as literals in a prefix or suffix. Enclose the special characters within '' (for example, '#').

  The following are examples of pattern strings:

  Pattern	Description
  #,###	Use commas to separate into groups of three digits. The pound sign denotes a digit and the comma is a placeholder for the grouping separator.
  #,####	Use commas to separate into groups of four digits.
  $#.00	Show digits before the decimal point as needed and exactly two digits after the decimal point. Prefix with the $ character.
  '#'#.0	Show digits before the decimal point as needed and exactly one digit after the decimal point. Prefix with the # character. The first character in a pattern is the dollar sign ($). The pound sign denotes a digit and the period is a placeholder for decimal separator.

Output Parameters

• value: String - num formatted according to pattern. If pattern is an empty (not null) string, the default pattern of comma separators is used and the number of digits after the decimal point remains unchanged.

Converts an object to string representation using the Java toString() method of the object.

Input Parameters

• object: Object - The object to be converted to string representation.

Output Parameters

• string: String - String representation of the input object converted using the Java toString() method of the object.

Pads a string to a specified length by adding pad characters to the beginning of the string.

Input Parameters

• inString: String - String that you want to pad.

• padString: String - Characters to use to pad inString.

• length: String - Total length of the resulting string, including pad characters.

Output Parameters

• value: String - Contents of inString preceded by as many pad characters as needed so that the total length of the string equals length.

Usage Notes

If padString is longer than one character and does not fit exactly into the resulting string, the beginning of padString is aligned with the beginning of the resulting string. For example, suppose inString equals shipped and padString equals x9y.

If inString is longer than length characters, only the last length characters from inString are returned. For example, if inString equals acct1234 and length equals 4, value will contain 1234.

Pads a string to a specified length by adding pad characters to the end of the string.

Input Parameters

• inString: String - String that you want to pad.

• padString: String - Characters to use to pad inString.

• length: String - Total length of the resulting string, including pad characters.

Output Parameters

• value: String - Contents of inString followed by as many pad characters as needed so that the total length of the string equals length.

Usage Notes

If padString is longer than one character and does not fit exactly into the resulting string, the end of padString is aligned with the end of the resulting string. For example, suppose inString equals shipped and padString equals x9y.

If inString is longer than length characters, only the first length characters from inString are returned. For example, if inString equals 1234acct and length equals 4, value will contain 1234.

Replaces all occurrences of a specified substring with a substitute string.

Input Parameters

• inString: String - String containing the substring to replace.

• searchString: String - Substring to replace within inString.

• replaceString: String - Character sequence that will replace searchString. If this parameter is null or empty, the service removes all occurrences of searchString from inString.

• useRegex: String Optional - Flag indicating whether searchString is a regular expression. When regular expressions are used to specify a search string, replaceString may also contain interpolation fields (for example, "$1") that match parenthetical subexpressions in searchString.

  Set to:

  • true - To indicate that searchString is a regular expression.

  • false - To indicate that searchString is not a regular expression. This is the default.

Output Parameters

• value: String - Contents of inString with replacements made.

Converts a string to a byte array.

Input Parameters

• string: String - String to convert to a byte[].

• encoding: String Optional - Name of a registered, IANA character set that specifies the encoding to use when converting the String to an array of bytes (for example: ISO-8859-1). To use the default encoding, set this value to autoDetect. If you specify an unsupported encoding, an exception will be thrown.

Output Parameters

• bytes: byte[] - Contents of string represented as a byte[].

Replaces a pipeline variable with its corresponding value.

Input Parameters

• inString: String Optional - String containing the pipeline variable to replace. Specify the name of the pipeline variable between the % symbols (for example, %phone%).

Output Parameters

• value: String - Contents of inString with the pipeline variable replaced.

Usage Notes

The service returns an error if inString is not specified.

If inString does not contain any variable between the % symbols, or contains a value other than the pipeline variable between the % symbols, the service does not perform any variable substitution from the pipeline.

If you want to include the % symbol in the output, you can specify it as \% in inString. To specify the value of the pipeline variable as a percentage in the output, append \% after the variable name in inString. For example, suppose a pipeline variable revenueIncreasePercent has a value of 100.

The service cannot be used for substitution of global variables.

Returns a substring of a given string.

Input Parameters

• inString: String - String from which to extract a substring.

• beginIndex: String - Beginning index of the substring to extract (inclusive).

• endIndex: String - Ending index of the substring to extract (exclusive). If this parameter is null or empty, the substring will extend to the end of inString.

Output Parameters

• value: String - Substring from beginIndex and extending to the character at endIndex - 1.

Tokenizes a string using specified delimiter characters and generates a String List from the resulting tokens.

This service does not return delimiters as tokens.

Input Parameters

• inString: String - String you want to tokenize, that is, break into delimited chunks.

• delim: String - Delimiter characters. If null or empty, the service uses the default delimiters \t\n\r, where t, n, and r represent the white space characters tab, new line, and carriage return.

• useRegex: Boolean Optional - If the value is set to true, IBM webMethods Integration supports recognizing the delimiter character set for the delim parameter as a regular expression. If the value is set to false, IBM webMethods Integration considers the delimiter character set for the delim parameter as an individual character. This is the default.

Output Parameters

• valueList []: String List - Strings containing the tokens extracted from inString.

Converts all characters in a given string to lowercase.

Input Parameters

• inString: String - String to convert.

• language: String Optional - Lowercase, two-letter ISO-639 code. If this parameter is null, the system default is used.

• country: String Optional - Uppercase, two-letter ISO-3166 code. If this parameter is null, the system default is used.

• variant: String Optional - Vendor and browser-specific code. If null, this parameter is ignored.

Output Parameters

• value: String - Contents of inString, with all uppercase characters converted to lowercase.

Converts all characters in a given string to uppercase.

Input Parameters

• inString: String - String to convert.

• language: String Optional - Lowercase, two-letter ISO-639 code. If this parameter is null, the system default is used.

• country: String Optional - Uppercase, two-letter ISO-3166 code. If this parameter is null, the system default is used.

• variant: String Optional - Vendor and browser-specific code. If null, this parameter is ignored.

Output Parameters

• value: String - Contents of inString, with all lowercase characters converted to uppercase.

Trims leading and trailing white space from a given string.

Input Parameters

• inString: String - String to trim.

Output Parameters

• value: String - Contents of inString with white space trimmed from both ends.

Decodes a URL-encoded string.

Input Parameters

• inString: String URL-encoded string to decode.

Output Parameters

• value: String - Result from decoding inString. If inString contains plus (+) signs, they will appear in value as spaces. If inString contains %hex encoded characters, they will appear in value as the appropriate native character.