WebSphere Partner Gateway Glossary
-
ACK
- See acknowledgment.
-
acknowledgment
(ACK)
- The transmission of acknowledgment characters as a positive response to a data transmission.
-
action
- A series of processing steps, such as document validation and transformation.
-
American National Standards Institute
(ANSI)
- A private, nonprofit organization whose membership includes private companies, U.S. government agencies, and professional, technical, trade, labor, and consumer organizations. ANSI coordinates the development of voluntary consensus standards in the U.S.
-
ANSI
- See American National Standards Institute.
-
ANSI Accredited Standards Committee X12
(ANSI ASC X12)
- A committee formed by the American National Standards Institute (ANSI) to develop business transaction standards for electronic data interchange (EDI).
-
ANSI ASC X12
- See ANSI Accredited Standards Committee X12.
-
associated type
- An object that refers to a source object.
See also
referenced type.
-
base document
- The document definition that a map is based on.
-
binary format
- Representation of a decimal value in which each field must be 2 or 4 bytes long.
The sign (+ or -) is in the far left bit of the field, and the number value is in the remaining bits of the field. Positive numbers have a 0 in the sign bit and are in true form. Negative numbers have a 1 in the sign bit and are in twos complement form.
-
build time data
- Objects that are not used by the translator, such as EDI standards, record oriented data document definitions, and maps.
-
business process
- A predefined set of business transactions that represent the steps required to achieve a business objective.
-
business protocol
- A set of rules and instructions (protocol) used to format and transmit information across a computer network. Examples include RosettaNet, cXML, and EDI-X12.
-
client/server
- Pertaining
to the model of interaction in distributed data processing in which a program on one computer sends a request to a program on another computer and awaits a response. The requesting program is called a client; the answering program is called a server.
-
code list
- A table, supplied by Data Interchange Services or defined by the user, that contains all acceptable values for a single data field.
-
comma delimited file
- A file whose records contain fields that are separated by a comma.
-
Community Console
- A Web-based tool used to configure WebSphere Partner Gateway and to manage the flow of business documents between the Community Manager and participants.
-
community manager
- A company that purchases
WebSphere Partner Gateway and acts as the hub community for its partners. The community manager has one administrative user, the manager admin, who is responsible for the health and maintenance of the community manager\x{2019}s portion of the community.
-
community operator
- The service provider who has a restricted set of typical day-to-day administrative responsibilities for the hub.
-
community participant
- A trading community participant that sends business documents to and receives business documents from the community manager.
-
compound element
- An item in the source or target document that contains child items, such as EDI Segments and EDI composite data elements, ROD records and ROD structures in record oriented data, and XML elements.
-
configuration database
- The Data Interchange Services client database that stores parameters necessary for running Data Interchange Services client, including database definitions, messages, queries, and preferences.
-
control number
- A number that is used to identify an interchange, group, or EDI document.
-
control string
- One of several compiled objects, which consist primarily of map control strings and document definition control strings.
-
control structure
- The beginning and ending segments (header and trailer) of EDI-enveloped documents.
-
customization time data
- See build time data.
-
database definition
- A Data Interchange Services definition that contains information used by Data Interchange Services Client to connect to a database.
-
data dictionary
- A grouping of logically related components of a particular syntax type, such as ROD dictionaries, EDI dictionaries, and XML dictionaries.
-
data element delimiter
- A character, such as an asterisk (*), that follows the EDI segment identifier and separates each EDI data element in an EDI segment.
See also
segment ID separator.
-
Data Interchange Services
(DIS)
- A feature of WebSphere Partner Gateway that provides support for exchanging EDI documents; it consists
of a set of tools for describing document metadata and mapping documents to one another along with the associated runtime components for executing document transformations. Data Interchange Services is also compatible with WebSphere Data Interchange.
See also
WebSphere Data Interchange.
-
Data Interchange Services Client
(DIS client)
- The Data Interchange Services tool used to document metadata and map documents to one another.
-
Data Interchange Services database
- The database that contains all Data Interchange Services objects.
-
Data Interchange Services translator
- The Data Interchange Services component responsible for transforming a document from one format to another.
-
data transformation map
- A set
of mapping instructions that describes how to translate data from a source document into a target document. Both the source and target documents can be one of several supported document types. A data transformation map is one of three supported map types.
-
Data Universal Numbering System
(DUNS)
- A system in which internationally recognized nine-digit numbers are assigned and maintained by Dun & Bradstreet to uniquely identify worldwide businesses.
See also
participant profile.
-
DB2
- A family of IBM licensed programs for relational database management.
-
decimal notation
- In an EDI Standard, the character that represents a decimal point.
-
de-envelope
- To extractw a document from an EDI envelope.
-
delimiter
- A character that terminates a string of characters.
-
DI Client
- See WebSphere Data Interchange Client.
-
dictionary
- A grouping of logically related components of a particular syntax type, such as ROD dictionaries, EDI dictionaries, and XML dictionaries.
-
DIS
- See Data Interchange Services.
-
DIS client
- See Data Interchange Services Client.
-
DLL
- See dynamic link library.
-
document
- A business document, such as a purchase order or invoice, that can be represented in any supported format. For example, an XML purchase order and an EDI purchase order are both documents, but each uses a different format.
-
document definition
- A description of a document layout that is used to identify the format of a document. Examples include record oriented data document definitions, EDI document definitions, XML schema document definitions, and XML DTD document definitions.
-
document flow definition
- A collection of information specified for each type of document that tells the hub how to process that particular type of document. Each document to be exchanged between the community manager and a participant must have a document flow definition.
-
document ID
- A unique identifier for a document.
-
Document Manager
- A runtime
component of WebSphere Partner Gateway that polls persistent shared storage for documents; performs user-configured processing, such as validation, digital signature verification, and transformation; and delivers the document to its final destination.
-
document type definition
(DTD)
- The rules that specify the structure
for a particular class of SGML or XML documents. The DTD defines the structure with elements, attributes, and notations, and it establishes constraints for how each element, attribute, and notation can be used within the particular class of documents.
-
domain
- The data structure or group of data structures to and from which you should restrict the mapping of repeating elements and loops.
-
DTD
- See document type definition.
-
DTD document definition
- A description or layout of an XML document based on an XML DTD.
-
DUNS
- See Data Universal Numbering System.
-
dynamic link library
(DLL)
- A file containing executable code and data bound to a program at load time or run time, rather than during linking. The code and data in a dynamic link library can be shared by several applications simultaneously.
-
EDI
- See electronic data interchange.
-
EDI administrator
- The person responsible for setting up and maintaining Data Interchange Services.
-
EDI composite data element
- A group of related EDI Data Elements, such as the elements that make up a name and address. Maintained as EDI data elements in Data Interchange Services.
-
EDI data element
- A single item of data in an EDI document, such as a purchase order number, that corresponds to a ROD field in a ROD document definition. An EDI data element is equivalent to a simple element. It is also used to maintain EDI composite data elements.
-
EDI document definition
- A description or layout of an EDI document, which comprises loops, EDI segments, EDI data elements, and EDI composite data elements. It is equivalent to the layout of an EDI transaction or an EDI message.
-
EDI envelope
- The EDI segments and EDI data elements that make up the headers and trailers that enclose EDI transaction sets, functional groups, and interchanges.
-
EDI loop
- A group of consecutive EDI segments that repeat together in an EDI document definition. There is no object type in Data Interchange Services that defines an EDI loop on its own. EDI loops are logically defined within an EDI document definition.
See also
loop.
-
EDI message
- In UN/EDIFACT EDI Standards, a group of logically related data that makes up an electronic business document, such as an invoice. It is equivalent to an EDI transaction. Called an EDI document definition in Data Interchange Services.
-
EDI message set
- A group of logically related data that make up an electronic business document, such as an invoice or a purchase order. A single EDI document. The layout of an EDI transaction is described by an EDI document definition in Data Interchange Services.
-
EDI segment
- A group of related
EDI data elements. An EDI segment is a single line in an EDI document definition, beginning with a segment identifier and ending with a segment terminator delimiter. The EDI data elements in the EDI segment are separated by data element delimiters.
-
EDI standard
- The industry-supplied, national or international formats to which information is converted, allowing different computer systems and applications to exchange information.
-
EDI transaction
- In X12 EDI
Standards, a group of logically related data that makes up an electronic business document, such as an invoice. It is equivalent to an EDI message. The layout of an EDI transaction is described by an EDI Document Definition in Data Interchange Services.
-
EDI transaction set
- A group of logically related data that make up an electronic business document, such as an invoice or a purchase order. A single EDI document.
-
electronic data interchange
(EDI)
- The exchange of structured electronic data between computer systems according to predefined message standards.
-
element
- A component of a document; an element can be a compound element or a simple element.
-
element separator
- See data element delimiter.
See also
segment ID separator.
-
envelope
- A control structure containing documents.
-
event
- An occurrence of significance to a task or system, such as the completion or failure of an operation.
-
event driven translation
- A translation automatically triggered by the receipt of a document.
-
export file
- The file containing data that has been exported.
-
Extensible Markup Language
(XML)
- A standard metalanguage for defining markup languages that is based on Standard Generalized Markup Language (SGML).
XML simplifies the process of authoring and managing structured information and transmitting and sharing structured information across diverse computing systems.
-
floating segment
- An EDI segment of an EDI document definition that can exist in many positions relative to other EDI segments.
-
functional acknowledgment
- An electronic acknowledgment returned to the sender to indicate acceptance or rejection of EDI documents.
-
functional acknowledgment map
- A set of mapping instructions that describe how to create an EDI Standard functional acknowledgement. One of three supported map types.
-
functional group
- One or more documents of a similar type transmitted from the same location and enclosed by functional group header and trailer segments.
-
function key
- A key that performs a specified set of operations when it is pressed.
-
gateway
- An exit point from Partner Gateway that is used by Partner Gateway to deliver documents to a back-end system or a trading partner.
-
global variable
- A
variable that is used to hold and manipulate values assigned to it during translation and that is shared across maps and across document translations. One of the three types of variables supported by the Data Interchange Services mapping command language.
-
group
- A set of related documents within an interchange. An interchange can contain zero to many groups.
-
header
- The portion of a message that contains control information.
-
Health Insurance Portability and Accountability Act
(HIPAA)
- A legislative act in the U.S. that requires health plans and providers to use a common format when electronically communicating health information.
-
hierarchical loop
(HL)
- A technique for describing the relationship of data entities which are related in a parent to child manner, like a corporate organization chart.
-
HIPAA
- See Health Insurance Portability and Accountability Act.
-
HL
- See hierarchical loop.
-
hub administrator
- The superuser who configures the hub and who has the ability to perform all the tasks associated with setting up and administering the hub.
-
inbound document
- See source document.
-
interaction
- A definition for a source document entering WebSphere Partner Gateway that explains what the target document leaving WebSphere Partner Gateway should be. It consists of the source document, target document, action, and a transformation map.
-
interchange
- The exchange of information between trading partners. Also a set of documents grouped together, such as EDI documents enclosed within an EDI envelope.
-
Java Message Service
(JMS)
- An application programming interface that provides Java language functions for handling messages.
-
JMS
- See Java Message Service.
-
key
- The field or fields in any Data Interchange Services object, such as a profile or map, that uniquely identify the object. For example, the key for a map is the name of the map.
-
literal
- A character string whose value is defined by the characters themselves. For example, the numeric constant 7 has the value 7, and the character constant 'CHARACTERS' has the value CHARACTERS.
-
local database
- A database that is located on the workstation in use.
-
locale
- A subset of a user's environment that defines conventions for a specified culture, such as time formatting, numeric formatting, monetary formatting, and character classification, conversion, and collation.
-
local variable
- A variable
unique to the map it is defined in (it is not shared across maps) and one of the three types of variables supported by the Data Interchange Services mapping command language. It is used to hold and manipulate values assigned to it during translation.
-
loop
- A repeating group of related compound elements, such as EDI segments or ROD records.
See also
EDI loop,
record oriented data loop.
-
loop ID
- A unique code that identifies an EDI loop.
-
loop repeat
- A number indicating the maximum number of times a loop can be used in succession.
-
map
- A set of commands that provide instructions for transforming a document from one format to another. A map can also include instructions on how to examine a document.
-
map chaining
- The process of producing multiple documents from a single document by executing several maps to translate the single document.
-
map control string
- An object compiled from a map, which contains the instructions used by the translator to translate a document from one format to another.
-
mapping
- The act of developing and maintaining a map.
-
mapping specialist
- The person responsible for creating data transformation maps, validation maps, and functional acknowledgement maps using the Data Interchange Services client.
-
maximum use
- A number indicating the maximum number of times a compound or simple element can repeat.
-
message
- A communication sent from a person or program to another person or program.
-
message log
- The file in which Data Interchange Services client logs messages about errors that occur within the client.
-
message queue
- A named destination to which messages can be sent until they are retrieved by programs that service the queue.
-
MQSeries
- A previous name for WebSphere MQ.
-
multiple-occurrence mapping
- A form of mapping in which all occurrences of a repeating compound or simple element are mapped to the same repeating compound or simple element in another document.
-
namespace
- In XML, a uniform resource identifier (URI) that provides a unique name to associate with all the elements and type definitions in a schema.
-
namespace object
- A Data Interchange Services object that contains information about an XML namespace and assists the translator in being namespace aware when translating a source document to an XML document.
-
network acknowledgment
- A response from the network indicating the status of an interchange envelope, such as sent or received.
-
node
- Any item on a tree control, including a simple element, compound element, mapping command, comment, or group node.
-
non-repudiation data repository
- The location where WebSphere Partner Gateway stores copies of documents (and authentication information for signed documents) in case disputes arise regarding the authenticity of document exchanges.
-
numeric constant
- The actual numeric value to be used in processing, instead of the name of a field containing the data. A numeric constant can contain any of the numeric digits 0 through 9, a sign (plus or minus), and a decimal point.
-
ODBC
- See Open Database Connectivity.
-
Open Database Connectivity
(ODBC)
- A standard application programming interface (API) for accessing data in both relational and nonrelational
database management systems. Using this API, database applications can access data stored in database management systems on a variety of computers even if each database management system uses a different data storage format and programming interface.
-
outbound document
- See target document.
-
package
- The wrapper around the document content that defines the format used to transmit a document over the Internet, for example, RNIF, AS1, and AS2.
-
parser
- A module used to break down a document into its component parts and to construct a document from its component parts.
-
participant connection
- An interaction that has been associated with specific sending and receiving partners, and also specifies the gateways and other routing information necessary for an exchange.
-
participant profile
- A profile that includes information about the participant such as its name, its business identifier, such as a DUNS number, and a list user IDs authorized to access the Community Console.
See also
Data Universal Numbering System.
-
path qualified mapping
- A form of mapping in which all occurrences of a repeating compound or simple element are mapped to the same repeating compound or simple element in another document.
-
PIP
- See RosettaNet Partner Interface Process.
-
process
- The sequence of documents or messages to be exchanged between the Community Managers and participants to execute a business transaction.
-
qualifier
- A simple element that gives another
generic compound or simple element a specific meaning. Qualifiers are used in mapping single or multiple occurrences. A qualifier can also be used to denote the namespace used to interpret the second part of the name, usually referred to as the ID.
-
queue manager
- A system program that provides queuing services to applications. It provides an application programming interface so that programs can access messages on the queues that the queue manager owns.
-
quiesce
- To end a process by allowing operations to complete normally, while rejecting any new requests for work.
-
receiver
- A component that accepts documents from community participants and from back-end applications and stores them in a file system for the Document Manager to process. Specifically, it receives
a document over a supported transport protocol, writes the document and metadata relating to the document to the shared file system, records any transport-specific data to the metadata file, and completes any transport-specific technical acknowledgment.
See also
target.
-
record ID information object
- A Data
Interchange Services object that contains control information for ROD document definitions. It identifies the type of ROD document definition being used and where the record ID, if any, is located in the records associated with the document definition.
-
record oriented data
(ROD)
- The type of document definition used to describe proprietary document formats. One of the supported document syntax types.
-
record oriented data dictionary
(ROD dictionary)
- A logical grouping of related ROD document definition components.
-
record oriented data document definition
(ROD document definition)
- A description or layout of a proprietary document, comprising loops, records, structures, and fields.
-
record oriented data field
(ROD field)
- A single item of data, such as a purchase order number, in a record oriented data (ROD) document definition. A ROD field corresponds to an EDI data element in an EDI document definition.
-
record oriented data loop
(ROD loop)
- A group of consecutive records and loops that repeat together in a ROD document definition.
See also
loop.
-
record oriented data record
(ROD record)
- A group of logically related fields set up as a record in a ROD document definition.
-
record oriented data structure
(ROD structure)
- A group of related fields in a ROD document definition, such as the fields making up the line item of an invoice. The record oriented data (ROD) structure corresponds to an EDI composite data element in an EDI document definition.
-
referenced type
- An object that is referred to by a source object.
See also
associated type.
-
release character
- The character that indicates that a separator or delimiter is to be used as text data instead of as a separator or delimiter. The release character must immediately precede the delimiter.
-
repeating data element
- An EDI data element or EDI composite data element that occurs more than once consecutively in an EDI segment.
-
ROD
- See record oriented data.
-
ROD dictionary
- See record oriented data dictionary.
-
ROD document definition
- See record oriented data document definition.
-
ROD field
- See record oriented data field.
-
ROD loop
- See record oriented data loop.
-
ROD record
- See record oriented data record.
-
ROD structure
- See record oriented data structure.
-
RosettaNet Partner Interface Process
(PIP)
- A specialized system-to-system XML-based dialog that depicts the activities, decisions, and partner role interactions that fulfill a business transaction between two partners in a given supply chain.
-
runtime object
- An object used by the translator, such as a control string, code list, translation table, or user exit profile.
-
schema document definition
- A description or layout of an XML document based on an XML schema.
-
security administrator
- The person who controls access to business data and program functions
-
segment directory
- A file containing the format of all EDI segments in an EDI standard.
-
segment identifier
- A unique three-character identifier at the beginning of each EDI segment.
-
segment ID separator
- The character that separates the segment identifier from the EDI data elements in the EDI segment.
See also
data element delimiter.
-
segment terminator
- The character that marks the end of an EDI segment.
-
service segment
- The EDI segment used when an EDI document is enveloped (such as ISA, GS, ST, UNB, UNH, UNT, and so on).
-
simple element
- An item in the source or target document that does not contain child items, only data. Examples are EDI data elements, ROD fields, XML attributes, and XML PCData values.
-
single-occurrence mapping
- A form of mapping in which a specific occurrence of a repeating compound or simple element is mapped to a compound or simple element.
-
source based map
- A map based on the order elements that are defined in the source document definition.
-
source document
- A document that is going to be translated.
-
source document definition
- A description of a document layout that is used to identify the format of the source document for a translation.
-
special variable
- A variable that is similar to a local or global variable, except that it is predefined in Data Interchange Services. Special variables are created during translation at the start of a document and cannot be created or maintained by the user.
-
SQL
- See Structured Query Language.
-
standard envelope
- See EDI envelope.
-
Structured Query Language
(SQL)
- A standardized language for defining and manipulating data in a relational database.
-
subelement
- In UN/EDIFACT EDI standards, an EDI data element that is part of an EDI composite data element. For example, an EDI data element and its qualifier are subelements of an EDI composite data element.
-
subelement separator
- A character that separates the subelements in an EDI composite data element.
-
syntax type
- A category used to classify different formats of documents. Data Interchange Services supports three syntax types: XML, EDI, and record oriented data. The user can map and translate between any of these syntax types.
-
tag
- In UN/EDIFACT EDI Standards, the segment identifier. In export and import, a code that is assigned to each field in the database and used to identify the field in the export file. Such export files are known as tagged files.
-
target
- An entry
point into Partner Gateway. It is an instance of a receiver configured for a particular deployment; each target supports documents sent using a single transport type and multiple targets can exist for a given transport type, one for each document format.
See also
receiver.
-
target based map
- A map based on the order elements that are defined in the target document definition.
-
target document
- The document that is created by a translation.
-
target document definition
- A description of the document layout used to create an output document from a translation.
-
target document definition window
- One of the pages on the Details tab of the Data Transformation Map Editor and the Functional Acknowledgement Map Editor. It displays the target document definition.
-
TDCC
- See Transportation Data Coordinating Committee.
-
trading partner
- A company, such as a manufacturer and a supplier, who agrees to exchange information using electronic data interchange, as well as an entity within an organization that sends and receives documents that are translated.
-
trailer
- A control structure that indicates the end of an electronic transmission.
-
transform
- To convert a document from one form to another, such as using a purchase order formatted as an XML document to create the same purchase order formatted as an EDI document.
See also
translate.
-
translate
- In early versions of WebSphere Data Interchange, to convert a document from one form to another.
See also
transform.
-
translation table
- A user-defined table that is used to translate data values
that differ between the source and target documents. For example, a manufacturer and supplier with different part numbers for the same item can use a translation table to convert their part numbers to the other company's part numbers during translation.
-
translator
- A component, usually the Data Interchange Services translator component, responsible for translating a document from one format to another.
-
Transportation Data Coordinating Committee
(TDCC)
- An organization that sets standards for the motor, rail, ocean, and air industries administered by
EDIA. This is the original EDI organization for the United States, and through it, the original EDI Standards were developed, published, and maintained. It has now changed its name to EDIA, and has become the national EDI user group for the United States.
-
UCS
- See Uniform Communication Standard.
-
unary operator
- An operator that changes the sign of a numeric value.
-
UN/EDIFACT
- See United Nations Electronic Data Interchange for Administration, Commerce and Transport.
-
Uniform Communication Standard
(UCS)
- The EDI standard used in the grocery industry.
-
Uniform Resource Identifier
(URI)
- A unique address that is used to identify content on the Web, such as a page of text, a video or sound clip, a still or animated image, or a program. The most common form of URI is the Web
page address, which is a particular form or subset of URI called a Uniform Resource Locator (URL). A URI typically describes how to access the resource, the computer that contains the resource, and the name of the resource (a file name) on the computer.
-
United Nations Electronic Data Interchange for Administration, Commerce and Transport
(UN/EDIFACT)
- An international set of electronic data interchange (EDI) standards published by the United Nations that is built upon X12 and TDI (Trade Data Interchange) standards.
-
United Nations Trade Data Interchange
(UNTDI)
- A standard that predeced the UN/EDIFACT EDI standard.
-
UNTDI
- See United Nations Trade Data Interchange.
-
URI
- See Uniform Resource Identifier.
-
user exit profile
- A profile that defines a user-provided program or exit routine to Data Interchange Services.
-
validation map
- A set of mapping instructions that describe additional validation for an EDI document. One of five supported map types.
-
variable
- The entity in which a value may be stored based on data received; as opposed to a constant value. Data Interchange Services supports local variables, global variables, and special variables in mapping.
-
WDI
- See WebSphere Data Interchange.
-
WDI Client
- See WebSphere Data Interchange Client.
-
WebSphere Data Interchange
(WDI)
- An IBM stand-alone product used to translate documents from one format to another. It is compatible with Data Interchange Services.
See also
Data Interchange Services.
-
WebSphere Data Interchange Client
(
WDI Client
DI Client)
- A Windows based product for entry and maintenance of information needed by the WebSphere Data Interchange.
-
WebSphere MQ
- A family of IBM licensed programs that provides message queuing services.
-
WebSphere Partner Gateway
- A product that enables the establishment and maintenance of a business-to-business (B2B) trading community for secure, automated, cost-effective exchange of business documents between companies and their suppliers.
-
WebSphere Partner Gateway Document Manager database
- The WebSphere Partner Gateway defined database
that contains Data Interchange Services runtime objects, such as control strings, code lists, user exits, translation tables, and global variables. It does not contain Data Interchange Services build time objects, such as maps and document definitions.
-
X12
- A protocol from the American National Standards Institute (ANSI) for electronic data interchange (EDI).
-
XML
- See Extensible Markup Language.
-
XML document definition
- A reference to either an XML DTD document definition or an XML schema document definition.
-
z/OS
- An IBM operating system for the IBM zSeries family of enterprise servers that includes and integrates functions previously provided by many IBM software products (including the MVS and OS/390 operating systems). z/OS is an open, secure operating system
for the IBM zSeries family of enterprise servers, complies with industry standards, is enabled for network computing and e-business, and supports technology advances in networking server capability, parallel processing, and object-oriented programming.
