sterling standards library -...

74
Sterling Standards Library Using EDIFACT 8.0.4, for Sterling B2B Integrator 5.2.4

Upload: others

Post on 05-Oct-2020

32 views

Category:

Documents


5 download

TRANSCRIPT

Page 1: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Sterling Standards Library

Using EDIFACT8.0.4, for Sterling B2B Integrator 5.2.4

���

Page 2: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT
Page 3: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Sterling Standards Library

Using EDIFACT8.0.4, for Sterling B2B Integrator 5.2.4

���

Page 4: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

NoteBefore using this information and the product it supports, read the information in “Notices” on page 63.

Copyright

This edition applies to Version 8 Release 0 Modification 4 of the IBM Sterling Standards Library and to allsubsequent releases and modifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2000, 2015.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 5: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Contents

Chapter 1. Using EDIFACT with theSterling B2B Integrator . . . . . . . . 1Use EDIFACT with Sterling B2B Integrator . . . . 3

Chapter 2. EDIFACT Business Processes 5EDIFACTDeenvelopeUnified Business Process . . . 5EDIFACTEnvelopeUnified Business Process . . . . 5Before Using the EDIFACTEnvelopeUnified BusinessProcess . . . . . . . . . . . . . . . . 6

Chapter 3. EDIFACT EnvelopingOverview . . . . . . . . . . . . . . 7Envelope Structure . . . . . . . . . . . . 7Using Wildcards in EDI Enveloping and EDIDeenveloping services . . . . . . . . . . . 8Create an EDIFACT Envelope. . . . . . . . . 9Update an EDIFACT Envelope . . . . . . . . 10Delete an EDIFACT Envelope . . . . . . . . 10

Chapter 4. EDIFACT Inbound Syntax 4UNB UNZ Envelope Properties,Interchange Level . . . . . . . . . . 13

Chapter 5. EDIFACT Inbound Syntax 4UNG UNE Envelope Properties, GroupLevel . . . . . . . . . . . . . . . 17

Chapter 6. EDIFACT Inbound Syntax 4UNH UNT Envelope Properties,Transaction Level . . . . . . . . . . 21

Chapter 7. EDIFACT Outbound Syntax4 UNB UNZ Envelope Properties,Interchange Level . . . . . . . . . . 35

Chapter 8. EDIFACT Outbound Syntax4 UNG UNE Envelope Properties,Group Level . . . . . . . . . . . . 43

Chapter 9. EDIFACT Outbound Syntax4 UNH UNT Envelope Properties,Transaction Level . . . . . . . . . . 47

Chapter 10. Creating EDIFACT Maps . . 55EDIFACT Components in the Sterling B2BIntegrator Map Editor . . . . . . . . . . . 55

Using Transaction XREF with EDIFACT . . . . . 56Create an EDIFACT Map . . . . . . . . . . 57

Chapter 11. Generate an EDIFACTReport . . . . . . . . . . . . . . . 59

Chapter 12. Search for EDIFACTCorrelations . . . . . . . . . . . . 61

Notices . . . . . . . . . . . . . . 63

© Copyright IBM Corp. 2000, 2015 iii

Page 6: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

iv Sterling Standards Library: Using EDIFACT

Page 7: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 1. Using EDIFACT with the Sterling B2B Integrator

EDIFACT (Electronic Data Interchange For Administration, Commerce, andTransport) is the international EDI standard developed under the United Nations.EDIFACT has been adopted by the International Organization for Standardization(ISO) as the ISO standard ISO 9735. The EDIFACT standard provides a set ofsyntax rules to structure data, an interactive exchange protocol (I-EDI), andstandard messages which allow multi-country or region and multi-industryexchange.

This table describes how the Sterling B2B Integrator supports EDIFACT:

Functionality DetailsAction You Need to Take toImplement EDIFACT

Services v EDIFACT Enveloping servicetranslates messages, determineswhich business processes need torun to apply EDI envelopes, andstarts those business processes.This service improves performanceof EDI EDIFACT by consolidatingEnvelopeUNH, EnvelopeUNG, andEnvelopeUNB into a single service.

v EDIFACT Deenveloping serviceremoves the envelopes frominbound messages.

Configure the EDIFACTservices in the Sterling B2BIntegrator Graphic ProcessModeler (GPM).Note: As a way to helpreduce the number ofenvelopes you need to createand use, the EDI Envelopingand EDI Deenvelope servicessupport use of an asterisk (*)as a wildcard character inmandatory envelope fields forEDIFACT. By usingwildcards, you can set up oneset of envelopes that can beused for multiple tradingpartners. If certain tradingpartners have specificrequirements, you can stillhave envelopes that pertainjust to them, and the EDIEnveloping service choosesthe envelope that is the bestmatch. In other words, theenvelope that has the mostmatches to specific fields inthe data (for exampleReceiver ID, Receiver IDQualifier), is the one selected.

Envelopes v Inbound EDIFACT envelopewizards to implement inboundEDIFACT.

v Outbound EDIFACT envelopewizards to implement outboundEDIFACT.

v Create the appropriateEDIFACT envelopes for theEDIFACT messages you aresending and receiving.

© Copyright IBM Corp. 2000, 2015 1

Page 8: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Functionality DetailsAction You Need to Take toImplement EDIFACT

Predefined businessprocesses

v For inbound data, we recommendthat you use the EDIDeenvelopebusiness process unless you knowthe input data will only containEDIFACT data (in that scenario,you can use theEDIFACTDeenvelopeUnifiedbusiness process directly to gain aperformance benefit). TheEDIDeenvelope business processattempts to determine the standardof each interchange and start theappropriate business process foreach type, and if the data isEDIFACT, it starts theEDIFACTDeenvelopeUnifiedbusiness process.

v For outbound data, theEDIFACTEnvelopeUnified businessprocess applies an EDIFACTenvelope to one or more EDIFACTmessages and then uses theenvelope data to translate andprocess them.

Configure the predefinedbusiness processes asnecessary.

IBM® Sterling B2BIntegrator MapEditor

v Sterling B2B Integrator Map Editorwizard enables you to generate afile layout for you using theEDIFACT message that you select.Included in the EDIFACT map aregroups, segments, compositeelements, and elements that aredefined by EDIFACT.

v Properties dialog boxes that enableyou to define and modify EDI mapcomponents for EDIFACT.

v Autolink function automaticallycreates links between input andoutput fields that have the samename or business name. Thisfunction can be used with any dataformat.

v Additional mapping operations asneeded.

v Download Sterling B2BIntegrator Map Editor.

v Create a map or maps totranslate your EDIFACTmessages.

Correlation Search Search by EDIFACT information. Use the EDI Correlationsearch functionality to searchfor EDIFACT correlationinformation.

Reports Report by EDIFACT standard Use the EDI TranslationDetail report to search fordetails of inbound andoutbound EDIFACT messagesand easily create usefulreports on your inbound andoutbound EDIFACTmessaging.

2 Sterling Standards Library: Using EDIFACT

Page 9: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Prerequisite for Using EDIFACT

The audience using this software should be familiar with the Sterling B2BIntegrator and the EDIFACT standard.

Note: This documentation is not intended to explain the EDIFACT standard.

Use EDIFACT with Sterling B2B IntegratorAbout this task

To use EDIFACT with the Sterling B2B Integrator, you must complete the followingtasks:

Procedure1. Create inbound and outbound EDIFACT envelopes.2. Use the predefined EDIFACT business processes or create your own business

processes.3. Create any necessary code lists and maintain them as needed.4. Create your EDIFACT map or maps, linking your proprietary file format to the

appropriate EDIFACT message format.5. To track EDIFACT messages, use the EDI Correlation Search functionality.6. To report on inbound and outbound EDIFACT message flow, use the EDI

Translation Detail report features.

Chapter 1. Using EDIFACT with the Sterling B2B Integrator 3

Page 10: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

4 Sterling Standards Library: Using EDIFACT

Page 11: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 2. EDIFACT Business Processes

To help you accomplish your business goals, the Sterling B2B Integrator providestwo predefined business processes that are used by Sterling B2B Integrator toimplement EDIFACT processing: EDIFACTEnvelopeUnified andEDIFACTDeenvelopeUnified.

The following lists business goals for the predefined EDIFACT business processes:

EDIFACTDeenvelopeUnifiedExtracts EDI documents from an EDIFACT interchange and processes themusing the corresponding envelope definitions.

EDIFACTEnvelopeUnifiedApplies an EDIFACT envelope to one or more EDIFACT messages andthen uses the envelope data to translate and process them.

EDIFACTDeenvelopeUnified Business ProcessIf you are only processing EDIFACT data, the EDIFACTDeenvelopeUnifiedbusiness process can be called directly. If your input data contains mixed data (thatis, some EDIFACT and some X12), you must use the EDIDeenvelope businessprocess, which will extract each type of data into separate documents and invokethe appropriate business process for each (for example, calling theEDIFACTDeenvelopeUnified business process to process EDIFACT data and callingthe X12DeenvelopeUnified business process to process X12 data).

If exceptions occur during the deenvelope process, the Sterling B2B Integratorgenerates an EDI Compliance Report.

The following scenario shows how the EDIDeenvelope business process candeenvelope EDIFACT documents:1. The File System adapter collects a file from an input collection folder and

invokes the EDIDeenvelope business process.2. The EDI Deenveloping service determines that the file contains an EDIFACT

document and starts the EDIFACTDeenvelopeUnified business process.3. The EDIFACTDeenvelopeUnified business process calls the

EDIFACTDeenvelope service to process the document.

Note: If the EDIFACTDeenvelope service does not find a matching envelopedefinition, the business process stops. Sterling B2B Integrator generates an EDICompliance Report that describes the reason that the EDIFACTDeenvelopeservice could not locate the envelope.

Note: Before using the EDIDeenvelope or EDIFACTDeenvelopeUnified businessprocess, you must create the necessary envelope definitions in the user interface(Trading Partner > Document Envelopes > Envelopes).

EDIFACTEnvelopeUnified Business ProcessThe EDIFACTEnvelopeUnified business process is initiated when it is called byanother business process or the EDI Enveloping service.

© Copyright IBM Corp. 2000, 2015 5

Page 12: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

The EDIFACTEnvelopeUnified business processes performs the following primaryactivities:1. Starting with one or more EDI documents, the EDI Enveloping service applies

envelope properties at the document level to each document.2. The EDIFACT Envelope service takes one or more transaction sets and applies

a functional group envelope.3. The EDIFACT Envelope service takes a functional group and applies the

interchange-level envelope and searches for a matching contract.4. Using the interchange-level envelope data, the service either looks up a contract

or runs a business process.

Before Using the EDIFACTEnvelopeUnified Business ProcessAbout this task

