A BOD is a Powerful Thing: A Look at the Mechanics of Using OAGIS BODs

Open Applications Group Mechanics of Using OAGIS BODs David Connelly OAGi Michael Rowell Oracle Corp., Applications Steffen Fohn ADP, ADP Employer Services, Services Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 1 3/4/2008

Open Applications Group • OAGi is . . . The Open Applications Group, Incorporated Group • OAGIS is . . . The Open Applications Group Integration Specification Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 4 3/4/2008

Open Applications Group The Open Applications Group is a not- p pp p for-profit, open, and fully independent Open Standards Organization. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 5 3/4/2008

OAGi Members • AccTrak21 • GXS • Odette • ADP • HR-XML HR XML • OMG • Agilent Technologies • iBASEt • Oracle • AIAG • IBM • SAP • Alstom • INFOR • SoftShare • Boeing • Intel • STAR • Camstar • Intuit • Sterling Software • Cargill • ISA • TeliaSonera • CDC Software • Lawson Software • Tibco • Cisco • Manhattan Associates • Transcentric • Direct Insight • Michelin • UK MoD • Emerson • NIST • Wael Aggan • GEFEG • Nokia • WBF • GridNode • OASIS Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 6 3/4/2008

OAGi Industry Collaborations • UN/CEFACT – United Nations • ISO- International Standards Organization • MoU MG – Memorandum of Understanding Management Group • IEC TC57 WG14 – Electric Utility Standards • KIEC – Korean e-Commerce Consortium • NIST – National Institute of Standards & Technology • AIAG – Auto Supply Chain North America • Odette – Auto in Europe • ITA – Information Technology in Germany gy y • STAR – Auto Retail North America • AAIA – Auto Aftermarket North America • RV Industry – North America • AIA – Aerospace North America • AECMA – Aerospace Europe • OSCRE – Facilities Management • EDIFACE – Europe B2B community • HR-XML – HR Content, world-wide • SP95 – Enterprise Controls • ARTS (Retail) • WBF World Batch Forum • IFX – Interactive Financial Exchange • SWIFT • TWIST • Comptia/EIDX – Elect onics and Comp te Industry Electronics Computer Ind st • WS-I • OASIS Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 7 3/4/2008

The OAGIS Standard is . . . • Business Processes called Scenarios • Business Messages called Business Object Documents j (BODs) Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 8 3/4/2008

OAGIS Scope • eCommerce – e-Catalog – Price Lists – RFQ and Quote – Order Management – Purchasing Value Chain Processes – Invoice – Payments • Manufacturing and Supply Chain g pp y Enterprise – Warehouse Management – Orders Business – Shipping Processes – Tracking – Routings – Shop Floor – Plant Data Collection E t Enterprise i – Engineering Execution – Enterprise Asset Mgmt. Processes • CRM – Opportunities – Sales Leads – Customer – Sales Force Automation • ERP – Financials – Human Resources – Manufacturing – Credit Management – Sarbanes/Oxley & Control Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 9 3/4/2008

BOD Architecture Summary Business Object Document (BOD) Application Area Fields Compounds C d Components Verb Noun Data Area Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 11 3/4/2008

BOD Terminology • Th OAGIS Business Obj t Document (BOD) The B i Object D t Architecture defines the common XML structure and behavior definition for all OAGIS Messages. • The OAGIS BOD Definition defines the layout or structure of a specific message to be used. • The OAGIS BOD Instance is an occurrence of a live message that contains real data in the format defined in the schema above. • The term BOD is often used as a generic term used to describe either BOD Definitions or BOD Instances. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 12 3/4/2008

BOD Terminology • The OAGIS BOD Architecture is defined in the OAGIS Design Guide – A Word Document or on web site in HTML. • The OAGIS BOD Definitions are defined in XML Schema, in a text file such as: – ProcessPurchaseOrder.XSD – E i l t to 850 d fi iti Equivalent t definition • The OAGIS BOD Instances (occurrences) are defined in XML files that are pure text: – ProcessPurchaseOrder.XML – Equivalent to an 850 occurrence Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 13 3/4/2008

Sample BOD Definitions • ProcessPurchaseOrder • CancelPurchaseOrder • A k AcknowledgePurchaseOrder l d P h O d • ShowShipment • ProcessInvoice • GetInventoryCount • GetCredit • SyncProductionOrder Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 14 3/4/2008

