6-5-2 1SYNC Module Install and Users Guide

Title Page
webMethods 1SYNC Module

Installation and Users Guide
Version 6.5.2
September 2008
Copyright
This document applies to webMethods 1SYNC Module Version 6.5.2 and to all subsequent releases.
Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.
Copyright 2007-2011 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or
their licensors.
The name Software AG, webMethods and all Software AG product names are either trademarks or registered trademarks of Software AG
and/or Software AG USA, Inc. and/or its Subsidiaries and/or their licensors. Other company and product names mentioned herein may be
trademarks of their respective owners.
Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at
http://documentation.softwareag.com/legal/.
Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the product
documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).
This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to License
Texts, Copyright Notices and Disclaimers of Third-Party Products. This document is part of the product documentation, located at
http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).
Document ID: ESTD-1SYNC-IUG-652-20130618

Table of Contents
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Deprecation of webMethods Developer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Document Titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Documentation Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Online Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1. Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
What Is 1SYNC? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
What Is webMethods 1SYNC Module? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1SYNC Module Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1SYNC Module Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Design-Time Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Run-Time Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
The 1SYNC Item Synchronization Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Item Management Message Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Item Synchronization with 1SYNC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Sending Business Documents To and From 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Receiving Business documents from 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1SYNC GDSN Item Registry Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1SYNC GDSN Party Registry Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1SYNC Item Authorization Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1SYNC Item Synchronization Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1SYNC New Item Attribute Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2. Installing the webMethods 1SYNC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Installing 1SYNC Module 6.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Upgrading to 1SYNC Module 6.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Uninstalling 1SYNC Module 6.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
3. Configuring webMethods 1SYNC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Step 1: Define webMethods Trading Networks Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Step 2: Define a Trading Partner Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Step 3: Define TN Document Types or IS Publishable Documents . . . . . . . . . . . . . . . . . . . 33
Step 4: Integrate Back-End Applications with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Creating an Outbound Mapping Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Creating an Inbound Mapping Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 3

Step 5: Define a Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1SYNC Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1SYNC Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Step 6: Set Up the EDIINT Interaction with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4. Defining Trading Partner Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . 37

What Is a Trading Partner and Trading Partner Profile? . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Information that You Supply in a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
External ID Type Field in a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Defining the Profile for Your Corporation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Defining a Profile for 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
5. Defining a Trading Partner Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

What Is a Trading Partner Agreement? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Defining a Trading Partner Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Parameter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
6. Defining TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

What Are TN Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Defining TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
TN Document Types that Software AG Provides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
TN Document Type for 1SYNC XSD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Extracting Information from Business Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Queries that Trading Networks Uses to Extract Attributes from Business Documents . . . . 55
Defining the UserStatus Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
7. Setting Up EDIINT Interaction with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Using EDIINT AS2 with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Overview of 1SYNC EDIINT Integration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Setting up EDIINT Interaction with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
8. webMethods 1SYNC Module Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Summary of Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
wm.ip.sync.services:sendRequests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
wm.ip.sync.services:sendConfirmationDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
wm.ip.sync.services:sendSubscriptionDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
wm.ip.sync.services:sendRFCINDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
wm.ip.sync.services:sendCatalogueRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Wm1SYNC Documents Package Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

About this Guide
This guide is for users who want to use 1SYNC Module for setup (of partners,
organization, users, subscription, and market group), and item synchronization in
compliance with 1SYNC Module XML.
This guide describes how to implement and use the webMethods 1SYNC Module to
accomplish the above tasks. To use this guide effectively, you should:
Be familiar with webMethods Integration Server, Integration Server Administrator,
and webMethods Developer and understand the concepts and procedures described
in the Integration Server administration guide and the Developer users guide.
Be familiar with webMethods Trading Networks and understand the concepts and
procedures described in the various webMethods Trading Networks guides.
Be familiar with webMethods EDIINT Module and understand the concepts and
procedures described in the webMethods EDIINT Module documentation.
Have a basic knowledge of 1SYNC Module and 1SYNC Module terminology.
Be familiar with EDIINT AS2 transport protocols.
Have attended training for SYNCpoint, 1SYNC Modules Web browser user
interface that provides your enterprise with the ability to synchronize EAN. 1SYNC
Module item information with other suppliers/retailers as well as have access to
compliant business applications and services.
Deprecation of webMethods Developer

webMethods Developer is deprecated and does not support all the features of
webMethods Integration Server 8.2. Software AG recommends the use of Software AG
Designer for service development.
Document Titles
Some webMethods document titles have changed during product releases. The following
table will help you locate the correct document for a release on the Software AG
Documentation Web site or the Empower Product Support Web site.
8.0 9.0 and

Documentation 7.x 8.0 SP1 8.2 later
Designer Process Development online help
webMethods BPM Process Development Help x x

About this Guide
8.0 9.0 and

webMethods Designer BPM Process Development x x
Help
webMethods Designer Process Development Help x
Designer Service Development online help
webMethods Service Development Help x x
webMethods Designer Service Development Help x x x
Developer users guide
Developing Integration Solutions: webMethods x x
Developer Users Guide
webMethods Developer Users Guide x x
Integration Server administration guide
webMethods Integration Server Administrators x x x
Guide
Administering webMethods Integration Server x x
Integration Server built-in services reference guide
webMethods Integration Server Built-In Services x x x x x
Reference
Integration Server clustering guide
webMethods Integration Server Clustering Guide x x x x x
Integration Server publish-subscribe developers guide
Publish-Subscribe Developers Guide x x x x x
My webMethods administration guide
Administering My webMethods Server x x x
My webMethods Server Administrators Guide x x
Optimize administration guide
Administering webMethods Optimize x x x
webMethods Optimize Administrators Guide x x
Optimize users guide
webMethods Optimize Users Guide x x x
Optimizing BPM and System Resources with x x
BAM: webMethods Optimize Users Guide
Process Engine administration guide

About this Guide
8.0 9.0 and

Administering webMethods Process Engine x x x x
webMethods Process Engine Users Guide x
Trading Networks administration guide
webMethods Trading Networks Administrators x x x
Guide
Building B2B Integrations: webMethods Trading x x
Networks Administrators Guide
Trading Networks built-in services reference guide
webMethods Trading Networks Built-In Services x x x x x
Reference
Trading Networks concepts guide
webMethods Trading Networks Administrators x
Guide and webMethods Trading Networks Users
Guide
Understanding webMethods B2B: webMethods x x
Trading Networks Concepts Guide
webMethods Trading Networks Concepts Guide x x
Trading Networks users guide
webMethods Trading Networks Users Guide x x x
Managing B2B Integrations: webMethods Trading x x
Networks Users Guide
webMethods installation guide
Installing webMethods Products and Using the x x
Software AG Installer
Software AG Installation Guide x
webMethods Installation Guide x x
webMethods logging guide
webMethods Audit Logging Guide x x x
webMethods Audit Guide x x
webMethods upgrade guide
Upgrading webMethods Products x x
webMethods Upgrade Guide x x x

About this Guide
Document Conventions
Convention Description
Bold Identifies elements on a screen.
Narrowfont Identifies storage locations for services on webMethods Integration
Server, using the convention folder.subfolder:service.
UPPERCASE Identifies keyboard keys. Keys you must press simultaneously are
joined with a plus sign (+).
Italic Identifies variables for which you must supply values specific to
your own situation or environment. Identifies new terms the first
time they occur in the text.
Monospace font Identifies text you must type or messages displayed by the system.
{} Indicates a set of choices from which you must choose one. Type
only the information inside the curly braces. Do not type the { }
symbols.
| Separates two mutually exclusive choices in a syntax line. Type one
of these choices. Do not type the | symbol.
[] Indicates one or more options. Type only the information inside the
square brackets. Do not type the [ ] symbols.
... Indicates that you can type multiple options of the same type. Type
only the information. Do not type the ellipsis (...).
Documentation Installation
You can download the product documentation using the Software AG Installer.
Depending on the release of the webMethods product suite, the location of the
downloaded documentation will be as shown in the table below.
For webMethods... The documentation is downloaded to...

8.x and 9.x A central directory named _documentation in the main
installation directory (Software AG by default).
7.x A central directory named _documentation in the main
installation directory (webMethods by default).
6.x The installation directory of each product.
Online Information
You can find additional information about Software AG products at the locations listed
below.

About this Guide
If you want to... Go to...

Access the latest version of product Software AG Documentation website
documentation.
http://documentation.softwareag.com
Find information about product releases and Empower Product Support website
tools that you can use to resolve problems.
https://empower.softwareag.com
See the Knowledge Center to:
Read technical articles and papers.
Download fixes and service packs.
Learn about critical alerts.
See the Products area to:
Download products.
Download certified samples.
Get information about product
availability.
Access older versions of product
documentation.
Submit feature/enhancement requests.
Access additional articles, demos, and Software AG Developer Community for
tutorials. webMethods
Obtain technical information, useful http://communities.softwareag.com/
resources, and online discussion forums,
moderated by Software AG professionals,
to help you do more with Software AG
technology.
Use the online discussion forums to
exchange best practices and chat with
other experts.
Expand your knowledge about product
documentation, code samples, articles,
online seminars, and tutorials.
Link to external websites that discuss
open standards and many web
technology topics.
See how other customers are streamlining
their operations with technology from
Software AG.