Before you use the EDIFACTEnvelopeUnified business process, complete thefollowing task:

Procedure1. Create inbound envelopes for your EDIFACT messages.2. Create outbound envelopes for your EDIFACT messages.

6 Sterling Standards Library: Using EDIFACT

Page 13: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 3. EDIFACT Enveloping Overview

A document envelope consists of control information that enables organizations toeffectively exchange messages. This information is added in headers and trailers tomessages. Document envelopes are specific to the message protocol used. Creatingdocument envelopes is necessary to use EDIFACT with your trading partners.

During the envelope creation process, you need to assign the envelope name,description, and parameters, such as unique identification numbers (controlnumbers).

Note: Each time a user adds, modifies, or deletes an envelope, the action is loggedto create an audit trail based on the user who performed the event.

Each envelope type has a specific properties page for the envelope and other pagesthat enable you to specify additional requirements for the envelope. Properties forthe following envelopes can be found in this documentation:v EDIFACT Inbound Syntax 4 UNB UNZ Envelope Properties, Interchange Levelv EDIFACT Inbound Syntax 4 UNG UNE Envelope Properties, Group Levelv EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Levelv EDIFACT Outbound Syntax 4 UNB UNZ Envelope Properties, Interchange Levelv EDIFACT Outbound Syntax 4 UNG UNE Envelope Properties, Group Levelv EDIFACT Outbound Syntax 4 UNH UNT Envelope Properties, Transaction Level

Document Lifespan

In previous releases, the document lifespan default was zero so that when theworkflow expired, all associated documents were purged/archived with theworkflow. Now the lifespan for EDIFACT documents awaiting acknowledgement isconfigurable, and the default is 30 days.

Note: You can change the default lifespan by editing the document.lifespanproperty in the enveloping.properties file. The document lifespan of the outbounddocument is automatically reset to zero after the acknowledgement for thedocument is received or if the user manually accepts the acknowledgement.

Envelope StructureSterling B2B Integrator supports the use of many EDI protocols, includingEDIFACT. The EDIFACT protocol has three levels of envelopes:v Interchange (outermost) – Contains an interchange header and trailer, and all the

data sent from one sender to one receiver in the same transmission.v Functional group (middle) – Contains a group header and trailer that surrounds

a group of transaction sets of the same type.v Transaction set (innermost) – Contains the standard message surrounded by a

header and trailer record.

© Copyright IBM Corp. 2000, 2015 7

Page 14: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Base Envelopes

Sterling B2B Integrator uses a concept of a base envelope as a starting point to createa new envelope. The base envelope maintains a link to the new envelope thatinherited its properties. If you modify the base envelope, all related envelopes (thatis, ones that inherited the base envelope properties) change, as well.

Note: If you plan to create many envelopes using base envelopes, it isrecommended that you do not use the base envelopes in production. You maywant to document how your base envelopes are linked to other envelopes.

The default envelope is the version of the document envelope that the Sterling B2BIntegrator uses. You can specify a default envelope only if there are two or moreversions of the same envelope. One version must be selected as the default.

Types of Envelopes

There are many types of envelopes provided in the Sterling B2B Integrator. Eachenvelope is defined by its envelope properties. These predefined enveloping anddeenveloping business processes are available for you to incorporate into your ownbusiness processes. Envelope parameters specify whether the document is inboundor outbound:v Inbound envelopes identify documents that come into the Sterling B2B Integrator

so they can be properly routed. Inbound envelopes also give you the option totranslate documents when you choose to check documents for compliance. Bychoosing to translate documents from within the envelope, you can reducedocument processing time because you do not need to specify a separateTranslation service step in the business process.

v Outbound envelopes identify documents so that they can be sent to and receivedby trading partners.

Using Wildcards in EDI Enveloping and EDI Deenveloping servicesAs a way to help reduce the number of envelopes you need to create and use, theEDI Enveloping and EDI Deenveloping services support use of an asterisk (*) as awildcard character in mandatory envelope fields for the EDIFACT standard. Foroptional fields, the wildcard value is leaving the field blank. With EDI Enveloping,for optional fields, the wildcard value is equivalent to leaving the field blank. Ifcertain trading partners have specific requirements, you can create envelopes thatpertain just to them, and the EDI Enveloping service chooses the envelope that isthe best match. That is, the envelope that has the most matches to specific fields inthe data (for example, Receiver ID and Receiver ID Qualifier), is the one selected.

Wildcards in Deenveloping (Inbound)

The EDI Deenveloping service receives data, parses the headers, and extracts theEDI information from it. The service searches the available envelopes for theclosest match to the EDI data.

When setting up enveloping with wildcards, consider the following:v The Deenveloping service selects the envelope that matches the EDI data most

closely. For example, if an envelope has the same Transaction ID as the incomingdata, and another envelope has wildcards in all mandatory fields, the envelopewith the matching Transaction ID is used.

8 Sterling Standards Library: Using EDIFACT

Page 15: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Sender ID and Receiver ID have priority over other EDI fields. For example, twoenvelopes are found that have a field that matches one EDI field from the data.One envelope matches the value in the Receiver ID field from the data; the othermatches the Transaction ID field. The envelope that has the matching ReceiverID is selected by the service and used for processing.

v If no envelopes are found that have an exact match to fields in the EDI data, andan envelope with wildcards does exist, the envelope with wildcards is used.

v If multiple envelopes have the same matching information (for example, twoenvelopes match the Sender ID and Receiver ID exactly) the service ends withan error.

v The wildcard character is an “all or nothing” parameter. That is, if usingasterisk, you cannot enter other characters in the field with it. For example, youcan not enter Me* to match MeaslesAnimalHaven and Medeira Foods.

Wildcards in Enveloping (Outbound)

For Inbound envelopes, a wildcard value in the envelope matches any value in theinput document, while an empty value in the envelope matches only an emptyvalue in the input document. For Outbound envelopes, a wildcard value isequivalent to an empty value in the envelope. You can override wildcards withspecific EDI values in outbound processing. You must supply the EDI data to thebusiness process and the data must be in the correct format (that is, name/valuepairs).

One option is to use the lightweight JDBC adapter to pull fields in from databasetables. Whatever method you choose to retrieve the fields, the results must begiven to the Correlation service, which places them into process data. Passing thedata to the Correlation service must be the last step in the business process beforerunning the EDI Encoder service. When the EDI Encoding service runs, it uses thesame best-match process detailed in the Inbound section to determine whichenvelope to use. When the EDIFACT envelope service runs, any envelope fieldvalues set in the Correlation service overrides those values defined in the envelopedefinition.

When setting up your outbound processing, consider the following:v If an envelope field contains a wildcard, you must supply a correlation value for

it or the service halts with an error.v You can override wildcard values in an envelope by using the Correlation

service to pass name/value pairs from the primary document to the EDIEncoder service.

v If an envelope contains specific values in the Sender ID, Sender ID Qualifier,Receiver ID, or Receiver ID Qualifier fields (that is, values other than awildcard), the values passed from the Correlation service to the EDI Encoderservice do not overwrite the values in the fields.

v If you are using the same envelope for inbound processing andacknowledgements, supply the Sender ID, Receiver ID, and Qualifiers in theenvelope so that they are not overwritten by the correlation values.

Create an EDIFACT EnvelopeAbout this task

To create a new envelope using the Sterling B2B Integrator:

Chapter 3. EDIFACT Enveloping Overview 9

Page 16: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Procedure1. From the Administration menu, select Trading Partner > Document Envelopes

> Envelopes.2. Under Create, next to New Envelope, click Go!

3. On the Envelope Standards page, select EDIFACT and click Next.4. Select the level of envelope you want to create, including inbound or outbound,

and click Next.5. Do one of the following:

v To create this envelope from a base envelope, select the Base envelope fromthe Select Envelope list, and click Next.

Note: All the properties are pre-filled but you can update them as needed.v To create a new envelope, select the Not Applicable from the Select Envelope

list, and click Next.6. On the Name page, type a unique name for the envelope, and a description or

comments, then click Next.7. Complete the properties for the envelope as necessary and click Next after each

page until you reach the confirm page. Required fields are highlighted in blue.8. Click Finish to add the envelope.9. Click Return to continue.

Update an EDIFACT EnvelopeAbout this task

Sterling B2B Integrator enables you to modify any information in your envelopes,except the name of the envelope.

To update envelope properties:

Procedure1. From the Administration menu, select Trading Partner > Document Envelopes

> Envelopes.2. Find the envelope using the Search or List function.3. From the list of envelopes, click source manager next to the envelope you want

to update.4. Click edit next to the envelope you want to update.5. Update envelope properties and settings as necessary, clicking Next to continue.6. Click Finish to update the envelope.7. Click Return to continue.

Delete an EDIFACT EnvelopeAbout this task

Note: Before deleting a base envelope, consider the impact on all related envelopes(envelopes that inherited the base envelope properties).

To delete an individual envelope or all versions of an envelope:

10 Sterling Standards Library: Using EDIFACT

Page 17: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Procedure1. From the Administration menu, select Trading Partner > Document Envelopes

> Envelopes.2. Find the envelope using the Search or List function.3. Next to the envelope you want to delete, click source manager.4. In Envelope Source Manager page, do one of the following:

To delete an individual envelope:v Next to the version, under Delete, select the check box.v Next to Delete Selected Versions, click Go!.

To delete all versions of this envelope, next to Delete All Versions, click Go!.

Chapter 3. EDIFACT Enveloping Overview 11

Page 18: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

12 Sterling Standards Library: Using EDIFACT

Page 19: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 4. EDIFACT Inbound Syntax 4 UNB UNZ EnvelopeProperties, Interchange Level

Note: An (*) asterisk indicates that a wildcard value can be used with thatparameter (for mandatory fields, the wildcard value is an (*) asterisk). For Inboundenvelopes, a wildcard value in the envelope matches any value in the inputdocument, while an empty value in the envelope matches only an empty value inthe input document. For Outbound envelopes, a wildcard value is equivalent to anempty value in the envelope.

The following table describes EDIFACT inbound Syntax 4 UNB UNZ envelopeproperties at the interchange level:

Field Description

* Sender IDInterchange ID as it should appear on the interchange header segment sentto this company or division. Valid value is 12 standard characters.Required.

* Sender OrganizationThe sender organization. Optional for envelopes managed by Sterling B2BIntegrator.

* Identification Code Qualifier (Sender ID)Coded qualifier of the sender ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is fourstandard characters. Optional.

* Interchange Sender Internal IdentificationInternal interchange ID as it should appear on the interchange headersegment sent to this company or division. Valid value is 12 standardcharacters. Optional.

* Interchange Sender Internal Sub-identificationSub-interchange ID as it should appear on the interchange header segmentsent to this company or division. Valid value is 12 standard characters.Optional.

