Module for EDI 9.12 | Building Services with EDI Module | Part I WmEDI Package | WmEDI Core Services | Summary of Elements in this Folder | wm.b2b.edi:SEFParse
 
wm.b2b.edi:SEFParse
WmEDI. Creates a flat file schema from a Standard Exchange Format (SEF) file and saves the flat file schema in the Integration Server namespace.
The flat file schema that this service creates describes the EDI document structure (that is, contains information about how an envelope or a document of a particular standard should be constructed). The schema also contains validation criteria.
Input Parameters
url
String The full URL of the SEF file from which you want to create a flat file schema. For example, if the SEF file is located in the /pub directory of the WmEDIProduction package on the Rubicon server, you type:
http://rubicon:5555/WmEDIProduction/4010.sef
If the SEF file is on a local file system, use the SEFfilename input parameter instead of url and method.
method
String The HTTP method; specify GET. If you specify url, you must specify method.
auth
Document (optional) Authorization information that the HTTP service will submit if the resource specified in url is protected. The format of auth is:
Key
Description
type
String Type of authentication you want the HTTP service to use when it submits this request.
Currently, only basic authentication is supported. If you are accessing a protected resource, set auth to Basic.
user
String The user name that the SEFParse service will submit when requesting a protected resource.
pass
String The password associated with user.
data
Document (optional) Data that you want the HTTP service to submit with the HTTP request. Specify your data in one of the following elements:
Key
Description
args
Document An IS document (IData object) that contains the name/value pairs that you want the HTTP service to submit to the resource in url. Create one element for each name/value pair, where name is the element's name and value is the value of the element.
Note that when you use args, the HTTP service will:
*Automatically url-encode the name/value pairs. You do not need to url-encode the values.
*Automatically insert the "&" character between pairs. You do not need to include it.
*Automatically prefix the entire query string with the "?". You do not need to include this character.
string
String A string of text that you want the HTTP service to submit to the resource in url.
If you use string to submit data, make sure that you specify the string exactly as you want it presented in the HTTP request. Also make sure you url-encode the contents of string.
bytes
String Table Data that the HTTP service will use to construct a query string to submit to the resource specified in url. Note that the bytes, input parameter is similar to args, but bytes allows you to submit unnamed values in a query string, not just name/value pairs.
Specify each value you want to submit in a separate row in the String Table. When you specify the String, ensure:
*The contents of column 0 represent the name portion of the pair (leave this column null to submit an unnamed value).
*The contents of column 1 represent the value portion of the pair.
Note that when you use bytes, the HTTP service will:
*Automatically url-encode the name/value pair. You do not need to url-encode the values.
*Automatically insert the "&" character between the pairs (or unnamed values) that it constructs. You do not need to include it.
*Automatically prefix the entire query string with the "?" character if it submits the data in table via the GET method. You do not need to include this character.
headers
Document (optional) Fields that you want to explicitly override in the HTTP request header that the HTTP service issues.
Specify one element in the headers IS document (IData object) for each header field that you want to set, where:
*The element's name represents the name of the header field.
*The element's value represents the value of that header field.
If you do not set headers, the HTTP service will use its default header values.
SEFfileName
String (optional) The full path and file name of the SEF file on your local file system. If the SEF file is located on a Web server, use the url and method parameters instead of SEFfileName.
EDIDocName
String The EDI transaction set name (e.g., 850) or TRADACOMS file name (e.g., INVOIC), for which you want to create a flat file schema. Specify only a single value.
includeEnvelope
String (optional) Whether you want the SEFParse service to create envelope segments in the output flat file schema objects.
Value
Meaning
false
The SEFParse service does not create the envelope segments (i.e., ISA/IEA, GS/GE, UNB/UNZ, UNG/UNE, STX/END, BAT/EOB, MHD/MTR) in the output flat file schema object. This is the default.
true
The SEFParse service does create the envelope segments in the output flat file schema object.
isBigDocTemplate
String (optional) Whether you will use the generated flat file schema to parse documents that are considered large. Specify false or true. For more information about large document handling, see the webMethods Module for EDI Installation and User’s Guide.
Value
Meaning
false
You will not use the generated flat file schema to parse large documents. This is the default.
true
You will use the generated flat file schema to parse large documents.
version
String (optional) The version of the EDI standard. For TRADACOMS, specify the version of the TRADACOMS File document type.
targetSchema
String The fully qualified name that you want to assign the flat file schema that you are creating. For all supported EDI standards except TRADACOMS, use the following naming convention for targetSchema:
EDIFFSchema.standard.Vversion:Ttransaction
where:
*standard represents the EDI standard (e.g., X12).
*version represents the EDI standard version (e.g., 4010).
*transaction represents the EDI transaction (e.g., 850).
For example: EDIFFSchema.X12.V4010:T850
For the TRADACOMS EDI standard, the wm.b2b.edi:SEFParseservice creates a temporary flat file schema. Use the following naming convention for targetSchema:
EDIFFSchema.Tradacoms.Vversion.Tname:TEMP_SCHEMA
where:
*version represents the version of the TRADACOMS File document type (for example, v2)
*name represents the name of the TRADACOMS File document type (for example, ORDHDR)
This temporary flat file schema contains all the messages contained in the TRADACOMS file. Because the flat file parser (the wm.b2b.edi.tradacoms:convertToValues service) cannot always properly parse this temporary flat file schema, you should then execute the wm.b2b.edi.tradacoms.ui:modifyTradacomsSchema service to split the flat file schema into one flat file schema per MHD segment in the TRADACOMS file. This temporary flat file schema will be deleted upon successful execution of the wm.b2b.edi.tradacoms.ui:modifyTradacomsSchema service.
Note:
You must also specify a value for the targetDictionary parameter.
If you use the migration utilities to move templates from version 4.x to flat file schemas in 6.0.x, the utility creates the flat file schemas using the naming convention described above. For more information about migrating 4.x templates to flat file schemas, see webMethods Module for EDI Installation and User’s Guide.
targetPackage
String The name of the Integration Server package in which to create the flat file schema.
targetDictionary
String The name of the flat file dictionary to hold the record, field, and composite definitions for this flat file schema.
overwriteDictionary
String (optional) Whether you want the SEFParse service to overwrite entries in the target dictionary if they already exist.
Value
Meaning
false
Do not overwrite flat file dictionary entries in the target dictionary if the entries already exist. This is the default.
true
Overwrite existing dictionary entries with values specified by this SEF file. If you specify true for overwriteDictionary, the SEFParse service ignores the sourceDictionaries parameter.
sourceDictionaries
String List (optional) Names of flat file dictionaries in which to search for definitions of records, fields, and composites. If a definition already exists, refer to it instead of creating a new entry in the targetDictionary.
Output Parameters
None.
Usage Notes
*To view the flat file schema that you create using the SEFParse service in Software AG Designer, you must refresh your connection to Designer.
*If a EDI document contains multiple consecutive HL segments, this service will create a flat file schema that contains a single HL record. That record will be a superset of all the HL segment definitions in the original SEF file.
Example
See the wm.b2b.edi:createTemplateFromSEF service.