value | String The field value to format. | |
direction | String Indicates the type of formatting to apply to the field. Specify one of the following for direction: | |
Value | Meaning | |
convertToString | Apply external formatting. | |
convertToValues | Apply internal formatting. | |
validate | String The value of the validate input parameter from the
wm.b2b.edi:convertToValues service. This indicates whether the service should update the value to be validated for this field. The value is true or false. | |
Value | Meaning | |
true | Set the valueToValidate output parameter with the formatted value, so the formatted value is validated. | |
false | Value will not be validated. Note that validate is always false when direction is convertToString. | |
minLength | String (optional) The minimum length of the field. The following describes how this field is used. If the field is extracted via the Fixed Position Extractor, minLength is used to determine the minimum number of characters to extract. If the field is not extracted via the Fixed Position Extractor and is associated with a Length Validator, minLength is used to determine the minimum length to consider valid. Otherwise, minLength is not used and will not be present in the pipeline. | |
maxLength | String (optional) The maximum length of the field. If the field is extracted via the Fixed Position Extractor, maxLength is used to determine the maximum number of characters to extract. If the field is not extracted via the Fixed Position Extractor and is associated with a Length Validator, maxLength is used to determine the maximum length to consider valid. If the maximum length is unlimited (-1) or there is no Length Validate, maxLength is not used and will not be present in the pipeline. | |
FormatInfo | Document (optional) Information that can be used by individual formatting services. This information is obtained from one of three locations: If the
wm.b2b.edi:convertToString service is invoking the format service, this is the value of the input parameter of the convertToString service. If the
wm.b2b.edi:convertToValues service is invoking the format service, this is the value of the input parameter, delimiters/FormatInfo, of the convertToValuesservice If converting fields for a UN/EDIFACT document, the EDI document type automatically extracts the decimal separator from the UNA segment. The only format services that use this feature are the decimal formatting services (for implied decimal and decimal formats). The FormatInfo parameter should contain a String name/value pair named DecimalCharacter. If DecimalCharacter is ',' the number would be formatted as 100,10 (European format) instead of 100.10, as is common in the U.S. Note: Changes to the data in this object will be reflected in all other format services that are invoked during execution of the convertToStringandconvertToValues services. |
formattedValue | String The field value with appropriate formatting applied. | |
meetsFormat | String Whether the value could be formatted properly. It will be true or false. | |
Value | Meaning | |
true | The value could be properly formatted. | |
false | The value could not be properly formatted. | |
errorMessage | String If meetsFormat is false, this parameter provides a text message describing the formatting error. | |
valueToValidate | String The value that will be used by the validator for this field. If this value is not present, the value passed in the value input parameter will be validated. This field is used only when the validate input parameter is set to true. |