* Recipient IDInterchange ID as it should appear on the interchange header segmentreceived from this company or division. Valid value is 12 standardcharacters. Required.

* Receiver OrganizationThe receiver organization. Optional for envelopes managed by Sterling B2BIntegrator.

* Identification Code Qualifier (Recipient ID)Coded qualifier of the recipient ID as it should appear on the interchangeheader segment received from this company or division. Valid value is fourstandard characters. Optional.

* Interchange Recipient Internal IdentificationInternal interchange ID as it should appear on the interchange headersegment received from this company or division. Valid value is 12 standardcharacters. Optional.

© Copyright IBM Corp. 2000, 2015 13

Page 20: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

* Interchange Recipient Internal Sub-identificationSub-interchange ID as it should appear on the interchange header segmentreceived from this company or division. Valid value is 12 standardcharacters. Optional.

* Test IndicatorMode of operation to use for this envelope. Required. Valid values are:v None (default)v Testv Syntax Only Testv Echo Requestv Echo Responsev Any Indicator (wildcard)

Use global control numberWhether this envelope definition must use a global control number touniquely identify transactions. No indicates that the envelope definitionmust use its local global control number. Required. Valid values are:v Yes (default)v Yes (and generate name from data)v No

* Global Group Reference NumberThe global group reference number. This parameter is displayed only whenUse global control number is set to Yes. The value entered here is thename of the global control number file. Required.

* Local Group Reference NumberThe local group reference number. This parameter is displayed only whenUse global control number is set to No. The value entered here is numericfrom one to fourteen digits. Required.

Perform Control Number Sequence CheckingPerforms an incremental sequence check. Required. Valid values are Yesand No (default).

Perform Duplicate Control Number CheckingDetermine control number duplications. Required. Valid values are Yes andNo (default).

Note: If this value is set to Yes and the Maximum age of Control NumberHistory Records in days parameter is not given a value, entries arecreated in the TRANSACT_REGISTER table with a null value for theARCHIVE_DATE. These entries are not purged automatically.

If sequence or duplicate checking, EDI Post Processor shouldHow the EDI Post Processor service should perform sequence andduplicate checking. When multiple interchanges for the same tradingpartner are processed in parallel, subprocesses for transactions will alwaysbe a direct child to the process that did the deenveloping. If theinterchange is out of sequence, the post processor re-runs until the time-outis reached. Required.

Valid values:v Process all interchanges in the EDI Sequence Check Queue

(recommended and the default)v Process only the current interchange

14 Sterling Standards Library: Using EDIFACT

Page 21: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Maximum age of Control Number History Records in daysMaximum days to retain a history of control numbers to use forduplication determinations. Valid value is nine standard characters.Optional.

Retain Enclosing EnvelopeWhether to copy the envelope segments (UNB and UNZ) into each groupor message extracted from the interchange. Required. Valid values are Yesand No (default).

Business Process for Non-Compliant DocumentsBusiness process to be used when non-compliant documents areencountered. Required.

Use WTX Compliance CheckingWhether to use WTX compliance checking. Valid values are Yes and No(default). This parameter is only displayed if WTX is installed andintegrated to Sterling B2B Integrator.

Note: Select Yes for this option only if you are using the WebSphere®

Transformation Extender for Sterling B2B Integrator and want to use WTXcompliance checking.

Primary Name FormatInformation to include when generating a name for a global number andfinding the correct number to assign based on that name. Optional.Information options include:v Test Indicator

* Global Interchange Control ReferenceInterchange control reference number used globally. Select a previouslydefined number to reference. Valid value is nine standard characters.Required.

Handling of non-compliant InterchangesProcess to follow when non-compliant interchanges are encountered.Required. Valid values:v Acceptv Reject (default)

Generate an acknowledgementGenerate an acknowledgement that notifies the sender that the receiver hasreceived either a non-compliant interchange or an interpretable interchangetransmission. Required. Valid values are Yes (default) and No.

Acknowledgement Detail LevelLevel of detail to which acknowledgements are sent. If you select Segmentlevel, the segment and message levels are acknowledged. Optional.

Valid values are:v Interchange Levelv Group Levelv Message Levelv Segment Levelv Data Element Level (default)

Send acknowledgement immediatelySend specified level of acknowledgement immediately after interchangetransmission occurs. Valid values are Yes and No (default). Required.

Chapter 4. EDIFACT Inbound Syntax 4 UNB UNZ Envelope Properties, Interchange Level 15

Page 22: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Acceptor Lookup Alias format for generated CONTRLsThe format of accepter lookup alias for generated CONTRL messages.Optional. Valid values are:v CONTRL (default)v CONTRL_[syntax version]v CONTRL_[test_indicator]v CONTRL_[syntax version]_[test_indicator]v [message type (first one if multiple)]

* Local Interchange Control ReferenceInterchange control reference number used locally. Select a previouslydefined number to reference. Valid value is nine standard characters.Required.

Write S002 and S003 subelementsWhether to write the S002 (Interchange Sender) and S003 (InterchangeReceiver) subelements. Valid values are Yes and No (default). Required.

Syntax 1,2,3 Action Response (UCI 0083)This parameter is valid if you are using EDIFACT Syntax 3 or lower, andUNB 0031 is set to one (or Generate Acknowledgements is selected).Allows you to send receipt for UCI 0083. Optional. Valid values are:v Acknowledged or Rejected (compliance based) (default)v Received

16 Sterling Standards Library: Using EDIFACT

Page 23: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 5. EDIFACT Inbound Syntax 4 UNG UNE EnvelopeProperties, Group Level

Note: An (*) asterisk indicates that a wildcard value can be used with thatparameter (for mandatory fields, the wildcard value is an (*) asterisk). For Inboundenvelopes, a wildcard value in the envelope matches any value in the inputdocument, while an empty value in the envelope matches only an empty value inthe input document. For Outbound envelopes, a wildcard value is equivalent to anempty value in the envelope.

The following table describes EDIFACT inbound Syntax 4 UNG UNE envelopeproperties at the group level:

Field Description

* Sender IDInterchange ID as it should appear on the message group header sent tothis company or division. Valid value is 12 standard characters. Required.

* Sender OrganizationThe sender organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Sender ID)Coded qualifier of the sender ID as it should appear on the message groupheader sent to this company or division. Valid value is four standardcharacters. Optional.

* Recipient IDInterchange ID as it should appear on the message group header receivedfrom this company or division. Valid value is 12 standard characters.Required.

* Receiver OrganizationThe receiver organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Recipient ID)Coded qualifier of the recipient ID as it should appear on the messagegroup header received from this company or division. Valid value is fourstandard characters. Optional.

Use global control numberWhether this envelope definition must use a global control number touniquely identify message group headers. No indicates that the envelopedefinition must use its own global control number. Required. Valid valuesare:v Yes (default)v Yes (and generate name from data)v No

Perform Control Number Sequence CheckingCompare the sequence of control numbers in the data with the ControlNumber parameter for this envelope. Required. Valid values are Yes andNo (default).

© Copyright IBM Corp. 2000, 2015 17

Page 24: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Perform Duplicate Control Number CheckingDetermine control number duplications. Required. Valid values are Yes andNo (default).

Note: If this value is set to Yes and the Maximum age of Control NumberHistory Records in days parameter is not given a value, entries arecreated in the TRANSACT_REGISTER table with a null value for theARCHIVE_DATE. These entries are not purged automatically.

Maximum age of Control Number History Records in daysMaximum days to retain a history of control numbers to use forduplication determinations. Valid value is nine standard characters.Optional.

Retain Enclosing EnvelopeCopy the envelope segments (UNB and UNZ) into each message extractedfrom the message group header. Required. Valid values are Yes and No.

Primary Name FormatInformation to include when generating a name for a global number andfinding the correct number to assign based on that name. Optional.Information includes:v Message Typev Message Version and Release Numberv Test Indicator

Check each that you want to use in the format.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatCheck boxes to indicate what information to include when generating aname for a global number and finding the correct number to assign basedon that name. Optional. Information includes:v Message typev Message version and release numberv Test Indicator

Check each that you want to use in the format.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatCheck boxes to indicate what information to include when generating aname for a global number and finding the correct number to assign basedon that name. Optional. Information includes:v Message typev Message version and release numberv Test Indicator

Check each that you want to use in the format.

Handling of Non-Compliant GroupsProcess to follow when non-compliant message group headers areencountered. Required. Valid values are:

18 Sterling Standards Library: Using EDIFACT

Page 25: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Acceptv Reject (default)

Business Process for Non-Compliant DocumentsBusiness process to be used when non-compliant documents areencountered. Required.

Use SecurityTurns on AUTACK security for the group. The AUTACK inboundtransaction envelope will store the certificate reference or the way thecertificate can be generated from the data used in validating the digitalsignature for the group.

Use previously checked in trusted certificates to verify a secured documenttransmission. Valid values are Yes and No (default). Required.

Note: This option must be set to Yes when using secure AUTACKmessages in EDIFACT.

This is the AUTACK Group EnvelopeSpecify whether this envelope is the AUTACK group envelope. Validvalues are Yes and No (default). Required.

Note: Only displayed if Use Security is set to Yes.

Chapter 5. EDIFACT Inbound Syntax 4 UNG UNE Envelope Properties, Group Level 19

Page 26: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

20 Sterling Standards Library: Using EDIFACT

Page 27: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT EnvelopeProperties, Transaction Level

Note: An (*) asterisk indicates that a wildcard value can be used with thatparameter (for mandatory fields, the wildcard value is an (*) asterisk). For Inboundenvelopes, a wildcard value in the envelope matches any value in the inputdocument, while an empty value in the envelope matches only an empty value inthe input document. For Outbound envelopes, a wildcard value is equivalent to anempty value in the envelope.

The following table describes EDIFACT inbound Syntax 4 UNH UNT envelopeproperties at the transaction level:

Field Description

* Sender ID (from group or interchange)Interchange ID as it should appear on the transaction sent to this companyor division. Valid value is 12 standard characters. Required.

* Sender OrganizationThe sender organization. Optional for envelopes managed by Sterling B2BIntegrator.

Identification Code Qualifier (from group or interchange)Coded qualifier of the sender ID as it should appear on the from group orinterchange header segment sent to this company or division. Valid valueis four standard characters. Optional.

* Recipient ID (from group or interchange)Interchange ID as it should appear on the transaction received from thiscompany or division. Valid value is 12 standard characters. Required.

* Receiver OrganizationThe receiver organization. Optional for envelopes managed by Sterling B2BIntegrator.

Identification Code Qualifier (from group or interchange)Coded qualifier of the recipient ID as it should appear on the from groupor interchange header segment sent to this company or division. Validvalue is four standard characters. Optional.