About this Guide

1 Concepts
What Is 1SYNC? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
What Is webMethods 1SYNC Module? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1SYNC Module Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1SYNC Module Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Design-Time Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Run-Time Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
The 1SYNC Item Synchronization Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Item Synchronization with 1SYNC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1 Concepts
What Is 1SYNC?
1SYNC is a global trading exchange that provides item subscription, publication, and
synchronization services to trading partners within the Consumer Goods and Retail
industry. Trading partners can be retailers or distributors.
The 1SYNC Data Pool provides advanced functionality and the ability for trading
partners to synchronize product and company data globally. The 1SYNC Data Pool is
Global Data Synchronization Network (GDSN)-certified and adheres to the GS1 system
standards.
The GDSN comprises a single registry managed by GS1 (GS1 Global Registry), Source
Data Pools where item data resides, and Recipient Data Pools where item data is sent and
subscriptions are stored. 1SYNC is both a Source Data Pool and a Recipient Data Pool.
What Is webMethods 1SYNC Module?

webMethods 1SYNC Module works in conjunction with the webMethods product suite
to enable supply-side users (in this guide, referred to as suppliers) and demand-side
users (in this guide, referred to as retailers) to perform comprehensive product
synchronizations via machine-to-machine XML integrations.
webMethods 1SYNC Module supports all XML messages (in this guide, referred to as
business documents) defined in 1SYNC XSD specifications. You use the XML business
documents for partner, organization, user, subscription, and item synchronization. Using
1SYNC Module, you can more easily perform item registration, item notification, item
maintenance, item publications, item authorizations, and worklist retrievals.
1SYNC Module Features

1SYNC Module, which runs on top of Integration Server, provides the following
features:
Out-of-the-box support for 1SYNC XML-based transactions, which allows you to quickly
automate supplier-side and retailer-side functionality with 1SYNC.
Support for the following 1SYNC inbound and outbound message actions:
For Retailers:
Catalogue Item Notification (1SYNC CIN)
Catalogue Item Subscription (1SYNC CIS)
Catalogue Item Confirmation (1SYNC CIC)
Request For Catalogue Item Notification (1SYNC RFCIN)
Catalogue Item Notification Response (1SYNC CINR)
Catalogue Item Subscription Response (1SYNC CISR)

1 Concepts
Catalogue Item Confirmation Response (1SYNC CICR)

Request For Catalogue Item Notification Response (1SYNC RFCINR)
For Suppliers:
1SYNC Catalogue Request (Item, Link, Publication)
1SYNC Catalogue Response (Item, Link, Publication)
1SYNC GDSN Item Registry Response
1SYNC GDSN Party Registry Response
1SYNC Item Authorization Response
1SYNC Item Synchronization Response
1SYNC New Item Attribute Response
Provides support for EDIINT. 1SYNC Module enables you to communicate with 1SYNC
through open standards (EDIINT Applicability Statement 2) for more secure
connections.
Persistent message storage. All inbound and outbound messages processed with
1SYNC Module are maintained in persistent storage using webMethods Trading
Networks.
Provides enhanced 1SYNC response message processing, which will flag message and
document exceptions received from 1SYNC.
1SYNC Module Packages

1SYNC Module contains several packages (sets of webMethods services and related
files) that you install on Integration Server. You manage these packages like you manage
any other package on Integration Server. For information about managing packages, see
the Integration Server administration guide for your release. The following table
describes the contents of each package.
Package Description
Wm1SYNC Contains the core components for enveloping and
packaging 1SYNC commands, records based on the
XMLs, schemas for validation, and initialization services.
For detailed information about the contents of this
package, see webMethods 1SYNC Module Services on
page 65.
Wm1SYNCDocuments Contains the records and schemas for each of the
BizDocTypes available for 1SYNC. For detailed
information about the contents of this package, see
webMethods 1SYNC Module Services on page 65.

1 Concepts
Design-Time Architecture and Components

The following figure illustrates the 1SYNC design-time architecture and components,
and the component relationships. For further explanation, see the table that follows the
figure.
Component Description
webMethods The webMethods Integration Server contains the documents,
Integration Server services, and IS document types that you will want to access
when creating your process models. For more information about
the Integration Server, see the Integration Server administration
guide for your release. See About this Guide for specific
document titles.
webMethods webMethods 1SYNC Module contains services that can be
1SYNC Module invoked from a process model, which will validate and send
business documents to 1SYNC.

1 Concepts
webMethods Trading Networks enables your enterprise to link with whom
Trading you want to exchange business documents using 1SYNC,
Networks(TN) thereby forming a business-to-business trading network. During
design time, you define your trading partner profiles in the
Trading Networks Console. The profiles contain the information
that Trading Networks needs to exchange business documents
between you and 1SYNC.
In addition to defining profiles for your enterprise and for
1SYNC during design time, you also can define your own
trading partner agreements (TPAs) in the Trading Networks
Console.
You also can view the TN XML document types that are
provided with the 1SYNC.
The TPAs and TN XML document types (request, response, and
notification) are created in Trading Networks when you install
the 1SYNC.
For more information about Trading Networks, trading partner
profiles, TN XML document types, and TPAs, see the Trading
Networks administration guide for your release. See About this
Guide for specific document titles. You also can find
information about trading partner profiles in Defining Trading
Partner Profiles in Trading Networks on page 37 and
information about TPAs in Defining a Trading Partner
Agreement on page 47.
Trading Networks Trading Networks saves trading partner profile, TN document
Database types, and TPA information, among other things, to its database
and retrieves this information when needed.
Run-Time Architecture and Components

The following figure illustrates the 1SYNC run-time architecture and components, and
the component relationships. For further explanation, see the table that follows the
figure.

1 Concepts
webMethods 1SYNC Module is installed and runs on Integration Server.
Integration Server Integration Server contains the run-time elements that are
generated from the automated controlled steps within the
process model. The run-time elements are services, triggers, and
process run-time scripts, or fragments.
For more information about Integration Server, see the
Integration Server administration guide for your release. See
About this Guide for specific document titles.
webMethods During run time, 1SYNC Module receives a business document
1SYNC Module from a back-end system or trading partner. It invokes a Trading
Networks service to recognize the business document, create a
BizDocEnvelope and ConversationID, and save the
BizDocEnvelope to the Trading Networks database.

1 Concepts
webMethods Trading Networks enables your enterprise to link with whom
Trading Networks you want to exchange business documents using 1SYNC,
(TN) thereby forming a business-to-business trading network.
During run time, 1SYNC Module uses Trading Networks
services and TN document types to recognize business
documents it receives, create BizDocEnvelopes, and save
BizDocEnvelopes to the Trading Networks database.
1SYNC Module uses the trading partner profiles in Trading
Networks to know, for example, the methods by which to send
business documents to 1SYNC. 1SYNC Module uses TPAs in
Trading Networks to store configuration information, such as
the version of the 1SYNC transaction to use, whether to validate
the outbound 1SYNC business document before sending it to
1SYNC, and so on.
For more information about Trading Networks, trading partner
profiles, TN document types, and TPAs, see the Trading
Networks administration guide for your release. See About this
Guide for specific document titles. You also can find
information about trading partner profiles in Defining Trading
Partner Profiles in Trading Networks on page 37 and
information about TPAs in Defining a Trading Partner
Agreement on page 47.
Trading Networks The Trading Networks Database stores TN document type, TPA,
Database and trading partner profile information, among other things.

1 Concepts
webMethods 1SYNC Module uses webMethods EDIINT Module to
EDIINT Module communicate with the 1SYNC Data Pool using the EDIINT AS2
version of the standard that uses HTTP (or HTTP/S) to transport
documents. EDIINT Module leverages various features of
Trading Networks.
EDIINT Module supports the following EDIINT features:
Provides a mechanism by which to securely exchange
business documents using EDIINT AS2.
Enables business partners to set encryption types and key
lengths at the business-partner level using the extended
fields of the trading partner's Trading Networks profile. The
choices include Triple DES, DES, RC2 (40 bits), RC2 (64 bits),
and RC2 (128 bits).
Provides the standard outbound encryption permutations
(signed, encrypted, signed and encrypted, or plain) at the
send-service level.
Can send receipts of received business documents back to
the sender as well as receive business document receipts.
EDIINT receipts are known as MDNs (message disposition
notifications). EDIINT Module can send and receive
synchronous or asynchronous, signed or unsigned MDNs.
For more information about EDIINT Module, see the
webMethods EDIINT Module Installation and Users Guide. For
information about configuring EDIINT Module for use with
1SYNC, see Setting Up EDIINT Interaction with 1SYNC on
page 59.
The 1SYNC Item Synchronization Process