OAGIS BOD Library • OAGIS BOD Library represents the set of BOD Definitions and their constituent parts (i.e., verbs, nouns, components and fields) • Parts are reusable, ensuring – Common look, feel, and behavior of all XML messages in the repository – Use of common dictionary across all messages – A faster learning curve for the user • Component are extensible, ensuring – Abilit t support new requirements Ability to t i t Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 15 3/4/2008

BOD Assembly BOD Application pp Area Verb V b Noun N Component Component Field Field Component Field Field Field Field Field Component Field New nouns can be assembled from the • N b bl d f th Field Field Field components and fields in the library • New BODs can be assembled from the nouns in the library Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 16 3/4/2008

BOD Data Mgmt Language What is it? • A language for the representation of and of create read, update, and delete create, read update (CRUD) operations used communicate instructions between systems. y – Vocabulary – Syntax – Semantics Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 18 3/4/2008

BOD Data Mgmt Language Why is it important? • The data management language is an integral part of the overall data interchange language. • Represents a key component of the interface contract required between i f i db communicating systems. • E Ensure consistent i t i t t interpretation and t ti d application of messages Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 19 3/4/2008

The OAGIS “Verb” The Verbs… Verb Verb Type Cancel Action • 3 verb types Change Action Load Action • 12 verbs Post Action • A verb represents a Process Action coarse-grain action, Sync Action request or response on request, Update Action the respective noun Get Request Acknowledge Response Confirm Response Respond Response Show Response Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 21 3/4/2008

Verb Interaction RESPONSE MESSAGES OAGIS 9.0 MESSAGES 90 NOUN-SPECIFIC NOUN- INDEPENDENT Post[noun] Acknowledge[noun] ConfirmBOD Process[noun] Acknowledge[noun] ConfirmBOD Cancel[noun] None ConfirmBOD Load[noun] None ConfirmBOD Sync[noun] None ConfirmBOD Change[noun] Respond[noun] ConfirmBOD Update[noun] Respond[noun] ConfirmBOD Get[noun] Show[noun] ConfirmBOD Acknowledge[noun] A k l d [ ] None N ConfirmBOD C fi BOD ConfirmBOD None None Respond[noun] None ConfirmBOD Show[noun] None ConfirmBOD Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 22 3/4/2008

Data Mgmt with Action Verbs Cancel Verb… The Cancel verb is used when the sender of the BOD is not the owner of the data, but is sending a request for the document to be canceled. An example is the Cancel PO where the business implications must be calculated and a simple data processing term such as delete can not fully convey the business meaning and required processing associated with the meaning. Change Verb Verb… The Change verb is used when the sender of the BOD is not the owner of the data, data but is sending a request for the document to be changed An example of changed. this is Change REQUISITION, where the original document needs to be changed based on a specific business event. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 23 3/4/2008

Data Mgmt with Action Verbs Load Verb… The Load verb is used to initiate the adding of a document or data entity to another business application. Generally this verb is used when maintenance to the document will then pass to the receiving application permanently. An example of this is Load Payable or Load Receivable, where once the request is processed, the sending application has no direct control over the document or entity again. Process V b P Verb… The Process verb is used to request processing of the associated noun by the receiving application or business to party. In a typical external exchange g pp p y yp g scenario a Process BOD is considered to be a legally binding message. For example, if a customer sends a ProcessPurchaseOrder BOD to a supplier and the supplier acknowledges with a positive AcknowledgePurchaseOrder, then the customer is obligated to fullfill the agreement unless of course other BODs agreement, are allowed to cancel or change the original order. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 24 3/4/2008

Data Mgmt with Action Verbs Notify Verb… The Notify verb is used to inform the receiving party that an event has occurred or document has been created. For example, a supplier may have a proposed order that is sent to a trading partner. The noun will contain the data that has been proposed. Sync Verb… The Sync verb is used when the owner of the data is passing or publishing that information or change in information to other software components. This is to be used when the receiver of the SyncBOD does not own the data. This verb is commonly used when mass changes are necessary or when a publish and subscribe mechanism is used in the integration architecture. The purposes of this verb include application integrity and ease of data entry for the business user by enabling a single point of input. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 25 3/4/2008

Data Mgmt with Request Verbs Get Verb… The purpose of the GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification. The GET is designed to retrieve a single piece of information by using that information's primary retrieval field (key field) or other significant property. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 26 3/4/2008