* Message TypeTransaction message type as determined by the information type in theheader of the message group, which includes the message or by theinformation type in the transaction message. Valid value is six standardcharacters. Required.

If using AUTACK, create a separate AUTACK inbound transactionenvelope with a message type of AUTACK so you can configure thetrusted certificate you want to use when validating the digital signature.

* Message Version NumberVersion number of the standard message. Valid value is three standardcharacters. Required.

* Message Release Number (Required for EDIFACT, optional for ODETTE)Release number of the standard message. Valid value is three standardcharacters. Required for EDIFACT. Optional for ODETTE.

© Copyright IBM Corp. 2000, 2015 21

Page 28: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

* Controlling Agency, CodedAgency controlling the code representing the name of the sending EDIservice provider and relaying the message group on the sending side. Validvalue is alphanumeric code with three standard characters. Optional.

* Association Assigned CodeAssigned associated code for the agency controlling the name of thesending EDI service provider and relaying the message group on thesending side. Valid value is alphanumeric code with six standardcharacters. Optional.

* Message Type Sub-Function IdentificationCoded identifier of a sub-function of a message type. Valid value is sixstandard characters. Optional.

Use global control numberWhether this envelope definition must use a global control number touniquely identify transactions. No indicates that the envelope definitionmust use its own global control number. Required. Valid values are:v Yesv Yes (and generate name from data)v No

Test IndicatorOperation mode to use for this envelope. Required. Valid values are:v None (default)v Testv Syntax Only Testv Echo Requestv Echo Responsev Any Indicator (wildcard)

Perform Control Number Sequence CheckingCompare the sequence of control numbers in the data with the ControlNumber parameter for this envelope. Required. Valid values are Yes andNo (default).

Perform Duplicate Control Number CheckingDetermine control number duplications. Required. Valid values are Yes andNo (default).

Note: If this value is set to Yes and the Maximum age of Control NumberHistory Records in days parameter is not given a value, entries arecreated in the TRANSACT_REGISTER table with a null value for theARCHIVE_DATE. These entries are not purged automatically.

Maximum age of Control Number History Records in daysMaximum days to retain a history of control numbers to use forduplication determinations. Valid value is nine standard characters.Optional.

Retain Enclosing EnvelopeCopy the envelope segments (UNB and UNZ) into each message extractedfrom the transaction. Required. Valid values are Yes and No (default).

Batch transactions received within a functional group into one output documentWhether to group all similar transactions from a functional group into oneoutput document. For example, all invoices would be put into one

22 Sterling Standards Library: Using EDIFACT

Page 29: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

document. Valid values are Yes (default) and No. The default is to outputeach transaction to a separate document. Required.

Primary Name FormatCheck boxes to instruct what information to include when generating aname for a primary global control number and finding the correct numberto assign based on that name. Optional.

Select from:v Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated global control number (Use globalcontrol number is set to Yes (and generate name from data)), Sterling B2BIntegrator tries to generate and match the following control numbers:v First, it tries to generate and match the control number in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing control number that matches the names

generated in steps 1-3, a control number with the name assigned in thefirst step is created.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatThe first backup name format to use when generating a global controlnumber. The system allows for two alternatives if the Primary NameFormat is not found, checking for the First Backup Name Format and then,if that is not found, checking for the Second Backup Name Format.Optional.

Select from:v Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated global control number (Use globalcontrol number is set to Yes (and generate name from data)), the SterlingB2B Integrator tries to generate and match the following control numbers:v First, it tries to generate and match the control number in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing control number that matches the names

generated in steps 1-3, a control number with the name assigned in thefirst step is created.

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 23

Page 30: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatThe second backup name format to use when generating a global controlnumber. The system allows for two alternatives if the Primary NameFormat is not found—checking for the First Backup Name Format andthen, if that is not found, checking for the Second Backup Name Format.Optional.

Select from:v Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated global control number (Use globalcontrol number is set to Yes (and generate name from data)), Sterling B2BIntegrator tries to generate and match the following control numbers:v First, it tries to generate and match the control number in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing control number that matches the names

generated in steps 1-3, a control number with the name assigned in thefirst step is created.

Global Message Reference NumberTransaction group control reference number used globally. Select apreviously defined number to reference. Valid value is nine standardcharacters. Required.

Handling of non-compliant MessagesProcess to follow when non-compliant transactions are encountered.Required.

Valid values are:v Accept compliant and non-compliant transactionsv Accept compliant transactions, reject non-compliant transactions (default)

Compliance Check DocumentCheck the transaction set body for compliance. Valid values are Yes(default) and No. Required.

Note: This only applies to data compliance, not to security/certificatecompliance.

Map Name ModeHow to determine which map to use to perform a compliance check.Required. Valid values are:v Specify (default)v Generate from data (this is useful if you want to share across envelopes)

Note: If you select this option, you must select at least one parameter forPrimary Name Format.

24 Sterling Standards Library: Using EDIFACT

Page 31: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Map NameWhich map to use to perform a compliance check (if Compliance Checkdocument is set to Yes and Map Name Mode set to Specify). The mapmust already be checked in to Sterling B2B Integrator. Optional.

Note: If you are using the WebSphere Transformation Extender for SterlingB2B Integrator and want to do compliance checking, you must select yourcompliance check map.

Primary Name FormatCheck boxes to instruct what information to include when generating andmatching a name for the map. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated map name (Map Name Mode is set toGenerate from data), the Sterling B2B Integrator tries to generate andmatch the following maps:v First, it tries to generate and match the map in the primary name format

(replacing the values that are selected for the corresponding value in themessage).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing map that matches the names generated

in steps 1-3, an error is generated.

Only occurs if Generate an error if no generated map name exists in thesystem is set to Yes.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatThe first backup name format to use when generating a map name. Thesystem allows for two alternatives if the Primary Name Format is notfound—checking for the First Backup Name Format and then, if that is notfound, checking for the Second Backup Name Format. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv Message Type

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 25

Page 32: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Message Version and Release Numberv Test Indicator

Note: If you are using a generated map name (Map Name Mode is set toGenerate from data), Sterling B2B Integrator tries to generate and matchthe following maps:v First, it tries to generate and match the map in the primary name format

(replacing the values that are selected for the corresponding value in themessage).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing map that matches the names generated

in steps 1-3, an error is generated.

Only occurs if Generate an error if no generated map name exists in thesystem is set to Yes.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatThe second backup name format to use when generating a map name. Thesystem allows for two alternatives if the Primary Name Format is notfound—checking for the First Backup Name Format and then, if that is notfound, checking for the Second Backup Name Format. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated map name (Map Name Mode is set toGenerate from data), the Sterling B2B Integrator tries to generate andmatch the following maps:v First, it tries to generate and match the map in the primary name format

(replacing the values that are selected for the corresponding value in themessage).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing map that matches the names generated

in steps 1-3, an error is generated.

Only occurs if Generate an error if no generated map name exists in thesystem is set to Yes.

Generate an error if no generated map name exists in the systemSpecifies whether to generate an error if the Map Name selected is notfound. Valid values are Yes (default) and No.

26 Sterling Standards Library: Using EDIFACT

Page 33: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Note: Only displayed if Map Name Mode is set to Generate from data.

Translate transactionsGenerate transactions according to the standard format from data groupsin an EDI system and carry out reverse processing. By choosing totranslate documents from within the envelope, you can reduce documentprocessing time because you do not need to specify a separate Translationservice step in the business process. Valid values are Yes and No (default).

Validate translation outputValidate translated output (that is, documents sent to trading partners).Valid values are Yes (default) and No. Required.

Determine the Business Process bySelect a business process that should run with messages as the primarydocument. Optional.

Valid values are:v Looking up contract dynamicallyv Specifying a contractv Specifying a business processv Generating the business process name from the data

For each documentAs specified in the Determine the Business Process. Required. Valid valuesare:v Invoke the business processv Set the business process name in the process data

Primary Name FormatCheck boxes to instruct what information to include when generating andmatching a name for the business process. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (Determine theBusiness Process By is set to Generating the business process name fromthe data), Sterling B2B Integrator tries to generate and match the followingbusiness process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the first Backup Name.v Third, it tries to generate and match the second Backup Name.v Fourth, if there is not an existing business process that matches the

names generated in steps 1-3, an error is generated.

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 27

Page 34: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatThe first backup name format to use when generating a business processname. The system allows for two alternatives if the Primary Name Formatis not found—checking for the First Backup Name Format and then, if thatis not found, checking for the Second Backup Name Format. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (DetermineBusiness Process Name By is set to Generating a Business Process namefrom the data), the Sterling B2B Integrator tries to generate and match thefollowing business process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing business process that matches the

names generated in steps 1-3, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatThe second backup name format to use when generating a businessprocess name. The system allows for two alternatives if the Primary NameFormat is not found—checking for the First Backup Name Format andthen, if that is not found, checking for the Second Backup Name Format.Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient ID

28 Sterling Standards Library: Using EDIFACT

Page 35: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (DetermineError Business Process Name By is set to Generating a Business Processname from the data), Sterling B2B Integrator tries to generate and matchthe following business process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, if there is not an existing business process that matches the

names generated in steps 1-3, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Generate an error if no generated business process name exists in the systemSpecify whether to generate an error if there is no match to the generatedbusiness process name in the system. Valid values are Yes (default) andNo.

Note: Only displayed if Determine the Business Process By is set toGenerating the business process name from the data.

Contract ListSelect a previously created contract to associate with this envelope.

Business Process ListSelect a previously created business process to associate with this envelopeOptional.

Displayed only if Determine the Business Process Name is set toSpecifying the business process.

Extraction OptionsBusiness process data extraction. Required.

Valid values:v Determined by business process (default)v Extract to a file system directoryv Extract to a mailbox

Data Extraction DirectoryDirectory for data extraction. Optional.

Data Extraction FilenameFilename for data extraction. Optional.

Data Extraction MailboxMailbox for data extraction. Required.

Data Extraction Mailbox Message NameMailbox message name for data extraction. Optional.

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 29

Page 36: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Error Business Process ModeHow to determine the business process name to use if there were errors inthe compliance check. Required. Valid values are:v Specifying a Business Process name (default)v Generating a Business Process name from the data (this is useful if you

want to share across envelopes)

Note: If you select this option, you must select at least one parameter forPrimary Name Format. The generated name will end with FIN.

Primary Name FormatCheck boxes to instruct what information to include when generating andmatching a name for the error business process name. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated error business process name (ErrorBusiness Process Mode is set to Generate from data), Sterling B2BIntegrator tries to generate and match the following business process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatThe first backup name format to use when generating an error businessprocess name. The system allows for three alternatives if the PrimaryName Format is not found—checking for the First Backup Name Formatand then, if that is not found, checking for the Second Backup NameFormat, and then, if that is not found, checking for the Third BackupName Format. Optional.