Item synchronization provides a standardized method for trading partners to publish,
subscribe, and authorize item information, which reduces data discrepancies among
trading partners. Trading partners using 1SYNC store their item information in the
1SYNC Data Pool. The data pool provides storage of item information and can be
thought of as a large database containing all the information about various items from
different trading partners. The seller describes the item in a standardized way (defined
by various standards) and stores the information in the data pool. The retailer browses
the database (data pool) and finds item information which he is interested in. After the
item of interest is found, the trading partners can start another process (not a part of item
synchronization) to do business.

1 Concepts
1SYNC defines the item synchronization process and the standard XML exchanged
between the supplier (the Data Source) and the retailer (the Data Recipient). A simplified
version of the 1SYNC item synchronization process flow is shown below. For a complete
view of the in-network process for 1SYNC IM, see the 1SYNC item management online
user guide, available on the 1SYNC IM Solution Center.
The item synchronization process begins when suppliers register items with 1SYNC.
Suppliers notify retailers of registered items by submitting Catalogue Item Notifications
(CINs) to 1SYNC.
1SYNC pushes the CINs to the retailers, and the retailers use 1SYNC Module to receive
the 1SYNC CINs. Retailers respond to each CIN by submitting a Catalogue Item
Confirmation (CIC), which communicates the type of action taken for the notification.
The item synchronization process ends when suppliers receive their CICs.

1 Concepts
Item Management Message Flow

1SYNC Module facilitates the data recipient 1SYNC item synchronization process by
serving as a bridge between the suppliers and retailers back-end system and the 1SYNC
IM, enabling suppliers and retailers to automate their XML-based transactions with
1SYNC. The detailed message flow between 1SYNC Module users and the 1SYNC IM is
shown below.
Message Flow between Retailer and 1SYNC IM

1 Concepts
Message Flow between Supplier and 1SYNC IM
Item Synchronization with 1SYNC Module

As a supplier or a retailer, your item synchronization process from the perspective of the
1SYNC is that you send request business documents to 1SYNC and receive response
business documents from 1SYNC.
Sending Business Documents To and From 1SYNC

The following figure illustrates your enterprise (acting as a supplier or a retailer) sending
a request business document to and receiving a response business document from
1SYNC. For further explanation, see the table that follows the figure.

1 Concepts
Step Action
1 Your enterprise (acting as a supplier or a retailer) submits an internal request
business document from your back-end system to Integration Server. The
request business document can be a Trading Networks document or an
Integration Server publishable record, with a predefined ConversationID.
2 A custom defined outbound mapping service maps the internal information
to the 1SYNC-specific request document.
3 The mapped request document is sent to wm.ip.sync.services:sendXXDocument
service. The wm.ip.sync.services:sendXXDocument can be any one of the following
services:
wm.ip.sync.services:sendConfirmationDocument
wm.ip.sync.services:sendSubscriptionDocument
wm.ip.sync.services:sendRFCINDocument
wm.ip.sync.services.sendCatalogueRequest
These services in turn invoke the wm.ip.sync.services:sendRequests service.
4 The wm.ip.sync.services:sendRequests service invokes the EDIINT Send service to
post the request business document to 1SYNC.
5 1SYNC receives the 1SYNC request business document.
6 1SYNC responds by sending a response business document to your enterprise
(acting as a supplier or a retailer) by way of 1SYNC.
7 The EDIINT Receive service receives the response business document from
1SYNC and submits the response document to Trading Networks.

1 Concepts
Step Action
8 The response business document triggers a Trading Networks processing
rule, which invokes the wm.ip.sync.rules:processResponse service. This service
retrieves the request referenced by the response business document, copies
the ConversationID from the request to the response business document,
checks for any exception in the response business document, and updates the
user status in Trading Networks.
9 A custom-defined inbound mapping service maps the 1SYNC-related
information to internal information recognizable by your back-end system.
10 Your back-end system receives and processes the internal response business
document.
Receiving Business documents from 1SYNC

The following figure illustrates the process for receiving a business document that
contains notifications from 1SYNC. For further explanation, see the table that follows the
figure.
Step Action
1 A service at 1SYNC pushes the 1SYNC business documents to 1SYNC Module.
In addition to the response corresponding to a request, the following
documents are sent by 1SYNC:
Catalogue Item Notification (1SYNC CIN)
1SYNC GDSN Item Registry Response on page 24
1SYNC GDSN Party Registry Response on page 24
1SYNC Item Authorization Response on page 24
1SYNC Item Synchronization Response on page 25
1SYNC New Item Attribute Response on page 25

1 Concepts
Step Action
2 The documents are recognized as 1SYNC business documents and are saved to
the Trading Networks database.
3 During design time, a processing rule has to be created to process the business
documents and save them to your enterprise back-end.
4 A send service sends the notification to your enterprise back-end system after a
custom-defined inbound mapping service maps the CatalogueItemNotification
to internal information recognizable by your back-end system.
1SYNC GDSN Item Registry Response

The Data Source may receive a GDSN Item Registry Response, if applicable. After an
item has been added or an existing item is modified (wherein GPC code, cancel date, or
discontinued date is updated), IM sends a Registry Catalogue Item (RCI) message to the
Global Registry. On successful receipt of a response from the Global Registry, IM Updates
the item information, generates a GDSN Item Registry Response, and sends the response
to the data source. An entry will also be sent to the Data Source's Worklist. This is a
second response to the item maintenance request and is a response sent in addition to the
Catalogue Response of type item. Since the Global Registry update process is
asynchronous, the RCI process is managed independent of the Item load process of IM.
1SYNC GDSN Party Registry Response

A Data Source may receive a GDSN Party Registry Response, if applicable. After an
organization GLN has been added to IM or existing organization GLN information in IM
is modified, IM sends Party Registration message to the Global Registry. On successful
receipt of a response from the Global Registry, IM updates the organization information,
generates a GDSN Party Registry Response, and sends the response to the data source.
An entry will also be sent to the Data Source's Work list.
1SYNC Item Authorization Response

A Data Source may receive an Item Authorization Response, if applicable. Data Recipient
provides a confirmation state of the item hierarchy (that has been synchronized to them)
in the form of a 1SYNC Catalogue Item Confirmation (1SYNC CIC) sent back to 1SYNC.
An entry will also be sent to the Data Source's Worklist. This state indicates if data
synchronization should continue on the item data or not. The 1SYNC CIC Response
(1SYNC CICR) is translated to the 1SYNC Item authorization Response and sent to the
Data Source. An entry is also sent to the Data Source's worklist.

1 Concepts
1SYNC Item Synchronization Response

A Data Source may receive an ItemSyncResponse, if applicable. Currently,
ItemSyncResponses are generated and sent only if errors occur during item
synchronization. After an item has been published and subscribed to by a data recipient,
if the data fails at 1SYNC due to incorrect/insufficient data for the published GTINs and
their hierarchies or fails Recipient Data Pool CIN validations, an Item Sync Response is
generated and sent to the publisher (data source). An entry is also sent to the Data
Source's Worklist.
1SYNC New Item Attribute Response

The Data Source may receive a 1SYNC New Item Attribute Response, if applicable. This
additional response is generated during the item publication process only if a data
recipient (to which a publication is being sent to) is using IM New Item Attributes and
Review process.

1 Concepts

2 Installing the webMethods 1SYNC Module
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Installing 1SYNC Module 6.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Upgrading to 1SYNC Module 6.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Uninstalling 1SYNC Module 6.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Overview
This chapter explains how to install, upgrade, and uninstall webMethods 1SYNC Module
6.5.2. The instructions use the Software AG Installer and the Software AG Uninstaller
wizards. For complete information about the wizards or other installation methods, or to
install other webMethods products, see the webMethods installation guide for your
release. See About this Guide for specific document titles.
Requirements
For a list of the operating systems and webMethods products required by 1SYNC
Module 6.5.2, see the webMethods eStandards Modules System Requirements.
1SYNC Module 6.5.2 has no hardware requirements beyond those of its host Integration
Server.
Installing 1SYNC Module 6.5.2

The instructions in this section explain how to use the Software AG Installer wizard to
install webMethods 1SYNC Module. For more information, see the webMethods
installation guide for your release. See About this Guide for specific document titles.
To install 1SYNC Module 6.5.2

1 Download the latest Installer from the Empower Product Support website at
https://empower.softwareag.com.
2 If you are installing the module on an existing Integration Server, shut down the
Integration Server.
3 Start the Installer wizard.
Choose the webMethods release that includes the Integration Server on which to
install the module. For example, if you want to install the module on 7.1, choose
the 7.1 release.
If you are installing on an existing Integration Server, specify the webMethods
installation directory that contains the host Integration Server. If you are installing
both the host Integration Server and the module, specify the installation directory
to use. The installer will install the module in the
Integration Server_directory\packages directory.
In the product selection list, select eStandards >webMethods 1SYNC Module 6.5.2 >
Program Files. You can also choose to install documentation, and any required
products indicated in the webMethods eStandards Modules System Requirements.
4 After installation is complete, start the host Integration Server.