Data Mgmt with Request Verbs Get Verb (con’t)… There are two types of selection capabilities: 1) Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type. The Field-Based Selection enables the requester to provide a value or l (in the f values (i th case of multiple required Fi ld Id tifi ) i th required lti l i d Field Identifiers), in the i d fields. Then the responding component uses those values to find and return the requested information to the originating business software component. 2) Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 27 3/4/2008

The OAGIS Verb Types The Action Verb Type… • Action Expressions represent and communicate “Create, Update, and Delete” data management instructions • actionCode specifies the action to be taken by the receiver – {Add, Change, Delete, Replace} • The data entities being managed are represented as elements of the noun in the BOD instance. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 28 3/4/2008

The OAGIS Verb Types The Request Verb Type… • Expressions represent and communicate “Read” data management instructions Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 29 3/4/2008

The OAGIS Verb Types The Response Verb Type… • Response Expressions represent and communicate actions t k i t ti taken b th R by the Receiver i • actionCode specifies the action that was taken by the receiver – { {Accepted, Modified, Rejected} d df d d} Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 30 3/4/2008

The Data Mgmt Verbs • Verbs used to communicate data management operations Verb Verb Type Cancel Action • Action Verbs are used to express Change Action Create, Update, and Delete operations Load Action • Request Verbs are used to express q p Post Action Read operations Process Action Sync Action • How should their language constructs Update Action be applied? pp Get Request ….in other words… Acknowledge Response • How should the elements of the Confirm Response ActionExpression be used? p Respond Response • What do the action codes mean? Show Response • Do all action codes apply to all action verbs? • Etc. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 31 3/4/2008