Select from:v EDI Standardv Sender ID Code Qualifier

30 Sterling Standards Library: Using EDIFACT

Page 37: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated error business process name (ErrorBusiness Process Mode is set to Generate from data), Sterling B2BIntegrator tries to generate and match the following business process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatThe second backup name format to use when generating an error businessprocess name. The system allows for three alternatives if the PrimaryName Format is not found—checking for the First Backup Name Formatand then, if that is not found, checking for the Second Backup NameFormat, and then, if that is not found, checking for the Third BackupName Format. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated error business process name (ErrorBusiness Process Mode is set to Generate from data), Sterling B2BIntegrator tries to generate and match the following business process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 31

Page 38: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use third backup name formatWhether to use the third backup name format (specified below). Thedefault is selected (use the third backup name format).

Backup Name FormatThe third backup name format to use when generating an error businessprocess name. The system allows for three alternatives if the PrimaryName Format is not found—checking for the First Backup Name Formatand then, if that is not found, checking for the Second Backup NameFormat, and then, if that is not found, checking for the Third BackupName Format. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated error business process name (ErrorBusiness Process Mode is set to Generate from data), Sterling B2BIntegrator tries to generate and match the following business process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Generate an error if no generated business process name exists in the systemSpecify whether to generate an error if there is no match to the generatedbusiness process name in the system. Valid values are Yes (default) andNo.

Note: Only displayed if Error Business Process Mode is set to Generatefrom data.

Business Process ListSelect a previously created business process to associate with this envelope.Optional.

32 Sterling Standards Library: Using EDIFACT

Page 39: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Displayed only if Determine Error Business Process Name By is set toSpecifying the business process.

Use SecurityUse previously checked in trusted certificates to verify a secured documenttransmission. Valid values are Yes and No (default). Required.

Note: This option must be set to Yes when using secure AUTACKmessages in EDIFACT.

Scope of Security ApplicationUsed for AUTACK security only. Security header and message bodyreferenced in the digital certificate. Required. Valid values are:v 1 - Security header and message body. Use this option if you want the

AUTACK embedded in the transaction that it is securing.v 3 - Whole related message, package, group, or interchange. Use this

option if you want the AUTACK to reference the data transaction or thegroup it is securing. When selecting this option, you have two optionsfor certificate parameters:- Use a certificate in USC segment or generate a certificate name- Use a specified certificate only

Security CertificateSelect a previously checked in system certificate to associate with thisenvelope. Required.

Chapter 6. EDIFACT Inbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 33

Page 40: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

34 Sterling Standards Library: Using EDIFACT

Page 41: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 7. EDIFACT Outbound Syntax 4 UNB UNZ EnvelopeProperties, Interchange Level

Note: An (*) asterisk indicates that a wildcard value can be used with thatparameter (for mandatory fields, the wildcard value is an (*) asterisk). For Inboundenvelopes, a wildcard value in the envelope matches any value in the inputdocument, while an empty value in the envelope matches only an empty value inthe input document. For Outbound envelopes, a wildcard value is equivalent to anempty value in the envelope.

The following table describes EDIFACT outbound Syntax 4 UNB UNZ envelopeproperties at the interchange level:

Field Description

* Syntax IdentifierCoded identifier of syntax rules. Valid value is four standard characters.Required.

* Syntax Version NumberVersion number of syntax rules. Typically, this value is 1. Valid value is onestandard characters. Required.

* Service Code List Directory Version NumberVersion number of the service code list directory. Optional.

* Character Encoding, CodedCoded character encoding used in the interchange. Optional.

* Sender IDCoded identifier of the company or division sending the interchange. Validvalue is 12 standard characters. Required.

* Sender OrganizationThe sender organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Sender ID)Coded qualifier of the sender ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is fourstandard characters. Optional.

* Interchange Sender Internal IdentificationInternal interchange ID as it should appear on the interchange headersegment sent to this company or division. Valid value is 12 standardcharacters. Optional.

* Interchange Sender Internal Sub-identificationInternal interchange sub ID as it should appear on the interchange headersegment sent to this company or division. Valid value is 12 standardcharacters. Optional.

* Recipient IDCoded identifier of the company or division receiving the interchange.Valid value is 12 standard characters. Required.

* Receiver OrganizationThe receiver organization. Optional for envelopes managed by the SterlingB2B Integrator.

© Copyright IBM Corp. 2000, 2015 35

Page 42: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

* Identification Code Qualifier (Recipient ID)Coded qualifier of the recipient ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is threestandard characters. Optional.

* Interchange Recipient Internal IdentificationInternal interchange ID as it should appear on the interchange headersegment received from a company or division. Valid value is 12 standardcharacters. Optional.

* Interchange Recipient Internal Sub-identificationInternal interchange sub ID as it should appear on the interchange headersegment received from a company or division. Valid value is 12 standardcharacters. Optional.

Use Correlation OverridesWhether to use correlation overrides. Required. Valid values are:v Always - If a correlation override value is provided, always use that

value instead of the value in the envelope (except for the Sender ID,Receiver ID, and Sender/Receiver Qualifier fields, which must have a *in the envelope definition to use the correlation override value).

v Only when the envelope field has a wildcard value (*) - Only usecorrelation override values for fields in the envelope definition that arespecified with a wildcard (*).

v Never - Never use correlation overrides.v Use the default specified in enveloping.properties - The

enveloping.properties file defines when to use correlation overrides ifthis choice is selected. The properties file will either define Always,Never, or Only when the envelope field has a wildcard (*) value. Theapplicable properties file property isenveloping.correl_override_default.[standard]. Allowed values are No(which means never), WildcardOnly, or All (which means always, exceptfor the Sender ID, Receiver ID, and Sender/Receiver Qualifier fields,which must have a * in the envelope definition to use the correlationoverride value).

Use global control numberWhether this envelope definition must use a global control number touniquely identify transactions. No indicates that the envelope definitionmust use its own global control number. Optional. Valid values are:v Yes (default)v Yes (and generate name from data)v No

* Recipient Reference/PasswordReference or password as agreed between the communicating tradingpartners. Optional.

* Recipient Reference/Password QualifierCoded qualifier and password of the receiver as it should appear on themessage group header sent to this company or division. Valid value is fourstandard characters. Optional.

* Application ReferenceReference identifier of the application used by the sender. Valid value is 15standard characters. Optional.

36 Sterling Standards Library: Using EDIFACT

Page 43: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

* Processing Priority CodeCode determined by the sender requesting processing priority for theinterchange. Optional.

* Acknowledgement RequestRequest an acknowledgement that notifies the sender that the receiver hasreceived an interpretable interchange transmission. Optional.

* Acknowledgement overdue after (hours)Amount of time, in hours, within which you must receive anacknowledgement. Valid value is four numeric characters. Optional.

* Acknowledgement overdue after (minutes)Amount of time, in minutes, within which you must receive anacknowledgement. Valid value is four numeric characters. Optional.

* Interchange Agreement IdentifierIdentification by name or code of the type of agreement under which theinterchange takes place. Optional.

* Test IndicatorThe structural level in the envelope containing the test indicator is a test.Optional.

* Global Interchange Control ReferenceInterchange control reference number used globally. Select a previouslydefined number to reference. Valid value is nine standard characters.Required.

* Local Interchange Control ReferenceInterchange control reference number used locally. Select a previouslydefined number to reference. Valid value is nine standard characters.Required. Default is 1.

Primary Name FormatInformation to include when generating a name for a primary globalnumber and finding the correct number to assign based on that name.Information includes:v Test Indicator

Check the appropriate information to use in the format. Optional.

Maximum number of documents per interchangeMaximum number of documents per interchange. Optional.

Limit Interchange SizeMaximum size allowed for an interchange before a single interchange issplit into multiple interchanges that are each under the maximum sizelimitation.

Valid values are:v Nov Use smallest transaction limit (default)

Note: The Use smallest transaction limit setting is specific to thelimitation imposed by the standard.v Specify size limitv Use global default in enveloping.properties

Required.

Chapter 7. EDIFACT Outbound Syntax 4 UNB UNZ Envelope Properties, Interchange Level 37

Page 44: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Note: If you select Use transaction set default in enveloping.properties,you need to specify the size limit directly (in the Maximum InterchangeSize parameter) or by setting properties in the enveloping.propertiesproperty file, which contains a property for each supported standard andmore specific properties for each message type (for example, INVOIC forthe EDIFACT standard) that can override the standard property.

Invoke Business Process for Each InterchangeWhether a business process is invoked for each interchange generated.Valid values are Yes and No (default). Required.

Note: If Invoke Business Process for Each Interchange is set to No, theservice places the name of the business process specified in the envelopeinto process data using the key WFD_NAME. This business process is theninvoked by the Invoke Business Process Service. If Invoke BusinessProcess For Each Interchange is set to Yes, the service directly bootstrapsan instance of the business process specified in the envelope, and does notset WFD_NAME in process data.

Maximum Interchange Size (bytes)Specify the maximum size of each individual interchange. Required.

Note: Only displayed if you selected Specify size limit for the LimitInterchange Size parameter. If you choose to specify a maximum value,the value you specify is checked to make sure it is at least 173 bytes basedon the header and trailer size for EDIFACT standard.

Note: For performance reasons, the size is estimated for some componentsof the interchange (for example, control numbers) when determining thesize. For this reason, the actual enforced size limit is slightly smaller thanthe value you specify.

Specify Non-Standard delimitersDelimiters other than the default delimiters. Valid values are Yes and No(default). Required.

UNA SegmentsIncorporate UNA segments in this envelope. Valid values are Yes and No(default). Required.

Stream SegmentsInsert an end-of-line character after each segment record. Valid values areYes and No (default). Required.

Data Element SeparatorEDI delimiter to use to separate elements. Optional.

Segment TerminatorEDI delimiter to use to indicate the end of segments. Optional.

Component Element SeparatorEDI delimiter used to separate components. Optional.

Release CharacterCharacter to use to release an EDI delimiter. Optional.

Repetition SeparatorCharacter to use to separate a group of repeated elements. Optional.

Decimal SeparatorCharacter to use to identify different multi details. Optional.

38 Sterling Standards Library: Using EDIFACT

Page 45: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Encode DocumentWhether to specify character encoding for the document. Required. Validvalues are Yes and No (default).

EncodingType of character encoding for the message group that includes thisheader. This field is used with the Encoding field. Valid value is sixstandard characters. Required only if Encode Document is set to Yes.