5 Go to the Knowledge Center area of the Empower Product Support website and
check for product fixes available for webMethods 1SYNC Module 6.5.2. Download
and install the latest fix.
Upgrading to 1SYNC Module 6.5.2

You can upgrade 1SYNC Module 6.5 to 1SYNC Module 6.5.2. Uninstall 1SYNC Module
6.5 as described in the 1SYNC Module 6.5 documentation. Install 1SYNC Module 6.5.2 as
described in Installing 1SYNC Module 6.5.2 on page 28.
Uninstalling 1SYNC Module 6.5.2

You use the Software AG Uninstaller wizard to uninstall the 1SYNC Module. For
instructions about using the Uninstaller, see the webMethods installation guide for your
To uninstall 1SYNC Module 6.5.2

1 Shut down the Integration Server that hosts 1SYNC Module 6.5.2.
2 Start the Uninstaller, selecting the webMethods installation directory that contains
the host Integration Server. In the product selection list, select eStandards > webMethods
1SYNC Module 6.5.2 > Program Files and any other products and items you want to
uninstall.
3 Restart the host Integration Server.
4 The uninstaller removes all 1SYNC Module 6.5.2-related files that were installed into
the Integration Server_directory\packages directory. However, the uninstaller does not
delete files created after you installed the module (for example, user-created or
configuration files), nor does it delete the module directory structure. You can go to
the Integration Server_directory\packages directory and delete the 1SYNC directory.


3 Configuring webMethods 1SYNC Module
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Step 1: Define webMethods Trading Networks Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Step 2: Define a Trading Partner Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Step 3: Define TN Document Types or IS Publishable Documents . . . . . . . . . . . . . . . . . . . . . . . 33
Step 4: Integrate Back-End Applications with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Step 5: Define a Processing Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Step 6: Set Up the EDIINT Interaction with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Overview
To prepare webMethods 1SYNC Module for item synchronization with 1SYNC, you first
must complete the steps in Before You Begin on page 32 and then the following
configuration steps:
Before You Begin

Before you begin your implementation, you should have completed the following steps.
1 Install Integration Server, Trading Networks, and 1SYNC Module.
When you install 1SYNC Module, the module does the following in Trading
Networks:
Registers an external ID type called GLN (Global Location Number).
A GLN is a 13-digit data structure, or number, that uniquely identifies each
location in a trading partner's enterprise. For example, on the supplier side, a
GLN might uniquely identify the corporate HQ, a regional office, a warehouse, or
a plant. On the retailer side, a GLN might uniquely identify the corporate HQ, a
divisional office, a store, or a distribution center. The following identifies the
structure of a GLN:
All 1SYNC trading partners will use the GLN as the external ID type in Trading
Networks and will need a GLN for 1SYNC service activation.
Creates default TN document types: 1SYNC Request, 1SYNC Response, 1SYNC
CatalogueItemNotification, 1SYNC GDSN Item Registry Response, 1SYNC
GDSN Party Registry Response, 1SYNC Item Synchronization Response, 1SYNC
Item Authorization Response, and 1SYNC New Item Attribute Response.
Adds the User extended field for the 1SYNC group. User is a required field for
1SYNC and is the batch user ID that is used to log on to 1SYNC.
Creates the default Trading Partner Agreement (TPA).
Creates two default processing rules.
2 Register as a 1SYNC Subscriber.
To participate in the 1SYNC community, you first must subscribe to 1SYNC. To
subscribe to 1SYNC, you must complete and submit a 1SYNC application for a
Trading Partner Service Agreement (TPSA) and pay your subscription fee.

To complete a 1SYNC application and to find out about subscription fees, access the
1SYNC Web site at http://1SYNC.org.
Although a GLN is not required to complete a TPSA application, it is required for
service activation. If you do not enter your GLN the first time you submit your
application, you will need to enter it later and resubmit your application for service
activation.
Step 1: Define webMethods Trading Networks Profiles

You define Trading Networks profiles for your enterprise and for 1SYNC, with whom
you want to exchange business documents, in the webMethods Trading Networks
Console. A trading partner profile includes such parameters as the GLN, EDIINT Module
AS2, and the destination URL.
For more information about defining trading partner profiles, see Defining Trading
Partner Profiles in Trading Networks on page 37 in this guide and the Trading Networks
administration guide for your release. See About this Guide for specific document
titles.
Step 2: Define a Trading Partner Agreement

You must define a trading partner agreement (TPA) to exchange business documents
with 1SYNC. You define a TPA in the Trading Networks Console.
For information about how to define a TPA, see Defining a Trading Partner Agreement
on page 47 in this guide and the Trading Networks administration guide for your release.
See About this Guide for specific document titles.
Step 3: Define TN Document Types or IS Publishable

Documents
You must define TN document types or IS publishable documents for internal business
documents that your back-end system sends to the 1SYNC Module. You define TN
document types in Trading Networks Console.
For more information about TN document types, see Defining TN Document Types on
page 51 in this guide and the Trading Networks administration guide for your release.
For more information about IS publishable documents, see the Developer users guide for
your release. See About this Guide for specific document titles.

Step 4: Integrate Back-End Applications with 1SYNC

To integrate your back-end applications with 1SYNC, you must create mapping services,
which consist of two types: outbound and inbound.
Creating an Outbound Mapping Service

You create an outbound mapping service to map back-end data to a request business
document. The service forms the 1SYNC request message by mapping data from the
internal request document that was received from the back-end system to the 1SYNC
request message that is to be sent to 1SYNC. The outbound mapping service should
perform the following actions:
Convert the internal request document from the back-end system to an IData object.
If the internal request document is received from Trading Networks, you must
request the content from Trading Networks, and then convert the content to an IData
object. For more information about how to perform this action, see information about
getting data from an external partner into a business process in Getting Started with
BPM.
If the internal request document is a published IS document, it already will be in the
business process pipeline as an IData object. For more information about getting data
from internal systems into a business process, see Getting Started with BPM.
Map data from the IData object for the internal request document to the 1SYNC
request document.
The 1SYNC Module provides IS document types that define the different 1SYNC
requests.
For example, for a subscription request, you map the internal request document to
the wm.ip.sync.recs:docType_ns_catalogueItemSubscription document.
Creating an Inbound Mapping Service

You create an inbound mapping service to send a response document back to your back-
end system that provides the back-end system with the outcome of its request. The
inbound mapping service should perform the following actions:
Form the internal response document in the format that the back-end system expects.
Send the internal response document to the back-end system.
For more information about mapping services, see the Developer users guide for your

Step 5: Define a Processing Rule

For simple request/response scenarios, Software AG recommends that you use
processing rules to process 1SYNC business documents. If you decide to use processing
rules to process business documents, you must define your own processing rule to
process the notification. For information about defining processing rules, see the Trading
Networks administration guide for your release. See About this Guide for specific
document titles.
When you install the 1SYNC Module, by default two processing rules (1SYNC Request
and 1SYNC Response) are created.
1SYNC Request
1SYNC Request rule is used for resending a request to 1SYNC for processing. This rule
checks if the document is of type 1SYNC Request and the wm.ip.sync.rules:sendMessage flow
service initiates the request.
1SYNC Response
1SYNC Response rule is used to execute an action on a 1SYNC Response document.
When Trading Networks receives a 1SYNC Response document, the
wm.ip.sync.rules:processResponse flow service is triggered to save the response to the Trading
Networks database.
The wm.ip.sync.rules:processNotification service is triggered for Catalogue Item Notification
(1SYNC CIN).
The wm.ip.sync.rules.response:validateResponse service is triggered for the following responses:
1SYNC GDSN Item Registry Response on page 24
1SYNC GDSN Party Registry Response on page 24
1SYNC Item Authorization Response on page 24
1SYNC Item Synchronization Response on page 25
1SYNC New Item Attribute Response on page 25
Step 6: Set Up the EDIINT Interaction with 1SYNC

To set up EDIINT interaction with 1SYNC, you must obtain a digital EDIINT AS2 Interop
supported certificate from a Certificate Authority (CA). 1SYNC supports self-signed
certificates and certificates from Certificate Authorities, VeriSign, and GeoTrust.
After you receive your EDIINT certificate, you should send an e-mail to 1SYNC
Customer Support, requesting a 1SYNC certificate.

After you receive the 1SYNC certificate, you will add the 1SYNC certificate to the Trading
Networks partner profile you defined for 1SYNC. For more information on setting up
EDIINT for use with 1SYNC, see Setting up EDIINT Interaction with 1SYNC on
page 62.

4 Defining Trading Partner Profiles in Trading Networks
What Is a Trading Partner and Trading Partner Profile? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Defining the Profile for Your Corporation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Defining a Profile for 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

What Is a Trading Partner and Trading Partner Profile?