Data Mgmt with Action Verbs The fundamental data management approaches for Create, Update & Delete Create Update, Delete… Name Description Snapshot A full snapshot of all the data (an Application has) in some defined scope (i e Noun) (i.e., (Refresh) (R f h) Type of data mgmt instruction (add, update, delete) is not communicated; it is implicit Incremental Changed data in the scope of the message definition (Delta) Type of data mgmt instruction (add, update, delete) is communicated; it is explicit Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 32 3/4/2008

Data Mgmt with Action Verbs Action Verb rules… For any action verb-based BOD message the following rules (R) apply: Rule : actionCode=”Replace” in the Action Expression shall be actionCode= Replace used to indicate the replacement of an entity represented by the element in the expression. Rule : actionCode=”Add” in the Action Expression shall be used to indicate the creation/addition of an entity represented by the element in the expression. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 33 3/4/2008

Data Mgmt with Action Verbs Action Verb rules (con’t)… For any action verb-based BOD message the following rules (R) apply: Rule : actionCode=”Change” in the Action Expression shall be actionCode= Change used to indicate the modification of an entity represented by the element in the expression. Rule : actionCode=”Delete” in the Action Expression shall be used to indicate the removal/deletion of an entity represented by the element in the expression. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 34 3/4/2008

Data Mgmt with Action Verbs Action Verb rules (con’t)… For any action verb based BOD message the following verb-based rules (R) apply: Rule : The expression of the ActionExpression must specify the element of the noun instance that represents the managed entity. Note: In the case where an expression applies to one or more noun instances, the expression must not specify the noun instance being managed (since the expression is intended to apply to all of the noun instances). Note: In the case where an expression applies uniquely to a noun instance, the expression must specify the noun instance being managed. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 35 3/4/2008

Data Mgmt with Action Verbs Action Verb rules (con’t)… For any action verb-based BOD message the following rules (R) apply: Rule R le : The scope of elements being managed in a noun instance ope element m n ged no n in t n e must be well-defined and understood by message senders and receivers. Rule : An entity, represented in a noun instance, should be identified by a standard ID or set of IDs (in the case of a composite key). Rule : The management of IDs must not occur in business- oriented transactions; management of IDs (i.e., migrate one OID to another OID in a merge process) must occur in transactions that are specialized for this purpose. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 36 3/4/2008

Data Mgmt with Action Verbs Snapshot rules… For any action verb BOD message used in the Snapshot approach the following rules apply: Rule A f th ti R l : Any of the action verbs may be used. b b d Rule : The ActionExpression.actionCode shall be restricted to the set of values = {Replace}. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 37 3/4/2008

Data Mgmt with Action Verbs Incremental rules… For any action verb BOD message used in the F ti b d i th Incremental approach the following rules apply: Rule : Any of the action verbs may be used. u yo a o b ay b u d Rule : The ActionExpression.actionCode shall be restricted to the set of values = {Add, Change, Delete}. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 38 3/4/2008

Data Mgmt with Action Verbs Incremental rules… For any “add” operation, the following rules (R) apply: Rule: The message shall contain an ActionExpression with an actionCode of “Add”. Rule : The expression of the ActionExpression must specify the element of the noun instance that represents the created entity. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 39 3/4/2008

Data Mgmt with Action Verbs Incremental rules… F “d l t ” ti For any “delete” operation, the following rules (R) th f ll i l apply: Rule: The message shall contain an ActionExpression with g p an actionCode of “Delete”. Rule : The expression of the ActionExpression must specify the element of the noun instance that represents the deleted entity. For any “delete” operation, where the entity being y p y g deleted is identifiable with ID(s) the following rules (R) apply: Rule: The message instance noun shall only provide a reference to the entity via the ID(s). Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 40 3/4/2008

Data Mgmt with Action Verbs Incremental rules… For any “update” operation, the following rules (R) apply: Rule: The message shall contain an ActionExpression with an actionCode of “Change”. Rule : The expression of the ActionExpression must specify the element of the noun instance that represents the updated entity. R l Rule: Th message i t The instance noun shall only include the h ll l i l d th entity ID (if one exists) and the updated properties of the entity. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 41 3/4/2008

Data Mgmt with Action Verbs Action Action Code Verb Add Change Replace Delete Relating Incremental Cancel -- -- -- - Delete Action Verbs & Snapshot Incremental Incremental Incremental their Action Change - Create Update, - Delete - Create - Update Delete Codes Incremental Snapshot Load -- - Create, Update, -- with the - Create Delete Snapshot Incremental Data Mgmt g Post Incremental Incremental - Create Update, Create, Update - Delete - Create - Update Approaches Delete Snapshot Incremental Incremental Incremental & Operations Process - Create - Update - Create, Update, - Delete Delete Snapshot Incremental Incremental Incremental Sync - Create, Update, - Delete - Create - Update Delete Snapshot Incremental Incremental Incremental Update - Create, Update, - Delete - Create - Update Delete Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 42 3/4/2008

Data Mgmt with Request Verbs “Read” rules… uniqueIndicator – Indicates whether duplicates should be filtered out. maxItems – Communicates the maximum number of records which should be returned in a segment from a recordSet. recordSetSaveIndicator – A true value indicates that receiver should save the record set. recordSetStartNumber – The record number identifying the first record that should be returned in the Show response. This attribute is specified on q q , subsequent Get requests, not the initial Get request. The systems may q y y determine this number from the prior Show message (see the Show verb attributes for more information). recordSetReferenceID – Unique identifier of the RecordSet It is generated by RecordSet. the producer of the Show response as a result of the original Get request. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 44 3/4/2008

Data Mgmt with Request Verbs “Read” rules… Rule : Field-Based selection criteria shall be represented in the noun instance. Rule : DataType selection criteria shall be represented in the Expression. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 45 3/4/2008

Action Verb Examples Data TaskID Verb Management (Business Action Verb Technique T h i Message BOD M Event) E t) V b Verb Code C d A ti E i ActionExpression Required Entity IDs R i d E tit ID Business Scenario: 1. A Purchase Order is created. New Incremental Purchase ProcessPurchaseOrder/DataArea/ PurchaseOrderHeader. - Create ProcessPurchaseOrder Order Process Add PurchaseOrder DocumentID.ID DocumentID ID Notes: 1.The message contains the complete order. Business Scenario: 2. The order quantity on an existing line in a Purchase Order is updated. Purchase Order ProcessPurchaseOrder/DataArea/ PurchaseOrderHeader. Snapshot ChangePurchaseOrder Change Change Replace PurchaseOrder DocumentID.ID Notes: 1.The message contains the complete order. PurchaseOrderHeader. Purchase DocumentID.ID; Incremental Order ProcessPurchaseOrder/DataArea/ PurchaseOrderLine - Update ChangePurchaseOrder Change Change Change PurchaseOrder/PurchaseOrderLine/ LineNumber Notes: 1.Only 1 Only the DocumentID is provided in the OrderHeader OrderHeader. 2.All elements of the OrderLine are provided. * These examples assume a single noun instance Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 46 3/4/2008