Determine the Business Process bySelect a business process that should run with extracted EDIFACToutbound Syntax 4 UNB/UNZ messages as the primary document.Required.

Valid values:v Looking up contract dynamicallyv Specifying a contractv Specifying a business processv Generating the business process name from the data

Business Process ListSelect a business process to run when this envelope is processed. Optional.

Contract ListSelect a previously created contract to associate with this envelope.Optional.

Primary Name FormatCheck boxes to instruct what information to include when generating andmatching a name for the business process name. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (Determine thebusiness process by is set to Generating the business process name fromdata), the Sterling B2B Integrator tries to generate and match the followingbusiness process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Chapter 7. EDIFACT Outbound Syntax 4 UNB UNZ Envelope Properties, Interchange Level 39

Page 46: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatThe first backup name format to use when generating a business processname. The system allows for three alternatives if the Primary NameFormat is not found—checking for the First Backup Name Format andthen, if that is not found, checking for the Second Backup Name Format,and then, if that is not found, checking for the Third Backup NameFormat. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (Determine thebusiness process by is set to Generating the business process name fromdata), the Sterling B2B Integrator tries to generate and match the followingbusiness process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatThe second backup name format to use when generating a businessprocess name. The system allows for three alternatives if the PrimaryName Format is not found—checking for the First Backup Name Formatand then, if that is not found, checking for the Second Backup NameFormat, and then, if that is not found, checking for the Third BackupName Format. Optional.

Select from:v EDI Standard

40 Sterling Standards Library: Using EDIFACT

Page 47: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (Determine thebusiness process by is set to Generating the business process name fromdata), the Sterling B2B Integrator tries to generate and match the followingbusiness process:v First, it tries to generate and match the business process in the primary

name format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Use third backup name formatWhether to use the third backup name format (specified below). Thedefault is selected (use the third backup name format).

Backup Name FormatThe third backup name format to use when generating a business processname. The system allows for three alternatives if the Primary NameFormat is not found—checking for the First Backup Name Format andthen, if that is not found, checking for the Second Backup Name Format,and then, if that is not found, checking for the Third Backup NameFormat. Optional.

Select from:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv (0065) Message Typev Message Version and Release Numberv Test Indicator

Note: If you are using a generated business process name (Determine thebusiness process by is set to Generating the business process name fromdata), the Sterling B2B Integrator tries to generate and match the followingbusiness process:

Chapter 7. EDIFACT Outbound Syntax 4 UNB UNZ Envelope Properties, Interchange Level 41

Page 48: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v First, it tries to generate and match the business process in the primaryname format (replacing the values that are selected for thecorresponding value in the message).

v Second, it tries to generate and match the First Backup Name.v Third, it tries to generate and match the Second Backup Name.v Fourth, it tries to generate and match the Third Backup Name.v Fifth, if there is not an existing business process that matches the names

generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process nameexists in the system is set to Yes.

Generate an error if no generated business process name exists in the systemGenerate an error message if it cannot locate the specified business processname. Valid values are Yes (default) and No.

Extraction OptionsRequired. Valid values are:v Determined by a business process (default)v Extract to a file system directoryv Extract to a mailbox

Data Extraction DirectoryDirectory for data extraction. Optional.

Data Extraction FilenameFilename for data extraction. Optional.

Data Extraction MailboxMailbox for data extraction. Required.

Data Extraction Mailbox Message NameMailbox message name for data extraction. Optional.

42 Sterling Standards Library: Using EDIFACT

Page 49: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 8. EDIFACT Outbound Syntax 4 UNG UNE EnvelopeProperties, Group Level

Note: An (*) asterisk indicates that a wildcard value can be used with thatparameter (for mandatory fields, the wildcard value is an (*) asterisk). For Inboundenvelopes, a wildcard value in the envelope matches any value in the inputdocument, while an empty value in the envelope matches only an empty value inthe input document. For Outbound envelopes, a wildcard value is equivalent to anempty value in the envelope.

The following table describes EDIFACT outbound Syntax 4 UNG UNE envelopeproperties at the group level:

Field Description

Next EnvelopeSpecifies envelope to use after this envelope. Required.

Create Next EnvelopeAdds group level envelope to use as next envelope or edits an exitingenvelope. Optional.

* Sender IDCoded identifier of the company or division sending the message group.Valid value is 12 standard characters. Required.

* Sender OrganizationThe sender organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Sender ID)Coded qualifier of the sender ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is fourstandard characters. Optional.

* Recipient IDCoded identifier of the company or division receiving the message group.Valid value is 12 standard characters. Required.

* Receiver OrganizationThe receiver organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Recipient ID)Coded qualifier of the recipient ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is fourstandard characters. Optional.

Use Correlation OverridesWhether to use correlation overrides. Required. Valid values are:v Always - If a correlation override value is provided, always use that

value instead of the value in the envelope (except for the Sender ID,Receiver ID, and Sender/Receiver Qualifier fields, which must have a *in the envelope definition to use the correlation override value).

v Only when the envelope field has a wildcard value (*) - Only usecorrelation override values for fields in the envelope definition that arespecified with a wildcard (*).

© Copyright IBM Corp. 2000, 2015 43

Page 50: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Never - Never use correlation overrides.v Use the default specified in enveloping.properties - The

enveloping.properties file defines when to use correlation overrides ifthis choice is selected. The properties file will either define Always,Never, or Only when the envelope field has a wildcard (*) value. Theapplicable properties file property isenveloping.correl_override_default.[standard]. Allowed values are No(which means never), WildcardOnly, or All (which means always, exceptfor the Sender ID, Receiver ID, and Sender/Receiver Qualifier fields,which must have a * in the envelope definition to use the correlationoverride value).

Use global control numberWhether this envelope definition must use a global group number touniquely identify transactions. No indicates that the envelope definitionmust use its own global group number. Required. Valid values are:v Yesv Yes - Generate name from datav No

* Controlling Agency, CodedAgency controlling the code representing the name of the sending EDIservice provider and relaying the message group on the sending side. Validvalue is alphanumeric code with three standard characters. Optional.

* Application PasswordPassword used to access the application of the receiver. Valid value is 15standard characters. Optional.

Primary Name FormatInformation to include when generating a name for a global number andfinding the correct number to assign based on that name. Optional.Information includes:v Message Typev Message Version and Release Numberv Test Indicator

Check each that you want to use in the format.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatCheck boxes to indicate what information to include when generating aname for a global number and finding the correct number to assign basedon that name. Optional. Information includes:v Message typev Message version and release numberv Test Indicator

Check each that you want to use in the format.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

44 Sterling Standards Library: Using EDIFACT

Page 51: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Backup Name FormatCheck boxes to indicate what information to include when generating aname for a global number and finding the correct number to assign basedon that name. Optional. Information includes:v Message typev Message version and release numberv Test Indicator

Check each that you want to use in the format.

* Global Group Reference NumberInterchange control reference number used globally. Select a previouslydefined number to reference. Valid value is nine standard characters.Optional.

Use SecurityUse previously checked in trusted certificates to verify a secured documenttransmission. Valid values are Yes and No. Required.

Note: This option must be set to Yes when using secure AUTACKmessages in EDIFACT.

This is the AUTACK Group EnvelopeSpecify whether this envelope is the AUTACK group envelope. Validvalues are Yes and No (default). Required.

Note: Only displayed if Use Security is set to Yes.

Security CertificateThe security certificate. Default is B2BHttp. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

Security AlgorithmThe algorithm for security purposes. Default is MD5 with RSA. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

Use of AlgorithmHow the algorithm should be used. Default is 1-Owner Hashing. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

Security ServiceThe service provided by the selected security. Default is Non-repudiationof origin. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

Scope of Security ApplicationThe scope of the security application (what it checks). Default is 3 - Wholerelated message, package, group or interchange. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

Chapter 8. EDIFACT Outbound Syntax 4 UNG UNE Envelope Properties, Group Level 45

Page 52: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Response TypeThe type of response. Default is 1- No acknowledgement. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

Filter FunctionThe type of filter used. Default is 2 - Hexadecimal Filter. Required.

Note: Only displayed if Use Security is set to Yes and This is the AUTACKGroup Envelope is also set to Yes.

46 Sterling Standards Library: Using EDIFACT

Page 53: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 9. EDIFACT Outbound Syntax 4 UNH UNT EnvelopeProperties, Transaction Level

Note: An (*) asterisk indicates that a wildcard value can be used with thatparameter (for mandatory fields, the wildcard value is an (*) asterisk). For Inboundenvelopes, a wildcard value in the envelope matches any value in the inputdocument, while an empty value in the envelope matches only an empty value inthe input document. For Outbound envelopes, a wildcard value is equivalent to anempty value in the envelope.

The following table describes EDIFACT outbound Syntax 4 UNH UNT envelopeproperties at the transaction level:

Field Description

Sender IDCoded identifier of the company or division sending the transaction. Validvalue is 12 standard characters. Required.

* Sender OrganizationThe sender organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Sender ID)Coded qualifier of the sender ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is fourstandard characters. Optional.

Recipient IDCoded identifier of the company or division receiving the interchange.Valid value is 12 standard characters. Required.

* Receiver OrganizationThe receiver organization. Optional for envelopes managed by the SterlingB2B Integrator.

* Identification Code Qualifier (Recipient ID)Coded qualifier of the recipient ID as it should appear on the interchangeheader segment sent to this company or division. Valid value is threestandard characters. Optional.

Next EnvelopeEnvelope to apply after this envelope. Required.

Create Next EnvelopeAdds transaction level envelope to use as the next envelope. Optional.Valid values are:v UNG/UNE Syntax 4v UNB/UNZ Syntax 4

Use Correlation OverridesWhether to use correlation overrides. Required. Valid values are:v Always - If a correlation override value is provided, always use that

value instead of the value in the envelope (except for the Sender ID,Receiver ID, and Sender/Receiver Qualifier fields, which must have a *in the envelope definition to use the correlation override value).

© Copyright IBM Corp. 2000, 2015 47

Page 54: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Only when the envelope field has a wildcard value (*) - Only usecorrelation override values for fields in the envelope definition that arespecified with a wildcard (*).

v Never - Never use correlation overrides.v Use the default specified in enveloping.properties - The

enveloping.properties file defines when to use correlation overrides ifthis choice is selected. The properties file will either define Always,Never, or Only when the envelope field has a wildcard (*) value. Theapplicable properties file property isenveloping.correl_override_default.[standard]. Allowed values are No(which means never), WildcardOnly, or All (which means always, exceptfor the Sender ID, Receiver ID, and Sender/Receiver Qualifier fields,which must have a * in the envelope definition to use the correlationoverride value).

Control number handlingHow to handle control numbers. Required. Valid values are:v Global (default)v Global (and generate name from data)v Localv Always start with 1