A trading partner is any person or organization with whom you want to conduct business
on your trading network. You define a profile to provide information about a trading
partner.
Using the Trading Networks Console, you will need to define profiles for:
Your Corporation. You create a Trading Networks partner profile known as an Enterprise
profile. You create this profile to identify information about your own corporation.
1SYNC. You create a Trading Networks partner profile to supply information about
1SYNC.
Representing Party (optional). A representing party is an organization that sends or
receives documents on behalf of your corporation. For example, your corporation
might have an agent or service provider that represents it. A representing party might
also be a child organization, in instances where a parent organization acts on behalf of
the child. You create a profile for a representing party the same as you create a profile
for your corporation.
Information that You Supply in a Profile

Trading Networks provides a set of standard fields in a profile that you use to supply
information about a trading partner, including the corporation name and identifying
information, contact information, and preferred delivery methods.
In addition, Trading Networks allows profiles to be extended to include additional fields.
The following extended profile fields are automatically added to profiles:
User field. The 1SYNC Module adds the extended profile field User to your corporation
profile. This field contains the batch user ID that the 1SYNC Module uses to send
documents to the 1SYNC Data Pool. You obtain the value for this batch user ID from
1SYNC.
AS2MDNURL field. The WmEDIINT package of webMethods EDIINT Module adds the
extended profile field AS2MDNURL to the 1SYNC profile. The value for this field
should be the URL to which 1SYNC is to send asynchronous MDNs. You may leave
this field blank if do not want to request asynchronous MDNs.
External ID Type Field in a Profile

A standard field in the profile is the external ID type. The external ID type defines how
Trading Networks identifies a corporation within a message or document. That is,
Trading Networks uses the external ID within a document to determine the document's
sender and receiver. For example, a corporation that sends a document might place its D-
U-N-S number within the field of the document that represents the sender.

Trading Networks provides several external ID types (for example, DUNS for a D-U-N-S
number). In addition, 1SYNC Module provides the following external ID types that you
must include in your profiles:
GLN for the Global Location Number (GLN)
EDIINT AS2 for the AS2 Routing ID used when communicating with 1SYNC via
EDIINT AS2
Defining the Profile for Your Corporation

To define a profile for your corporation, you use the Trading Networks Console to define
a partner profile known as an Enterprise profile. The console provides a Profile Assistant
wizard that takes you step-by-step through the process of creating your profile.
Important! After defining the Enterprise profile, you must enable it in Trading Networks.
The following table lists the minimum information that you must supply in the profile.
For complete instructions for creating an Enterprise profile, see the chapter on building
your enterprise profile in the Trading Networks administration guide for your release.
Tab Field or Sub-Tab Description

Corporate Corporation Name The name of your corporation, for
example, "Industrial Steel Company".
Partner Type The type of software that you use to
interact with 1SYNC. Specify webMethods
Trading Networks.


External ID Type and Specify values for the following external
Value ID types:
GLN -The Global Location Number for
your corporation.
EDIINT AS2 - The type of identification
you use for EDIINT AS2 messages,
(for example, your GLN or D-U-N-S
number). This value should
correspond to the values in the 'AS2-
To:' and 'AS2-From:' fields in the
header of the EDIINT messages.
Typically, EDIINT AS2 and GLN are
the same.
Required external ID type - By
default, the required external ID is
DUNS. Trading Networks uses the
required external ID type to create an
user account. You can accept the
default DUNS and enter any value for
it; the value is not used for 1SYNC
transactions.
Delivery Method Protocol The delivery method protocol that
Trading Networks should use when
delivering documents. Select Primary HTTP.
Host The host name or IP address of your
system. Specify the host name or IP
address for your Integration Server.
Port The port number on which your system
listens for incoming requests. Specify the
port number on which your Integration
Server listens for incoming requests.
Location The location a partner is to use when
sending a document to your system.
Specify the following URL:
/invoke/wm.tn/receive
Use as Preferred Select this check box to specify that you

Protocol prefer partners to use the delivery
method protocol that you specified in the
Protocol field (i.e., Primary HTTP) to deliver
documents to your 1SYNC Module
system.


Extended Fields Group 1SYNC 1SYNC Module added the extended field
group 1SYNC to the profile. This group
contains the User extended profile field.
View this field by selecting the group
name from the Group column; the field is
displayed on the right. The value for the
field must be the batch user ID that
1SYNC supplied to your corporation for
sending and viewing data in the 1SYNC
Data Pool.


Security Sign/Verify and Use the Sign/Verify sub-tab to specify
Decrypt/Encrypt sub- certificate information that Trading
tabs Networks uses to digitally sign
documents that your Enterprise sends to
partners. Trading Networks digitally
signs a document when the built-in
service wm.tn.doc:sign is invoked. For more
information on this service, see the
Trading Networks built-in services
reference guide for your release. See
About this Guide for specific document
titles.
Use the Decrypt/Encrypt sub-tab to specify
certificate information that Trading
Networks uses to decrypt documents that
your Enterprise receives from partners.
Specify information for the following
fields on both the Sign/Verify and
Decrypt/Encrypt sub-tabs:
Cetificate Chain - The digital certificate
that you want Trading Networks to
use to digitally sign or decrypt
documents when a partner's profile
does not contain a signing or
decrypting certificate. Trading
Networks displays the value of the CN
(Common Name) field from the
Subject defined by the certificate.
Private Key - The private key that is
associated with the digital certificate
that you specified in the Certificate
Chain field. Trading Networks uses the
private key to process Sign and Decrypt
certificates.
For more information about these sub-
tabs, see the chapter on building your
enterprise profile in the Trading
Networks administration guide for your
release. See About this Guide for
specific document titles.

Defining a Profile for 1SYNC

To define a profile to supply information about 1SYNC, you define a partner profile using
the Trading Networks Console. You cannot create a partner profile until after you have
created the Enterprise profile for your corporation (as described in Defining the Profile
for Your Corporation on page 39).
Important! After defining a partner profile, you must enable it in Trading Networks.
The following table lists the minimum information that you must supply in the profile.
For complete instructions for creating a partner profile, see the chapter on partner
profiles in the Trading Networks administration guide for your release. See About this
Guide for specific document titles.
Tabs Field or Sub-Tab Description

Corporate Corporation Name Specify 1SYNC.
Partner Type Specify Other/Unknown.
External ID Type and Specify values for the following external
Value ID types:
GLN -Specify 8380160030003, which is
1SYNC's Global Location Number.
For pre-production, specify
8380160030003.
For production, specify
8380160030001.
EDIINT AS2 - The type of identification
that 1SYNC uses for EDIINT AS2
messages, (for example, your GLN or
D-U-N-S number). This value should
correspond to the values in the 'AS2-
To:' and 'AS2-From:' fields in the
header of the EDIINT messages.
Typically, EDIINT AS2 and GLN are
the same.
Required external ID type - By
default, the required external ID is
DUNS. Trading Networks uses the
required external ID type to create an
Integration Server user account. You
can accept the default DUNS and enter
any value for it; the value is not used
for 1SYNC transactions.


Delivery Method Protocol The delivery method protocol that
Trading Networks should use when
delivering documents. Specify Primary
HTTP.
Host 1SYNC's IP address.
transhub.preprod.transora.com

transhub.transora.com
For a listing of alternative 1SYNC IP

addresses, see 1SYNC's Connectivity
Guide.
Port The port number on which 1SYNC listens
for incoming requests.
For HTTP, specify 4080
For HTTPS, specify 1443
Location Specify the following URL:
/exchange/8380160030003

/exchange/0838016003001
Use as Preferred Select this check box to specify that you

Protocol prefer partners to use the delivery
method protocol that you specified in the
Protocol field (i.e., Primary HTTP) to deliver
documents to your 1SYNC Module
system.


Extended Fields Group EDIINT The WmEDIINT package of webMethods
EDIINT Module adds the extended field
group EDIINT. This group contains the
AS2MDNURL extended profile field.
View this field by selecting the group
name from the Group column; the field is
displayed on the right. The value for the
field must be the URL to which 1SYNC is
to send asynchronous MDNs.
The format of the URL is typically
http://userID:password@host:port/invo
ke/wm.EDIINT/receive, where:
userID is the user name for the user

account that Trading Networks generates
when you create the 1SYNC profile.
password is the password that Trading
Networks generates when you create the
profile.
host is the host name or IP address for
your Integration Server.
port is the port number on which your
Integration Server listens for incoming
requests.
Note: You can leave this field blank if you

do not want to request asynchronous
MDNs.


Security Sign/Verify and Use the Sign/Verify sub-tab to specify
Decrypt/Encrypt sub- certificate information that Trading
tabs Networks uses to verify the digital
signature of documents that were
digitally signed by this partner. T verifies
a digital signature when instructed to do
so by the Trading Networks pre-
processing action Verify Digital Signature.
Use the Decrypt/Encrypt sub-tab to specify
certificate information that can be used to
encrypt information that is being sent to a
partner.
On both sub-tabs, provide values for the
Certificate Chain field as follows.
The partner's digital certificate that you
want Trading Networks to use to verify
digital signatures and to encrypt
documents. Trading Networks displays
the value of the CN (Common Name) field
from the Subject defined by the certificate.
For more information about these sub-
tabs, see the chapter on partner profiles in
the Trading Networks administration
guide for your release. See About this

