values | Document The IS document (IData object) object that you want to convert to a String. | |
EDItemplate | Document (optional) This input parameter is provided only for backwards compatibility. It should contain a single name/value pair that is a String named templateName with the value set to the namespace name of the flat file schema to use for the conversion. This is the output from the
wm.b2b.edi.templateMgr:getTemplate service. Do not specify an EDI template. You must specify ffSchema, EDItemplate, or nsRecord. The parameters nsRecord and EDItemplate is deprecated, so it is recommended that you use ffSchema. | |
ffSchema | String The fully-qualified namespace name of the flat file schema to use to convert the specified IS document (IData object) (in values) to a String. You must specify ffSchema, EDItemplate, or nsRecord. The parameters nsRecord and EDItemplate is deprecated, so it is recommended that you use ffSchema. | |
spacePad | String How you want the resulting String to be justified. Specify one of the following: | |
Value | Meaning | |
left | Left justify. | |
right | Right justify. | |
none | No justification. This is the default. | |
noEmptyTrailingFields | String Whether to remove empty trailing fields from records. The convertToString service only uses this parameter for records that have delimited fields. Specify true or false. | |
Value | Meaning | |
true | The convertToString service removes empty trailing fields from the output. For example, a record with empty trailing fields might look like the following: AAA*01*02! (where ! is the segment terminator). This is the default. | |
false | The convertToString service does not remove empty trailing fields. Instead it uses the field separator to denote an empty field. For example, a record with empty trailing field might look like the following: AAA*01*02********!(where * is the field separator and ! is the segment terminator). | |
nsRecord | String (optional) The fully-qualified name of the IS document type on which the resulting String will be based. If you specify nsRecord, the convertToString service ignores the ffSchema parameter. You must specify ffSchema, EDItemplate, or nsRecord. The parameters nsRecord and EDItemplate is deprecated, so it is recommended that you use ffSchema. | |
Segment_terminator | String (optional) The segment terminator character that you want the convertToString service to append to the end of each record in the output String. | |
Field_separator | String (optional) The field separator that you want the convertToString service to insert between each field for each segment in the output String. | |
Subfield_separator | String (optional) The subfield separator that you want the convertToString service to use for composite elements. | |
FormatInfo | Document (optional) Values you want the convertToString service to pass unmodified to all format services it invokes. | |
releaseCharacter | String (optional) The character you want the convertToString service to use as an escape character. If one of the characters that you specify for Segment_terminator, Field_separator, or Subfield_separator appears in field or subfield, the convertToString service will prefix the character with this escape character before writing it to the output String. | |
outputFileName | String (optional) The name of the file to which you want the String output written. If you do not specify outputFileName the output is not written to a file. | |
encoding | String (optional) The encoding of the InputStream passed in to edidata. The default is UTF-8. | |
startAt | String Allows the convertToString service to start at a specific record in the flat file schema used to create the output string. Specify the path to the element where you want to start composing the output string. | |
sortInput | String (optional) Whether you want the service to sort the input records to match the flat file schema specified in ffSchema. When set to true (the default), this flag is useful in either of the following cases: ![]() ![]() | |
true | You want the service to sort the input records. This is the default. Important: If you select to sort the input records, note that: ![]() ![]() ![]() ![]() | |
false | You do not want the service to sort the input records. | |
countSegments | String Whether to count the number of segments written to the output file. | |
true | The convertToString service counts the number of segments written to the output file and returns that number in the output parameter segmentCount. This is the default. | |
false | The convertToString service does not count the number of segments written to the output file. | |
RepeatingField_separator | String (optional) The field separator that you want the convertToString service to insert between repeating fields of an EDI document. Module for EDI recognizes both repeating simple fields and repeating composite fields. |
string | String The output String that represents the data specified in the values input parameter. |
errorArray | String List Error messages describing the errors that the convertToString service encountered during conversion. If the convertToString service did not encounter errors, errorArray is null. |
segmentCount | String The number of records written; only returned when countSegments is true. |