* Message TypeTransaction message type as determined by the information type in theheader of the message group, which includes the message or by theinformation type in the transaction message. Valid value is six standardcharacters. Required.

* Message Version NumberVersion number of the standard message. Valid value is three standardcharacters. Required.

* Message Release Number (Required for EDIFACT, optional for ODETTE)Release number of the standard message. Valid value is three standardcharacters. Required for EDIFACT and AUTACK. Optional for ODETTE.

* Controlling Agency, CodedAgency controlling the code representing the name of the sending EDIservice provider and relaying the message group on the sending side. Validvalue is alphanumeric code with three standard characters. Optional.

* Association Assigned CodeAssigned associated code for the agency controlling the name of thesending EDI service provider and relaying the message group on thesending side. Valid value is alphanumeric code with six standardcharacters. Optional.

* Code List Directory Version NumberPreviously defined version number of a code list to implement in thismessage. Valid value is numeric code with six limited standard characters.Optional.

* Message Type Sub-Function IdentificationCoded identifier of a sub-function of a message type. Valid value is sixstandard characters. Optional.

* Common Access ReferenceKey used for referencing related all subsequent transfers of data to thesame business case or file. Optional.

48 Sterling Standards Library: Using EDIFACT

Page 55: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

* Sequence Of TransfersNumber assigned by the sender indicating the transfer sequence of amessage related to the same topic. The message could be an addition or achange to an earlier transfer related to the same topic. Valid value is twostandard characters. Optional.

* First And Last TransferFirst and last message in a sequence of messages related to the same topic.Valid value is one standard character. Optional.

* Message Subset IdentificationCoded identifier of a message subset by its identifier, version, release, andsource. Valid value is 15 standard characters. Optional.

* Message Subset Version NumberVersion number of the message subset. Valid value is three standardcharacters. Optional.

* Message Subset Release NumberRelease number of the message subset. Valid value is three standardcharacters. Optional.

Message Subset Controlling Agency, CodedAgency controlling the code representing the name of the message subset.Valid value is alphanumeric code with three standard characters. Optional.

* Message Implementation Guideline IdentificationCoded identifier of a message implementation guideline by its identifier,version, release, and source. Valid value is 14 standard characters.Optional.

* Message Implementation Guideline Version NumberVersion number of a message implementation guideline. Valid value isthree standard characters. Optional.

* Message Implementation Guideline Release NumberRelease number of a message implementation guideline. Valid value isthree standard characters. Optional.

*Message Implementation Controlling Agency, CodedAgency controlling the code representing the name of the messageimplementer. Valid value is alphanumeric code with three standardcharacters. Optional.

* Scenario IdentificationCoded identifier of a scenario by its identifier, version, release, and source.Valid value is 14 standard characters. Optional.

* Scenario Version NumberVersion number of a scenario. Valid value is three standard characters.Optional.

* Scenario Release NumberRelease number of a scenario. Valid value is three standard characters.Optional.

Message Scenario Controlling Agency, CodedAgency controlling the code representing the message scenario. Valid valueis alphanumeric code with three standard characters. Optional.

Accepter Lookup AliasIdentifying string used with the sender ID and the receiver ID to look up

Chapter 9. EDIFACT Outbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 49

Page 56: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

this envelope with the EDI Encoder service. This alias associates adocument with the service it requires. Valid value must be at least onelimited standard character. Required.

Limit Interchange SizeMaximum size allowed for an interchange before a single interchange issplit into multiple interchanges that are each under the maximum sizelimitation.

Valid values are:v Nov Specify size limitv Use global default in enveloping.properties

Required.

Note: If you select Use transaction set default in enveloping.properties,you need to specify the size limit directly (in the Maximum InterchangeSize parameter) or by setting properties in the enveloping.propertiesproperty file, which contains a property for each supported standard andmore specific properties for each message type (for example, INVOIC forthe EDIFACT standard) that can override the standard property.

Specify Non-Standard DelimitersWhether you want to specify non-standard delimiters. Valid values are Yesand No (default). Required.

Data Element SeparatorEDI delimiter to use to separate elements. Optional.

Segment TerminatorEDI delimiter to use to indicate the end of segments. Optional.

Component Element SeparatorEDI delimiter used to separate components. Optional.

Release CharacterCharacter to use to release an EDI delimiter. Optional.

Repetition SeparatorCharacter to use to separate a group of repeated elements. Optional.

Decimal SeparatorCharacter to use to identify different multi details. Optional.

Stream SegmentsInsert an end-of-line character after each segment record. Valid values areYes and No (default). Required.

Primary Name FormatInformation to include when generating a name for a global number andfinding the correct number to assign based on that name. Optional.Information includes:v Message Typev Message Version and Release Numberv Test Indicator

Check each that you want to use in the format.

50 Sterling Standards Library: Using EDIFACT

Page 57: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatCheck boxes to indicate what information to include when generating aname for a global number and finding the correct number to assign basedon that name. Optional. Information includes:v Message typev Message version and release numberv Test Indicator

Check each that you want to use in the format.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatCheck boxes to indicate what information to include when generating aname for a global number and finding the correct number to assign basedon that name. Optional. Information includes:v Message typev Message version and release numberv Test Indicator

Check each that you want to use in the format.

Global Message Reference NumberMessage control reference number used globally. Select a previouslydefined number to reference. Valid value is nine standard characters.Required.

Local Message Reference NumberMessage control reference number used locally. Select a previously definednumber to reference. Valid value is nine standard characters. Required.

Maximum Interchange Size (bytes)Specify the maximum size of each individual interchange. Required.

Note: Only displayed if you selected Specify size limit for the LimitInterchange Size parameter. If you choose to specify a maximum value,the value you specify is checked to make sure it is at least 173 bytes basedon the header and trailer size for EDIFACT standard.

Note: For performance reasons, the size is estimated for some componentsof the interchange (for example, control numbers) when determining thesize. For this reason, the actual enforced size limit is slightly smaller thanthe value you specify.

Map Name ModeMode in which to specify the map to use to perform a compliance check.Valid values are:v Specifyv Generate from data

Map NameSelect the map to be used to perform a compliance check. The map mustalready be checked in to Sterling B2B Integrator. Optional.

Chapter 9. EDIFACT Outbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 51

Page 58: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Note: If you are using the WebSphere Transformation Extender for SterlingB2B Integrator and want to do compliance checking, you must select yourcompliance check map.

Primary Name FormatInformation to include when generating a name for a map and finding thecorrect number to assign based on that name. Information may includesome or all of the following:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv Message Typev Message Version and Release Numberv Test Indicator

Check all that you want to use in the format. Optional.

Use first backup name formatWhether to use the first backup name format (specified below). The defaultis selected (use the first backup name format).

Backup Name FormatInformation to include when generating a name for a map and finding thecorrect number to assign based on that name. Information may includesome or all of the following:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv Message Typev Message Version and Release Numberv Test Indicator

Check all that you want to use in the format. Optional.

Use second backup name formatWhether to use the second backup name format (specified below). Thedefault is selected (use the second backup name format).

Backup Name FormatInformation to include when generating a name for a map and finding thecorrect number to assign based on that name. Information may includesome or all of the following:v EDI Standardv Sender ID Code Qualifierv Sender IDv Recipient ID Code Qualifierv Recipient IDv Message Typev Message Version and Release Number

52 Sterling Standards Library: Using EDIFACT

Page 59: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

v Test Indicator

Check all that you want to use in the format. Optional.

Generate an error if no generated map name exists in the systemGenerate an error message if it cannot locate the specified map name. Validvalues are Yes and No. Required.

Validate translation inputWhether to validate the translation input. Valid values are Yes (default) orNo. Required.

Validate translation outputWhether to validate the translation output. Valid values are Yes (default) orNo. Required.

Use SecurityUse previously checked in trusted certificates to verify a secured documenttransmission. Valid values are Yes and No (default). Required.

Note: This option must be set to Yes when using secure AUTACKmessages in EDIFACT.

Scope of Security ApplicationSecurity header and message body referenced in the digital certificate.Required. Valid values are:v 1 - Security header and message body (default)v 3 - Whole related message, package, group, or interchange

Note: Only displayed if Use Security is set to Yes.

Security CertificateSelect a previously checked in trusted certificate to associate with thisenvelope. Required.

Note: Only displayed if Use Security is set to Yes.

Security AlgorithmStrength of the algorithm used to encrypt data and provides a key lengthyour trading partner can support. Required. Valid values are:v MD5 with RSA – Message digest algorithm that verifies the integrity of

data through a 128-bit message digest. Default.v SHA1 with RSA – Secure hash algorithm that verifies the integrity of

data through a 160-bit (20 byte) message digest. Transmission may be abit slower that MD5; however, the larger message digest size offers amore secure data transference.

Note: Only displayed if Use Security is set to Yes.

Use of AlgorithmDefines when the algorithm is used. Required. Valid values are:v 1 - Owner Hashing (default)v 6 - Owner Signing

Note: Only displayed if Use Security is set to Yes.

Security ServiceWhether the message sender must sign the message with a digitalcertificate. Required.

Chapter 9. EDIFACT Outbound Syntax 4 UNH UNT Envelope Properties, Transaction Level 53

Page 60: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Note: Only displayed if Use Security is set to Yes.

Response TypeWhether you required an acknowledgement for transmitted digitalcertificates. Required.

Note: Only displayed if Use Security is set to Yes.

Filter FunctionThe function of the filter. Default is Hexadecimal filter. Required.

54 Sterling Standards Library: Using EDIFACT

Page 61: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 10. Creating EDIFACT Maps

The Sterling B2B Integrator Map Editor enables you to map EDIFACT documents,and generates a file layout for you using the components and message types thatyou select. The Sterling B2B Integrator Map Editor-generated EDIFACT mapconsists of groups, records, composites, and fields that are comparable toparameters that are defined by EDIFACT.

Note: You need to download the Sterling B2B Integrator Map Editor component touse it.

Sterling B2B Integrator Map Editor allows you to modify the map components byusing the Deactivate, Promote, Split, Copy, Cut, and Paste functions.

You can create a map for all EDIFACT Standards Release messages loaded into theIBM Sterling Standards Database for EDI through the Sterling B2B Integrator MapEditor.

EDIFACT Components in the Sterling B2B Integrator Map EditorThe following table lists the components that make up the EDIFACT layout in theSterling B2B Integrator Map Editor, the icons that represent the components, anddescriptions of the components.

Component Icon Description

EDIFACTroot element

The EDIFACT root element represents the message that the SterlingB2B Integrator is mapping. At the EDIFACT file root element, youdefine the message type and encoding. It is a group and cancontain groups and records.