5 Defining a Trading Partner Agreement
What Is a Trading Partner Agreement? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Defining a Trading Partner Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Parameter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

What Is a Trading Partner Agreement?

A Trading Partner Agreement (TPA) is a set of parameters that you can use to govern how
business documents are exchanged between your enterprise and 1SYNC. A TPA contains
transaction-dependent information, such as the transport protocol to use to conduct
transactions, whether to validate an outbound business document before sending it to
1SYNC, and so on. A TPA augments Trading Networks profiles and offers a flexible way
to process and manage transactions between your enterprise and 1SYNC.
You must define a TPA with 1SYNC to exchange business documents with 1SYNC. If you
do not define a TPA for document exchange with 1SYNC, the 1SYNC Module will use the
default TPA, which was created in Trading Networks when you installed the 1SYNC
Module, to govern transactions with 1SYNC.
Every TPA is uniquely identified by a sender ID, a receiver ID, and an agreement ID. It is
not the individual attribute that must be unique but the combination of attributes that
must be unique. For example, you can have two TPAs with the same sender ID and
receiver ID but a different agreement ID.
For more information about TPAs, see the Trading Networks administration guidefor
your release. See About this Guide for specific document titles.
Defining a Trading Partner Agreement

To define a TPA to govern document exchange between your enterprise and 1SYNC, you
can duplicate the default TPA and modify the default TPA attributes and parameters.
Note: If you are going to have only one 1SYNC user account conducting transactions with
1SYNC, you could simply customize the default TPA. However, Software AG
recommends that you do not do this. It is a good business practice to keep the default
TPA as a back-up and only use the default TPA as a template, regardless of the number of
users who require their own distinct way of conducting transactions with 1SYNC.
To define a Trading Partner Agreement

1 Start the Trading Networks Console.
2 On the View menu, click Agreements. The Agreements screen appears.
3 Select the Default-1SYNC-TPA, and on the Agreements menu, and click Duplicate. The
Agreement Details screen appears.
4 At the top of the screen, modify the TPA attributes as indicated in the following table.
Field Description 1SYNC-Specific Usage Note

Sender The name of the trading partner Select your enterprise
that has the sender role in the name from the Sender list.
TPA, that is, your enterprise.

Field Description 1SYNC-Specific Usage Note

Receiver The name of the trading partner Select the 1SYNC profile
that has the receiver role in the name from the Receiver
TPA, that is, 1SYNC. list.
Agreement ID An application-specific field The Agreement ID can be
that uniquely identifies the type any value.
of agreement between two
partners.
IS Document Type The You can find the
wm.ip.sync.common.rec:TPADataSche wm.ip.sync.common.rec:TPADa
ma IS document type that taSchema IS document type
specifies the data, or the in the Wm1SYNC
parameters, that you define in package.
the TPA. You must use the fully
qualified name of this IS
document type.
Data Status This field applies only when the You must set the data
Agreement Status is "Agreed". The status to Non-modifiable
data status indicates whether because none of the data
you can update the values for should be changed during
the TPA parameters defined in run time.
the IS document type (located in
the panel on the lower portion
of the Agreement Details
screen).
5 On the right side of the Agreement Details screen, click Set Inputs. The Input for
wm.ip.sync.common.rec:TPADataSchema' screen appears.
6 Modify the default TPA parameters, as necessary.
For a list of the TPA parameters and the valid values for individual parameters, see
the next section, Parameter Settings on page 49.
Parameter Settings
The TPA data structure that 1SYNC Module uses is defined by the following data
schema: wm.ip.sync.common.rec:TPADataSchema. The following table lists the TPA parameter
settings contained in this schema.
TPA Section Parameter Description

ValidateOutput Indicates whether the outbound
1SYNC business document should be
validated before being sent to
1SYNC. Valid values: Yes or No.

TPA Section Parameter Description

SchemaInformation SchemaName Schema location and name against
which the 1SYNC document needs to
be validated before sending it to the
1SYNC. For example,
wm.ip.sync.schemas:schema_envelop
e.
RecordName Record location and name against

which the 1SYNC document needs to
be validated before sending it to the
1SYNC Test Registry. For example,
wm.ip.sync.recs:envelope.
SchemaLocation The location of the schema for the

XSD version being used to construct
the 1SYNC envelope.
EDIINT Parameters MessageType The SMIME type being used for
EDIINT. Valid values: encrypted,
signed, encryptedAndSigned, and
plain.
RequestMDN The MDN type being used. Valid

values: None, synchronousMDN, and
asynchronousMDN.
RequestSignedReceipt Whether a signed receipt is

requested. Valid values: Yes and No.
ResponseProcessing ProcessResponse Indicates whether the 1SYNC
Response should be verified for any
document exception or message
exception. Valid values: true and
false.

6 Defining TN Document Types
What Are TN Document Types? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Defining TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
TN Document Types that Software AG Provides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Extracting Information from Business Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Queries that Trading Networks Uses to Extract Attributes from Business Documents . . . . . . . . 55
Defining the UserStatus Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

What Are TN Document Types?

TN document types are definitions that tell Trading Networks how to identify a type of
business document, specify the attributes that Trading Networks is to extract from the
business document, and specify options for pre-processing the business document.
When the webMethods 1SYNC Module receives a business document from a back-end
system, it invokes a Trading Networks service to recognize the type of business
document by using the TN document types that you define. The TN document types
received from the back-end system can be either TN flat file document types or TN XML
document types.
Note: Trading Networks also can receive an Integration Server publishable document
from a back-end system. For more information, see the Integration Server administration
guide for your release. See About this Guide for specific document titles.
During outbound mapping, regardless of which TN document type that the outbound
business document is, 1SYNC Module converts the business document to a TN XML
document type, which is the type of business document that the 1SYNC Module sends
and receives from 1SYNC.
1SYNC Module sends a Request TN XML document type to 1SYNC. The 1SYNC Module
can receive either a Response TN XML document type or a CatalogItemNotification TN
XML document type from 1SYNC. These TN SML doucment types are created in Trading
Networks when you install 1SYNC Module.
When Trading Networks recognizes the TN docment type of a business document,
Trading Networks extracts specific pieces of information from the business document,
based on the document attributes specified in the TN document type, and performs pre-
processing actions against the business document. The pre-processing actions indicate
whether Trading Networks is to verify the document's digital signature, validate the
structure of the document, determine whether the document has been received before,
and/or save the document to the Trading Networks database. For more information
about TN document types, see the Trading Networks administration guide for your
This chapter provides the following information about TN document types:
Provides information about defining your own TN document types
Describes the TN XML document types that Software AG provides
Provides the information extracted from TN document types
Provides the XML queries used to extract attributes from a business document
Provides the valid values for the UserStatus attribute

Defining TN Document Types

You must define TN document types for business documents that Trading Networks
receives from your back-end system. These TN document types can be either TN flat file
document types or TN XML document types.
Note: When you define your process models, you assign a TN document type (or
Integration Server publishable document) to the first step in the process model.
You define a TN document type using the Trading Networks Console Document Type
Details screen. The following table lists the tabs on that screen and some of the
information you will need to provide to define a TN document type. For the complete
procedure for defining TN document types, see the Trading Networks administration
guide for your release. See About this Guide for specific document titles.
Tab Description
Identify In this tab, you supply information that Trading Networks uses
to identify business documents. For example, for TN XML
document types, you might specify the root tag of business
documents and/or include XQL queries that identify specific
elements that must be present in the business documents. You
also might configure the TN XML doucment type to specify
arbitrary pipeline elements to be used as identifying attributes.
For TN flat file document types, you might specify how Trading
Networks is to recognize a flat file business document on
variables the document gateway service places in the pipeline.
Extract In this tab, you specify the attributes that you want Trading
Networks to extract from business documents and how to locate
the attributes within business documents.
Namespace In this tab, you specify information about the namespaces that
XML business documents might use. Trading Networks uses the
namespace mappings when applying XQL queries against a
business document.
Note: If you are defining TN flat file document types, you do not
use this tab.
Options In this tab, you specify options for pre-processing business

documents. The options enable you to indicate whether you
want Trading Networks to perform any or all of the following
pre-processing actions:

Tab Description
Verify the digital signature of a business document.
Validate the structure of a business document (using the IS
document type that you specify).
Check the uniqueness of a business document, that is,
determine whether Trading Networks has already received
the document.
Save a copy of the document content, attributes, and/or log
information to the Trading Networks database.
TN Document Types that Software AG Provides

When you install 1SYNC Module, default TN document types are created in Trading
Networks for 1SYNC XSD. These are the TN document types of the business documents
that are sent to and from 1SYNC. The following table lists the default TN document types
created for 1SYNC XSD.
TN Document Type for 1SYNC XSD
TN Document Types Description