Action Verb Examples Data TaskID Verb Management (Business Action Verb Technique BOD Message Event) Verb Code ActionExpression Required Entity IDs Business Scenario: 3. A line item on an existing Purchase Order is removed. Purchase ProcessPurchaseOrder/DataArea/ PurchaseOrderHeader. Snapshot ChangePurchaseOrder Order Change Replace PurchaseOrder DocumentID.ID; Change Notes: 1.The complete order is provided PurchaseOrderHeader. Incremental Purchase ProcessPurchaseOrder/DataArea/ DocumentID.ID; ChangePurchaseOrder Change Delete - Delete Order Change PurchaseOrder/PurchaseOrderLine/ PurchaseOrderLine LineNumber Notes: 1.Only the DocumentID is provided in the OrderHeader. 2.Only the LineNumber is provided in the OrderLine. Business Scenario: 4. A Purchase Order is cancelled Purchase Incremental ProcessPurchaseOrder/DataArea/ PurchaseOrderHeader. CancelPurchaseOrder Order Cancel Delete - Delete PurchaseOrder DocumentID.ID; Cancell-ation Notes: 1.Only 1 Only the DocumentID is provided in the OrderHeader OrderHeader. 2.Application of the action code in this scenario is subject to business policies. For example, a Cancel request by way of a Delete action code may result in a “logical” deletion versus. “physical” deletion of the order. * These examples assume a single noun instance Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 47 3/4/2008

Action Verb Examples Data TaskID Management (Business Verb Verb Technique BOD Message Event) Verb Action Code ActionExpression Required Entity IDs Business Scenario: 5. Two Purchase Orders are changed. The order quantity on an existing line in the first Purchase Order is updated. A line item on the second Purchase Order is removed. Purchase ProcessPurchaseOrder/DataArea/ PurchaseOrderHeader. Snapshot ChangePurchaseOrder Order Change Replace PurchaseOrder DocumentID.ID Change Notes: 1.The message contains two complete orders. 2.This is an example of a single ActionExpression applying to multiple noun instances. ProcessPurchaseOrder/DataArea/ PurchaseOrder/ Change PurchaseOrderHeader/DocumentID=”111” O / ” ” and PurchaseOrderLine/LineNumber =”1” Incremental PurchaseOrderHeader. Purchase DocumentID.ID; - Update ChangePurchaseOrder Order Change PurchaseOrderLine - Delete Change LineNumber Delete ProcessPurchaseOrder/DataArea/ PurchaseOrder/ PurchaseOrderHeader/DocumentID=”222” and PurchaseOrderLine/LineNumber =”1” Notes: 1.Only the DocumentID is provided in the OrderHeader. 2.For the Delete, only the LineNumber is provided in the OrderLine. 3.This is an example of a multiple unique ActionExpressions applying to different data element instances; note that the ActionExpression identifies the data element instance being managed. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 48 3/4/2008

Get (Request) Verb Examples Data Management Verb Verb Expression Noun Elements Technique BOD Message Verb Attributes (Data Type Selection) (Field-Based Selection) Business Scenario: 1. Get up to 10 purchase orders for a given customer whose order status is “Shipped”. PurchaseOrderHeader. uniqueIndicator = “True” GetPurchaseOrder/DataArea/ CustomerParty.PartyIDs.ID = “0001” GetPurchaseOrder Get maxItems = 10 PurchaseOrder recordSetSaveIndicator = “False” False PurchaseOrderHeader.Status PurchaseOrderHeader Status = “Shipped” Shipped Notes: 1.The message contains two complete orders. Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 49 3/4/2008

OAGIS 9.0 is . . . • Canonical Format – Common Object Model (Nouns) – Class Libraries (UN/CEFACT and OAGIS® CC) – Artifact Subsets for SOA Service Definitions • Naming and Design Rules – UN/CEFACT Based /C C d • Transaction and Context Model – Nouns – Verbs • Application Architecture – Document Typing – Meta Model • Technical Architecture (BOD) …a foundation for – Common Look and Behavior message standards – Extensions Architecture – Extrusions Architecture Copyright © 1995-2008 Open Applications Group, Inc. All rights reserved 51 3/4/2008

A BOD is a Powerful Thing: A Look at the Mechanics of Using OAGIS BODs

1 comments

Notes on slide 1

Favorites, Groups & Events