Group A group is a looping structure that contains a sequence or animplicit group of repeating field tags (in Sterling B2B IntegratorMap Editor, a group is related segments and groups that repeat insequence until either the group data ends, or the maximum numberof times that the loop is permitted to repeat is exhausted).

A group that is subordinate to another group is a subgroup (andcorresponds to a nested looping structure, a loop within a loop).

When a group contains an extended rule or a standard rule, anasterisk appears to the right of the group icon.

Segment An EDIFACT segment contains a field tag (in Sterling B2B IntegratorMap Editor, an EDIFACT segment is a group of related elements orcomposite data elements that combine to communicate useful data).An EDIFACT segment can occur once or can repeat multiple times.Note: If an EDIFACT segment occurs more than once in a map, it isidentified by its name <ID>. The second and subsequentoccurrences are identified by <ID>:n, where n is the number of theoccurrence in the map.

© Copyright IBM Corp. 2000, 2015 55

Page 62: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Component Icon Description

Element An element is a field or a group of EDIFACT components (thesmallest piece of information defined by the standard) that definean EDIFACT element. An element can have different meaningsdepending on the context. In other data formats in the Sterling B2BIntegrator Map Editor, an element is not considered to have usefulmeaning except in the larger context of the segment that contains it.However, elements used in the Sterling B2B Integrator Map Editorto represent EDIFACT fields and components contain useful anddiscrete information.Note: If an element occurs more than once in a map it is identifiedby its name <ID>. The second and subsequent occurrences areidentified by <ID>:n, where n is the number of the occurrence inthe map.

A repeating element is an element with the ability to loop (occurmore than once) within a particular EDIFACT segment. To enable asingle element to repeat multiple times within an EDIFACTelement, the occurrence of the element must be separated by a startand end delimiter. The use of start and end delimiters help thetranslator determine where elements and components are definedwithin a field tag.

When a field has a link performed against it, a red check markappears over the element icon.

When a field contains an extended rule or a standard rule, anasterisk appears to the right of the element icon.

Using Transaction XREF with EDIFACTAbout this task

If you need the ability to cross-reference the Sterling B2B Integrator data togenerated transaction, perform the following:

Procedure1. The Sterling B2B Integrator Map Editor uses the

TransactionCrossReferenceTable, with possible values SenderID, ReceiverID,MessageType, Identifier.

2. The translator populates these values during translation.3. After each round of translation completes, the EDI Enveloping service can

query for the values. When it performs the enveloping, it will locate thestandard-specific values for the same four parameters.

4. Based on these two sets of values for identifiers (application specific andstandard specific), the EDI Enveloping service populates aTransactionCrossReferenceTable

5. You can build a custom application that queries this table to uniquely link anapplication file and generate an EDIFACT transaction.

56 Sterling Standards Library: Using EDIFACT

Page 63: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Create an EDIFACT MapAbout this task

When you create a new map, you can either manually create an EDI layout or youcan use a wizard that creates a layout for you based on an EDI standard. Thewizard saves you time and effort and minimizes the risk of having an invalidstandard format.

Note: If the map you are creating contains greater than 20,000 objects, you willreceive a message noting that this map contains a very large number of objects. Forbest performance, it is recommended that you consider whether any unnecessaryobjects in the map can be removed, do not expand the entire object tree—expandonly the section of the tree you are currently mapping, consider using the Showlinks to or from the currently selected element option instead of the Show linksto or from all visible elements option, and save the map using the .MAP fileformat (using the Save As function).

To create an EDIFACT map:

Procedure1. From the Sterling B2B Integrator Map Editor File menu, select New.2. In the New Map Wizard, complete the questions in the first window and click

Next.

Note: Be sure that Sterling B2B Integrator is selected in the What kind ofmap are you creating list.

3. If you are translating from EDIFACT, in the Input Format window select theCreate a New Data Format Using this Syntax option.

4. Then, select Delimited EDI and click Customize. If you are translating fromanother format, select that format and continue to the next page of the wizard.

5. If you want to import code lists from the Sterling Standards Database for EDI,select the Import code list check box and click Next. Otherwise, just clickNext.

Note: If you select the Import code list check box, a Use Code standard ruleis created on fields for which the element name matches a code list tablename.

6. Select the ODBC data source that contains the Sterling Standards Database forEDI (the default is IBM Sterling B2B Integrator Standards) and click Next.

7. Select the standards agency ([E] EDIFACT), the version of the standard, andthe transaction set you want to use and click Next.

8. Click Finish to load the transaction set.9. Click Next to select the Output Format.

10. If you are translating to EDIFACT, in the Output Format window (select theCreate a New Data Format Using this Syntax option.

11. Then, select Delimited EDI and click Customize. If you are translating fromanother format, select that format and continue to the next page of the wizard.

12. If you want to import code lists from the Sterling Standards Database for EDI,select the Import code list check box and click Next. Otherwise, just clickNext.

Chapter 10. Creating EDIFACT Maps 57

Page 64: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Note: If you select the Import code list check box, a Use Code standard ruleis created on fields for which the element name matches a code list tablename.

13. Select the ODBC data source that contains the Sterling Standards Database forEDI (the default is IBM Sterling B2B Integrator Standards) and click Next.

14. Select the standards agency ([E] EDIFACT), the version of the standard, andthe transaction set you want to use and click Next.

15. Click Finish to load the transaction set. The Sterling B2B Integrator MapEditor displays the new map.

16. In the Sterling B2B Integrator Map Editor, select File > Save to save the map.Do not use spaces or apostrophes in the map name.

Note: To compile the map, select File > Compile. A progress dialog boxdisplays and updates during the compilation process. If the map contains alarge number of objects, you may be prompted that you should save the mapin .MAP format.

17. To save a map as a .map file, select File > Save As and then select SourceMaps (*.map) from the Save as type list.

Note: Prior to opening an .mxl (XML-formatted) file, the Sterling B2BIntegrator Map Editor verifies that you have the Microsoft XML Core Services(MSXML) 4.0 installed on the same computer as Sterling B2B Integrator MapEditor. If you do not have the Microsoft XML Core Services (MSXML) 4.0installed, the Sterling B2B Integrator Map Editor cannot save or load .mxlsource files.

58 Sterling Standards Library: Using EDIFACT

Page 65: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 11. Generate an EDIFACT Report

About this task

The EDI Translation Detail report enables you to access EDI data (for a particularstandard like EDIFACT) for a specified time period. It further allows you toorganize the report by selecting criteria such as direction of the transmission,sender and receiver identifier, envelope name, unique identifier for the envelopelevel, EDI standard used, and translation success or failure, among otherparameters. This report allows you to quickly and easily access information aboutEDI translation through the system.

To run a report containing details on inbound/outbound EDIFACT messages:

Procedure1. From the Operations menu, select Reports.2. Use the Report Configuration wizard to create a new EDI Transaction Detail

report.3. On the Detail Filtering page in the Standard parameter, clear the checkboxes

for all standards except EDIFACT.4. Filter by any other desired criteria and click Finish at the end of the Report

Configuration Wizard to generate the report.

© Copyright IBM Corp. 2000, 2015 59

Page 66: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

60 Sterling Standards Library: Using EDIFACT

Page 67: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Chapter 12. Search for EDIFACT Correlations

About this task

Correlation data, often called correlations, is defined as specific pieces of data thatyou may need to review in the process of monitoring, tracking, andtroubleshooting your activities. These data items are defined by type and value.These type-value pairs are known as name-value pairs, and are a powerful toolyou can use to record and search for business process- and document-specific data.Sterling B2B Integrator has some predefined correlations and enables you to definemore so that you can easily and efficiently monitor and track your activities, suchas EDIFACT message flow.

To search for EDIFACT correlations:

Procedure1. From the Administration menu, select Business Process > Monitor >

Advanced Search > EDI Correlation.2. In the Search Option area, specify any combination of the following search

criteria, as appropriate. To search for EDIFACT messages, in the InterchangeLevel Options Standard box, type EDIFACT.

3. Click Go! to display the EDI correlation records that match your search criteria.

4. In the EDI Correlation Interchange Results page, click info in the Detailcolumn for the AS2 interchange for which you want to view details.

5. In the EDI Correlation Interchange/Group/Transaction Detail Results page,

click info to the right of Document Correlations for additional informationabout the EDIFACT messages.

© Copyright IBM Corp. 2000, 2015 61

Page 68: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

62 Sterling Standards Library: Using EDIFACT

Page 69: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785

U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law

IBM Japan Ltd.

19-21, Nihonbashi-Hakozakicho, Chuo-ku

Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will be

© Copyright IBM Corp. 2000, 2015 63

Page 70: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

incorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Corporation

J46A/G4

555 Bailey Avenue

San Jose, CA 95141-1003

U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

64 Sterling Standards Library: Using EDIFACT

Page 71: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© IBM 2015. Portions of this code are derived from IBM Corp. Sample Programs. ©Copyright IBM Corp. 2015.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

Trademarks

IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at “Copyright andtrademark information” at http://www.ibm.com/legal/copytrade.shtml.

Adobe, the Adobe logo, PostScript, and the PostScript logo are either registeredtrademarks or trademarks of Adobe Systems Incorporated in the United States,and/or other countries.

IT Infrastructure Library is a registered trademark of the Central Computer andTelecommunications Agency which is now part of the Office of GovernmentCommerce.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks orregistered trademarks of Intel Corporation or its subsidiaries in the United Statesand other countries.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

Notices 65

Page 72: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.

ITIL is a registered trademark, and a registered community trademark of the Officeof Government Commerce, and is registered in the U.S. Patent and TrademarkOffice.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Java™ and all Java-based trademarks and logos are trademarks or registeredtrademarks of Oracle and/or its affiliates.

Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in theUnited States, other countries, or both and is used under license therefrom.

Linear Tape-Open, LTO, the LTO Logo, Ultrium and the Ultrium Logo aretrademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.

Connect Control Center®, Connect:Direct®, Connect:Enterprise®, Gentran®,Gentran®:Basic®, Gentran:Control®, Gentran:Director®, Gentran:Plus®,Gentran:Realtime®, Gentran:Server®, Gentran:Viewpoint®, Sterling Commerce™,Sterling Information Broker®, and Sterling Integrator® are trademarks or registeredtrademarks of Sterling Commerce®, Inc., an IBM Company.

Other company, product, and service names may be trademarks or service marksof others.

66 Sterling Standards Library: Using EDIFACT

Page 73: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT
Page 74: Sterling Standards Library - public.dhe.ibm.compublic.dhe.ibm.com/software/commerce/doc/sb2bi/v5r2/Stds804_Usi… · Chapter 1. Using EDIFACT with the Sterling B2B Integrator EDIFACT

����

Printed in USA