1 SYNC Request TN XML document type that 1SYNC Module sends to
1SYNC.
1SYNC Response TN XML document type that 1SYNC Module receives
from 1SYNC.
CatalogueItemNotification TN XML document type that 1SYNC Module receives
from 1SYNC.
1SYNC GDSN Item Registry TN XML document type that 1SYNC Module receives
Response from 1SYNC.
1SYNC GDSN Party Registry TN XML document type that 1SYNC Module receives
1SYNC Item Authorization TN XML document type that 1SYNC Module receives
1SYNC Item Synchronization TN XML document type that 1SYNC Module receives
1SYNC New Item Attribute TN XML document type that 1SYNC Module receives

Extracting Information from Business Documents

The following attributes identify the types of information that 1SYNC Module extracts
from business documents based on the type of business document identified by the TN
document type and how Trading Networks uses the information:
SenderID and ReceiverID. Trading Networks uses this information for business
document exchange and for analyzing transactions.
DocumentID. Trading Networks uses this information to identify a particular
document.
ConversationID. This attribute is used as an identifier that links all documents that are
part of the same business process (also called a conversation). All documents in the
same business process must have the same ConversationID. Trading Networks uses
this information to pass documents to the webMethods Process Run Time (PRT), if
you choose to create your own process model. For more information about process
models, see the Designer Process Development online help for your release. See
About this Guide for specific document titles.
UserStatus. User status is user defined. Trading Networks uses this information as a
criterion to determine the processing rule to use for a business document. For more
information about processing rules, see the Trading Networks administration guide
for your release. See About this Guide for specific document titles.
GroupID. GroupID is a user-defined field that enables Trading Networks to identify a
document by a particular group.
Queries that Trading Networks Uses to Extract Attributes

from Business Documents
The following table lists the queries that Trading Networks uses to extract attributes from
business documents based on a document's TN XML document type.
Attribute Query to Retrieve the Attribute

1SYNC Request SenderID /*:envelope[0]/header[0]/sender[0]
ReceiverID /*:envelope[0]/header[0]/receiver[0]
DocumentID /*:envelope[0]/header[0]/messageId[0]
ConversationID A unique user-defined ID. There is no
query to extract the ConversationID.
GroupID The GroupID is the TPA AgreementID.
There is no query to extract the GroupID.
1SYNC Response SenderID /*:envelope[0]/header[0]/sender[0]

Attribute Query to Retrieve the Attribute

ConversationID A unique user-defined ID. There is no
query to extract the ConversationID.
GroupID /*:envelope[0]/*/header[0]/originatingMes
sageId[0]
1SYNC SenderID /*:envelope[0]/header[0]/sender[0]
CatalogItemNotification
1SYNC GDSN Item SenderID /*:envelope[0]/header[0]/sender[0]
Registry Response
1SYNC GDSN Party SenderID /*:envelope[0]/header[0]/sender[0]
Registry Response
1SYNC Item SenderID /*:envelope[0]/header[0]/sender[0]
Authorization Response
1SYNC Item SenderID /*:envelope[0]/header[0]/sender[0]
Synchronization
Response
1SYNC New Item SenderID /*:envelope[0]/header[0]/sender[0]
Attribute Response
Defining the UserStatus Attribute

The following table lists the valid values for the UserStatus attribute of the TN XML
document types included in 1SYNC.

User Status Value Description

1SYNC Request SendMessage:EDIINT A request business document has been sent
using EDIINT as the transport protocol, but
a response business document has not been
received from 1SYNC.
SendMessage A bizdoc was created and persisted in the
Trading Networks Server, but a request
business document was not sent.
SendMessage:ERROR An error was encountered when sending
the request business document. The request
business document might not have been
sent.
SendMessage:DONE A response business document has been
received.
1SYNC Response TRANSACTION_FALSE: 1SYNC rejected the request business
MESSAGE_EXCEPTION document. This usually occurs because of
an ill-formed XML document.
TRANSACTION_FALSE: 1SYNC accepted the request business
DOCUMENT_EXCEPTION document but failed to process one or more
documents correctly.
TRANSACTION_TRUE 1SYNC processed the request business
document correctly.


7 Setting Up EDIINT Interaction with 1SYNC
Using EDIINT AS2 with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Overview of 1SYNC EDIINT Integration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Setting up EDIINT Interaction with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Using EDIINT AS2 with 1SYNC

EDIINT AS2 is an XML document transport protocol that uses HTTP to build a tunnel to
the recipient address, establishes the connection, and then sends the information with a
signed payload, assuring the sender of receipt.
In nominal operating mode, the EDIINT client can expect to receive two messages from
1SYNC in response to each business document sent:
An MDN (Message Disposition Notification), which indicates the 1SYNC EDIINT
hub received the request business document
A 1SYNC Response (which is a TN XML document type), which indicates the 1SYNC
application has processed the business document on the back-end.
Note: An MDN is a receipt document that provides the sender with a guarantee that
the intended recipient received the business document. MDNs are not XML but are
multipart MIME documents.
Before you can use EDIINT AS2 as a transport protocol, you must first set up EDIINT to
interact with 1SYNC. This chapter provides procedures for doing this as well as
illustrates the 1SYNC EDIINT workflow. The latter is discussed in the following section.
Important! If Integration Server is inside a firewall, you must configure this Integration
Server as an Enterprise Gateway Server. For information about how to configure
Integration Server as an Enterprise Gateway Server, see the Integration Server
administration guide for your release. See About this Guide for specific document
titles.
Overview of 1SYNC EDIINT Integration Process

The following figure illustrates the 1SYNC EDIINT integration process. For further
explanation, see the table that follows the figure.

1SYNC EDIINT integration process
Step Action
1 Your back-end enterprise sends a request business document to Integration
Server.
2 Your Integration Server encrypts and sends an encrypted request business
document to 1SYNC. The document is transmitted securely to the 1SYNC
EDIINT transport hub.
3 The 1SYNC EDIINT transport hub decrypts the payload and determines the
originator and recipient of the message.
4 The 1SYNC EDIINT transport hub acknowledges the request business
document by sending an MDN to your Integration Server.
5 The 1SYNC EDIINT transport hub routes the decrypted request business
document to the 1SYNC application server on the back end.
6 The back-end system processes the request business document and sends a
response business document to the 1SYNC EDIINT transport hub.
7 The 1SYNC EDIINT transport hub encrypts the payload and routes the
encrypted response business document to your Integration Server.
8 Your Integration Server acknowledges the response business document by
sending an MDN to the 1SYNC EDIINT transport hub.
9 Your Integration Server decrypts the payload, processes, and routes the
response business document to your back-end application.

Setting up EDIINT Interaction with 1SYNC

Before you can set up EDIINT interaction with 1SYNC, you must obtain a digital EDIINT
AS2 Interop-supported certificate from a Certificate Authority (CA). 1SYNC supports
self-signed certificates and certificates from Certificate Authorities, VeriSign, and
GeoTrust. For more information about certificates and how to obtain them, see the
Integration Server administration guide for your release. See About this Guide for
specific document titles.
Important! You must use an EDIINT AS2 Interop-supported certificate. For more
information about certificates supported by 1SYNC, go to their Web site at
http://www.1SYNC.org/.
To set up EDIINT interaction with 1SYNC

1 Request a 1SYNC certificate by sending an e-mail to 1SYNC Customer Support. In the
e-mail, provide the following information:
Your enterprise, or trading partner, name.
Your trading partner global location number (GLN) associated with the AS2
connection.
Your complete external IP address (for example, http://<ip
address>/invoke/wm.EDIINT/receive)
The name and version of the EDIINT AS2 software client you are using to connect
to 1SYNC. For example, webMethods 1SYNC Module 6.x.
A zip file containing the public certificate for your enterprise.
Important! Do not send your private key to 1SYNC. Send only your public
certificate.
2 Add the certificate that you receive from 1SYNC to the Trading Networks partner
profile you defined for 1SYNC, as follows:
a Open the 1SYNC profile in the Trading Networks Console.
b Click the Security tab and then the Encrypt tab.
c Click Edit Information .
d Click Import Certificate .

e In the Import Certificate dialog box, navigate to and select the 1SYNC certificate.
f Click Open.
g Click Add CA Certificate .

h In the Import CA Certificate dialog box, navigate to and select the issuing CA
certificate.
i Click Open and then Save.
j Click the Verify tab, and repeat steps 2c through 2i.
3 Add your public certificate and private key to the trading partner profile you defined
for your enterprise, as follows:
a Open the Sender profile (i.e., your Enterprise profile) in the Trading Networks
Console.
b Click the Sign tab, and then click Edit Information.
c Click Import Certificate.
d In the Import Certificate dialog box, navigate to and select your public certificate.
e Click Open.
f Click Add CA Certificate.
g In the Import CA Certificate dialog box, navigate to and select the issuing CA
certificate.
h Click Open.
i Click Import Private Key.
j In the Import Private Key dialog box, navigate to and select your private key.
k Click Open and then Save.
l Repeat steps 3b through 3k for the Decrypt tab.
Note: For information about working with certificates in Trading Networks, see
the Trading Networks administration guide for your release. See About this
4 Change the ACL for the wm.EDIINT:receive service as follows:

a Open the wm.EDIINT:receive service in webMethods Developer.
b Under the File menu option, select Lock for Edit.
c Click the Permissions tab in the right pane.
d Change all ACLs from Internal to Anonymous.
e Click Save.


8 webMethods 1SYNC Module Services
Summary of Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Wm1SYNC Documents Package Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Summary of Services
This section summarizes the services that come with webMethods 1SYNC Module. These
services are used to implement and support the 1SYNC-compliant functionality of the
1SYNC Module, such as subscribing to an item, sending confirmation, and so on. Only
those services that are publicly supported are documented. These services are provided
for sending different 1SYNC commands, such as CIS document, CIC document and
RFCIN document, to 1SYNC.
Note: For additional information about the inputs to the services in this section, see the
training materials on the 1SYNC Solution Center Site.
Element Package and Description

wm.ip.sync.services:sendRequests Wm1SYNC. Sends request business
documents to 1SYNC using webMethods
EDIINT Module.
wm.ip.sync.services:sendConfirmationDocument Wm1SYNC. Informs the party who sent an
item notification that it has been Accepted,
Rejected, Synchronized, or is in Review.
wm.ip.sync.services:sendSubscriptionDocument Wm1SYNC. Enables the retailer to register
subscriptions with 1SYNC so the retailer
can receive notifications of the information
sent by a particular supplier.
wm.ip.sync.services:sendRFCINDocument Wm1SYNC. Instructs 1SYNC to re-publish
the trade item information from a Data
Source.
wm.ip.sync.services:sendCatalogueRequest Wm1SYNC. Instructs 1SYNC to
add/modify/append an item, add/delete a
link, and add/delete a publication sent by a
supplier.
wm.ip.sync.services:sendRequests
Wm1SYNC. Sends request business documents to 1SYNC using webMethods EDIINT
Module.
The wm.ip.sync.services:sendRequests service is the most fundamental service in the
Wm1SYNC package. Each sendXXDocument service is built upon, and calls internally, the
wm.ip.sync.services:sendRequests service.

Services Built Upon wm.ip.sync.services:sendRequests
The wm.ip.sync.services:sendRequests service sends request business documents to 1SYNC

using EDIINT Module.
This service performs the following actions:
1 Checks for the conversationID.
2 Creates the 1SYNC envelope.
3 Validates the 1SYNC envelope (if you have the ValidateOutput TPA parameter set to
"True".)
4 Recognizes the 1SYNC envelope as a 1SYNC Request TN document type in
webMethods Trading Networks. For a list of the TN document types created in
Trading Networks when you install 1SYNC Module, see Defining TN Document
Types on page 51.
5 Persists the 1SYNC envelope in the Trading Networks transaction store as a 1SYNC
Request TN document type.
6 Calls wm.ip.sync.transport:send to send the request business document to 1SYNC.
The wm.ip.sync.transport:send service calls the wm.EDIINT:send service, which is a built-in
service provided with EDIINT Module that handles EDIINT transport. As an
acknowledgement to the request received, 1SYNC returns an MDN, which is received by
EDIINT Module. EDIINT Module recognizes the MDN using the EDIINT MDN TN
document type, saves the MDN to the Trading Networks database, and processes the
MDN. 1SYNC then sends back a response business document. EDIINT Module
recognizes the response business document using the EDIINT TN document type, saves
the response business document to the Trading Networks database, and processes the
response business document, which sends the MDN to 1SYNC.
Input Parameters
basic IData Contains senderGLN, receiverGLN, representing GLN,

conversationID, agreementID, schemaLocation, and
generateDocumentId. For more information on this Input Type,
see wm.ip.sync.common.rec:BasicInfo document type in webMethods
Developer.
envelope IData Sends 1SYNC documents.

Output Parameters
bizdocID String Unique ID for the business document created in Trading

Networks. bizdocID is internal to Trading Networks. Following is
the query for bizdocID:bizdoc[0]/InternalID[0]
wm.ip.sync.services:sendConfirmationDocument
Wm1SYNC. Informs the party who sent an item notification that it has been Accepted,
Rejected, Synchronized, or is in Review.
The confirmation is routed to the initiator of the notification. The confirmation states are
defined as follows:
ACCEPTED - This state is used to tell initiators that an item has been accepted by the
retailer but has not yet been synchronized. This is similar to the 1SYNC Pre-
Authorization.
REJECTED - This state is used to tell parties that an item is rejected and that no
additional information about this item is requested at this time.
REVIEW - This state is used to tell parties that an item is being reviewed by the
retailer.
SYNCHRONISED - This state is used to tell initiators that an item has been accepted
by the retailer and will be synchronized.
Input Parameters
basic IData Contains the senderGLN, receiverGLN, representingGLN,

Developer.
catalogueItemConfir IData This IData is used to send the confirmation to the initiator
mation of the notification.
Output Parameters
For the output variables of this service, see wm.ip.sync.services:sendRequests in this guide.

wm.ip.sync.services:sendSubscriptionDocument
Wm1SYNC. Enables the retailer to register subscriptions with 1SYNC so the retailer can
receive notifications of the information sent by a particular supplier.
The retailer registers a subscription for a particular GTIN, GLN, or Target Market.
Retailer also can subscribe to Catalogue Item data and receive Catalogue Item
Notifications from the supplier. 1SYNC logs a subscription so that the retailer will receive
any future publications pertaining to the subscribed Catalogue Item data.
Input Parameters
basic IData Contains senderGLN, receiverGLN, representingGLN,

Developer.
catalogueItemSubscri IData This IData is used to send the subscription documents to
ption 1SYNC.
Output Parameters
wm.ip.sync.services:sendRFCINDocument
Wm1SYNC. Instructs 1SYNC to re-publish the trade item information from a Data
Source.
Input Parameters

Developer.
requestForCatalogueI IData This IData is used to send the RFCIN document to 1SYNC.
temNotification
Output Parameters

wm.ip.sync.services:sendCatalogueRequest
Wm1SYNC. Instructs 1SYNC to add/modify/append an item, add/delete a link, and
add/delete a publication sent by a supplier.
The supplier uses this service to send the Catalogue Request (CR) xml message to submit
the item information within the 1SYNC Data Pool. This xml will contain Item, Link or
Publication information. The subscriber can add/modify/append an item, add/delete a
link, and add/delete/republish a publication.
Input Parameters

Developer.
CatalogueRequest IDataThis IData is used to send the catalogue request document
to 1SYNC.
Output Parameters
Wm1SYNC Documents Package Services

The Wm1SYNCDocuments package contains the records and schemas for each of the
BizDocTypes available for 1SYNC schemas (XSDs). 1SYNC Module validates documents
against 1SYNC schemas.
The records in this package correspond to the fields currently contained in the 1SYNC
business documents. When 1SYNC releases a new version of the standard, a
corresponding version of the documents package will be released by Software AG, which
when installed will overlay the existing documents and schemas.

6-5-2 1SYNC Module Install and Users Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

6-5-2 1SYNC Module Install and Users Guide

Hochgeladen von

Copyright:

Verfügbare Formate

Title Page

webMethods 1SYNC Module

Document ID: ESTD-1SYNC-IUG-652-20130618

About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2. Installing the webMethods 1SYNC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

3. Configuring webMethods 1SYNC Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 3

4. Defining Trading Partner Profiles in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . 37

5. Defining a Trading Partner Agreement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

6. Defining TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

7. Setting Up EDIINT Interaction with 1SYNC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

8. webMethods 1SYNC Module Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

4 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

Deprecation of webMethods Developer

8.0 9.0 and

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 5

8.0 9.0 and

6 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

8.0 9.0 and

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 7

For webMethods... The documentation is downloaded to...

8 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

If you want to... Go to...

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 9

10 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 11

What Is webMethods 1SYNC Module?

1SYNC Module Features

12 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

Catalogue Item Confirmation Response (1SYNC CICR)

1SYNC Module Packages

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 13

Design-Time Architecture and Components

14 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

Run-Time Architecture and Components

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 15

16 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 17

The 1SYNC Item Synchronization Process

18 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 19

Item Management Message Flow

Message Flow between Retailer and 1SYNC IM

20 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

Message Flow between Supplier and 1SYNC IM

Item Synchronization with 1SYNC Module

Sending Business Documents To and From 1SYNC

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 21

22 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

Receiving Business documents from 1SYNC

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 23

1SYNC GDSN Item Registry Response

1SYNC GDSN Party Registry Response

1SYNC Item Authorization Response

24 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

1SYNC Item Synchronization Response

1SYNC New Item Attribute Response

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 25

26 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

webMethods 1SYNC Module Installation and Users Guide Version 6.5.2 27

Installing 1SYNC Module 6.5.2

To install 1SYNC Module 6.5.2

28 webMethods 1SYNC Module Installation and Users Guide Version 6.5.2

Upgrading to 1SYNC Module 6.5.2