OCI specification

OCI specification
OCI specification
Shop and Request
Version R1 2015
Public
Table of Contents
1
Introduction ___________________________________________________________ 2
Purpose ____________________________________________________________________ 2
Audience ___________________________________________________________________ 2
Prerequisites ________________________________________________________________ 2
References _________________________________________________________________ 2
2
Shop - OCI outbound ____________________________________________________ 3
Minimum Requirements ______________________________________________________ 3
Round trip specific fields ______________________________________________________ 5
Request specific parameters (for Shop integration) _________________________________ 7
IBX specific call structure ______________________________________________________ 9
Order of OCI fields __________________________________________________________ 11
Summary __________________________________________________________________ 12
Examples __________________________________________________________________ 13
3
Request – OCI outbound _________________________________________________ 14
Minimum requirements ______________________________________________________ 14
Round trip specific fields _____________________________________________________ 15
Non mandatory OCI parameters _______________________________________________ 16
4
Shop OCI inbound ______________________________________________________ 17
Standard OCI 4.0 fields _______________________________________________________ 17
IBX specific OCI fields ________________________________________________________ 22
List of fields ________________________________________________________________ 24
Summary __________________________________________________________________ 27
Examples __________________________________________________________________ 28
Encoding __________________________________________________________________ 29
Timeout ___________________________________________________________________ 29
5
Request OCI inbound____________________________________________________ 30
Standard OCI 4.0 fields _______________________________________________________ 30
IBX specific OCI fields ________________________________________________________ 31
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 1
1 Introduction
The SAP Open Catalog Interface (OCI) 4.0 standard is used to integrate eProcurement systems with IBX Shop.
This document describes IBX specific enhancements to the SAP OCI 4.0 standard. Please refer to the SAP OCI 4.0
documentation for general information about the OCI standard.
Purpose
The purpose of this document is to give technical personnel from eProcurement application vendor’s necessary
information to establish the OCI interface towards IBX Business Network.
Audience
The audience of this document is
-
Technical personnel and solution architects at eProcurement application vendors
Funcitonal responsible personnel – such as product managers – at eProcurement application vendors
Prerequisites
Reading this document requires some knowledge around the way the OCI-standard is working. Please refer to
documentations from SAP on this if input is needed. A basic knowledge on the call off process is also required
from a functional point of view.
References
IBX Business Network uses Open Catalog Interface (OCI) which is an SAP standard for connecting an
eProcurement system to a punch out web shop. The format was selected based on its widespread use in the
market today.
OCI communication consists of inbound- and outbound messages.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 2
2 Shop - OCI outbound
OCI communication consists of inbound- and outbound messages. Outbound messages are sent from the
eProcurement system to IBX Shop.
The outbound OCI is configured in the eProcurement system and consists of a number of predefined parameters
that are posted to the specified URL.
Minimum Requirements
The following fields are required:






URL
USERNAME
PASSWORD
BORG (Not required if the default BORG is specified)
HOOK_URL
USER_ID
URL
The fields below should be posted to the IBX Shop login URL:

https://searchengine3.ibxeurope.com/cataloginterface/login.do
USERNAME
Identifies the organisation. A static parameter that never changes. The TPID of the buyer. Issued by IBX Service
Desk. Maximum length: 40 characters
PASSWORD
A System specific password for each buyer organization. Issued by IBX Service Desk. Maximum length: 40
characters
BORG
Buying Organization. The current users BORG value, ex: Sweden, London, etc. Can be used to setup content
filters and limit the searchable content for different groups of users.Maximum length: 40 characters
HOOK_URL
The URL to where IBX Shop will post the inbound OCI cart. See Inbound OCI below.
The URL must be a complete URL including protocol, hostname and ports if non standard ports are used.
Example: https://eprocurement.site.com/RecieveOCI.jsp
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 3
USER_ID
A unique user id representing the end user. Normally the same ID as used by the eProcurement system.
The User ID is used for keeping track of current and saved shopping carts.
FUNCTION
This parameter is user for the Shop to provide additional functions to the SRM system. Currently Catalog
Interface supports:


VALIDATE. The SRM systems sends the ProductId and the quantity of the item that should be validated
as an outbound OCI call. Catalog Interface will return an OCI form with the product details. This is used
by the SRM system to determine if the price of an item has changed. For more details see chapter 3.2.2
in the OCI 4.0 documentation.
DETAIL. The SRM system sends the ProductId as an outbound OCI call and Catalog Interface will open
the item details page of the specified product. For more details see chapter 3.2.1 in the OCI 4.0
documentation.
~OkCode
(Ex: ADDI) Saved in user session, but not used in any way by Shop.
~TARGET
(Ex: _top) Saved in user session, but not used in any way by Shop.
~CALLER
(CTLG) Saved in user session, but not used in any way by Shop.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 4
Round trip specific fields
Fields that are used to send delivery address information to a round trip supplier.
Name
(ex: Svesse Svensson)Used when accessing Request through IBX Shop.
Name2
(ex: test)
Used when accessing Request through IBX Shop.
Building
(ex:KH01)
Used when accessing Request through IBX Shop.
Floor
(ex:10)
Used when accessing Request through IBX Shop.
C/O
(ex: Kalle Karlsson)
Used when accessing Request through IBX Shop. Some customers use this field to supply the user full name.
Street
(ex: Sveavägen)
Used when accessing Request through IBX Shop.
House_no
(ex: 9)
Used when accessing Request through IBX Shop.
Post_code
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 5
(ex: 11333)
Used when accessing Request through IBX Shop.
City
(ex: Stockholm)
Used when accessing Request through IBX Shop.
Telephone
(ex: +468112888)
Used when accessing Request through IBX Shop.
Fax
(ex:+468112999)
Used when accessing Request through IBX Shop.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 6
Request specific parameters (for Shop integration)
E_mail
An optional parameter that can be used when Request is activated in Shop. If this parameter is not supplied the
end user will have to enter his/her email address when creating a request.
Used when accessing Request through IBX Shop.
ReqUsername
Username to login to Request.
Should be excluded since it can be setup in the buyer profile in IBX Shop.
ReqPassword
Password to login to Request.
Should be excluded since it can be setup in the buyer profile in IBX Shop.
Buyer_mpid
The Buyer’s MPID (=TPID). A separate parameter for Request. Should contain the TPID of the buyer. Should be
excluded if Request is not used since it can be setup in the buyer profile in IBX Shop.
Formid
IBX Request form ID.
For free requests this will always be 15.
Buyer_username
The full name of the end user. Does not have to be a unique value. Usually the first name and Last name. If not
available can be the same value as USER_ID.
Used when accessing Request through IBX Shop.
Project_id
Project ID. Used by EB Construction for IBX Request.
Used when accessing Request through IBX Shop.
Project_name
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 7
Project name. Used by EB Construction for IBX Request.
Used when accessing Request through IBX Shop.
ReqRole
The user’s role in IBX Request.
Used when accessing Request through IBX Shop.
Available roles:
-
FreeRequester. Users with this role will get access to all requests for the current buyer.
No role (empty value). Will only have access to own requests.
Room
Ship-to address. Used by IBX Request
Used when accessing Request through IBX Shop.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 8
IBX Business Network specific call structure
Fields that are required by the IBX Shop.
sessionType
Valid values are test and debug. Any other values are ignored. If the sessionType is set to “test” the Shop will be
running in test mode. This means that roundtrips will be disabled and a message will be displayed on each page.
If the sessionType is set to “debug” some debug features are activated:

The checkout is not automatically posted and the form values are displayed. A continue button is visible
for manual submit.
COUNTRY
Should be a valid ISO country code. Ex: SE, US, UK, etc. If the parameter is not supplied the default value for the
buyer will be used. http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html
LANGUAGE
Should be a valid ISO language code. Ex: sv, da, en, etc. If the parameter is not supplied the default value for the
buyer will be used.
CURRENCY
Should be a valid ISO currency code. Ex: SEK, EUR, JPY, etc. If the parameter is not supplied the default value for
the buyer will be used
ROLE
The field can contain one of three values:




.
Restricted. Users with this role cannot change all user settings and the prices will be hidden.
Standard. Users with this role will have the default features. If this parameter is comitted the standard
role will be set.
Professional_buyer. Users with this role can administrate the start page for the other users in this borg
and the child borgs.
CCS_ID
The buyer category that should be displayed through the Catalog Interface and also this is the buyer category
that will be chosen out to OCI.
Encoding
Controls the encoding of the checkout form. Valid values are:
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 9


UTF-8
ISO 8859-1
ISO 8859-1 is the same as Latin1 encoding.
ProductId
If the ProductId parameter is used, Catalog Interface Advanced will show the item details corresponding to that
parameter
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 10
Order of OCI fields
The following order of the call structure fields should be used.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
USERNAME
PASSWORD
BORG
USER_ID
Name
Name2
Building
Floor
C/O
Street
House_no
Post_code
City
Country
LANGUAGE
SEARCHLANGUAGE
Telephone
Fax
E_mail
sessionType
HOOK_URL
~target
CURRENCY
encoding
role
function
validateuser
productId
quantity
reqUsername
reqPassword
buyer_mpid
buyer_username
room
project_id
project_name
reqRole
ccs_id
~OkCode
~CALLER
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 11
Summary
Only IBX Shop
Only Request
IBX Shop + Request
URL
Mandatory
Mandatory
Mandatory
USERNAME
Mandatory
Mandatory
Mandatory
PASSWORD
Mandatory
Mandatory
Mandatory
BORG
Mandatory
N/A
Mandatory
USER_ID
Mandatory
Mandatory
Mandatory
E_mail
N/A
Optional
Optional
buyer_username
N/A
Mandatory
Mandatory
Buyer_mpid
N/A
Mandatory
N/A
HOOK_URL
Mandatory
Mandatory
Mandatory
reqRole
N/A
Optional
Optional
LANGUAGE
Mandatory
Mandatory
Mandatory
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 12
Examples
Note: All html field values below are examples.
The form should be UTF-8 encoded.
Example 1 (IBX Shop only)
<form method="post" enctype="application/x-www-form-urlencoded; charset=UTF-8"
action="https://searchengine3.ibxeurope.com/cataloginterface/login.do" id="nameOnForm">
<input name="USERNAME" value="ef424336-0596-11df-ab05-593a56d89593" />
<input name="PASSWORD" value="secretpassword" />
<input name="BORG" value="Bergen" />
<input name="USER_ID" value="svesse.svensson" />
<input name="E_mail" value="svesse.svensson@site.com" />
<input name="HOOK_URL" value="https://eprocurement.site.com/RecieveOCI.jsp" />
<input type="submit" value="Login" />
</form>
Example 2 (Request only)
<form method="post" enctype="application/x-www-form-urlencoded; charset=UTF-8"
action="https://request.ibxeurope.com/request/oci.nsf/OCICreateFreeRequest?OpenAgent"
id="nameOnForm">
<input name="USERNAME" value="TestBuyerRequest" />
<input name="PASSWORD" value="secretpassword" />
<input name="LANGUAGE" value="no" />
<input name="USER_ID" value="svesse.svensson" />
<input name="E_mail" value="svesse.svensson@site.com" />
<input name="buyer_username" value="Svesse Svensson" />
<input name="buyer_mpid" value="ef424336-0596-11df-ab05-593a56d89593" />
<input name="reqRole" value="FreeRequester" />
<input name="HOOK_URL" value="https://eprocurement.site.com/RecieveOCI.jsp" />
<input type="submit" value="Login" />
</form>
Example 3 (IBX Shop and Request)
<form method="post" enctype="application/x-www-form-urlencoded; charset=UTF-8"
action="https://searchengine3.ibxeurope.com/cataloginterface/login.do" id="nameOnForm">
<input name="USERNAME" value="ef424336-0596-11df-ab05-593a56d89593" />
<input name="PASSWORD" value="secretpassword" />
<input name="BORG" value="Bergen" />
<input name="USER_ID" value="svesse.svensson" />
<input name="E_mail" value="svesse.svensson@site.com" />
<input name="buyer_username" value="Svesse Svensson" />
<input name="reqRole" value="FreeRequester" />
<input name="HOOK_URL" value="https://eprocurement.site.com/RecieveOCI.jsp" />
<input type="submit" value="Login" />
</form>
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 13
3 Request – OCI outbound
Minimum requirements
The following fields are required:

Landing page :
o
OCICreateFreeRequest? – takes the user to the Create requests tab
o
viewEvaluate.seam? – takes the user to the Manage requests tab
o
viewEvaluateRestricted.seam? – takes the user to the manage requests tab, the
“Create new request” tab is disabled

buyer_mpid – the buyer TPID

tmpUsername – the buyer user that is used to access Request

password – the buyer user’s password

formid – the id of the eform as taken from Request database. Default is 15 for free requests and
14 for pricechecks

user_id – user id, as taken from SRM

buyer_username – Used to show the buyer’s name in Request; it’s usually setup as “Firstname
Lastname”

language – two letter abbreviation of the user language. Request supported languages:
o
da (Danish)
o
de (German)
o
en (English)
o
es (Spanish)
o
fi (Finnish)
o
fr (French)
o
no (Norwegian)
o
sv (Swedish)
o zh (Simplified Chinese)
Note that any number of the above languages can be selected during setup, as well as a setting
that defines the language to use if the language sent via OCI does not match the selection (e.g.
en, es and de are selected as user languages and zh is sent by mistake via OCI. The language
used in the interface will be the one setup in this default setting).
Translated elements include all labels and buttons as well as product code (UNSPSC)
descriptions, if available.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 14
Round trip specific fields
Fields that are used to send delivery address information to a round trip supplier. All these fields pre-fill
the information in the “Buyer info” section of the information tab for free requests

Country

Telephone

Fax

building

room

floor

street

post_code

city
Below parameters are used in pricechecks, where they fill the fields in the ‘Address’ tab, which holds the
buyer’s delivery information.

buyerPartyAddressName_1

buyerPartyAddressName_2

buyerPartyAddressName_3

house_no

building

room

floor

post_code

city

Country
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 15
Non mandatory OCI parameters


e_Mail – e-mail for the user, as taken from SRM – this is usually sent via SY_Uname parameter in
SRM. However, it is not mandatory, but not sending it means that the buyer user will have to fill
it by hand in the Information tab, as it is a mandatory field in the interface.
rfqcategoryID
This is used by Skanska to send a project ID.

rfqCategoryName
This is used to set the available attachments when clicking on “Add shared attachment” when
creating a request. Set it to the attachment category and you will see attachments from that
category.

hook_url

currency – sets up the default currency. If not sent via OCI, the currency set up as a sysadmin is
used.

Activity – Used by Skanska to set available attachments in the “Add shared attachment” screen.

BidNo – used by Ericsson, the value is a number. Two requests cannot be created with the same
BidNo.

reqrole
o
freerequester – gets access to all requests
o
not set – only has access to requests where he is the current / original owner and to
requests sent to a group he belongs to.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 16
4 Shop OCI inbound
OCI communication consists of inbound- and outbound messages. Inbound messages are sent from IBX Shop to
the eProcurement system.
IBX Shop supports most of the standard OCI 4.0 inbound fields. It also includes some optional IBX specific fields
(ZZ prefix).
Standard OCI 4.0 fields
OCI fields as documented in the SAP documentation.
NEW_ITEM-DESCRIPTION[n]:
Always included in the inbound OCI message.




Catalogue items: Retrieved from the Product Name column in IBX Catalogue template.
Free text: Value entered by the user when defining the product.
Request: The Name of the quoted item.
Web Shop punch out (double): Defined by the web shop.
The field value will not be longer than 160 characters.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/ItemIdentifiers/ItemDescriptio
n
NEW_ITEM-QUANTITY[n]:
Always included in the inbound OCI message.




Catalogue items: Value entered by user when adding the item to the shopping cart. The allowed values
are defined by the lot size and min order columns in the IBX Catalogue template.
Free text: Any integer value entered by the end user when defining the product.
Request: The quoted number of items.
Web Shop punch out (double): Any integer value entered by the end user.
Maximum length is 15 characters.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/TotalQuantity/Quantity/Quantit
yValue
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 17
NEW_ITEM-UNIT[n]:
A valid ISO UOM code according to IBX subset of the UNECE recommendations.




Catalogue items: The value specified in the Unit column in the IBX Catalogue template.
Free text: When defining the product the user can select a unit of measure from a defined subset.
Request: The quoted unit of measure.
Web Shop punch out (double): A unit of measure value is sent from the vendor’s web shop.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/TotalQuantity/Quantity/UnitOfM
easurement/UOMCoded
NEW_ITEM-PRICE[n]:
A price value per unit with up to three decimals.




Catalogue items: The value specified in the Price column in the IBX Catalogue template. The price will
always be in the vendor’s currency.
Free text: When defining the product the user can enter a numeric price value.
Web Shop punch out (double): A price is sent from the vendor’s web shop.
Request: The quoted item price.
A dot character is used as decimal separator. No thousand separators are used. Ex:
10500.333
12300
Maximum length is 15 characters.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/PricingDetail/ListOfPrice/Price/UnitPrice/Uni
tPriceValue
NEW_ITEM-CURRENCY[n]:
The currency ISO code as specified in the Catalogue. Only currently valid ISO codes are sent.




Catalogue items: The value specified in the Currency column in the IBX Catalogue template.
Free text: Currency predefined in the vendor form Catalogue.
Web Shop punch out (double): A currency code is sent from the vendor’s web shop.
Request: Quoted currency code.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/PricingDetail/ListOfPrice/Price/UnitPrice/Cur
rency/CurrencyCoded
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 18
NEW_ITEM-LEADTIME[n]:
Delivery time of the item in days. Integer value.




Catalogue and Price Check items: The value specified in the Lead Time column in the IBX catalog
template.
Vendor Form and User Defined items: Lead Time can be specified as an integer when defining the
product in Shop.
Web Shop punch out (double): A currency code is sent from the vendor’s web shop.
Request: The quoted Lead Time.
xCBL Order xPath:
/Order/OrderHeader/OrderDates/RequestedDeliverByDate
NEW_ITEM-LONGTEXT_n:132[]:
The long description of the item.




Catalogue items: Non standard eform fields are included as a value-pair list. See example 1 below. For
items without eform nothing will be sent.
Free text: The text specified by the user in the Description field when defining the product in Shop.
Web Shop punch out (double): Not included, nothing will be sent.
Request: The description and number of the request and the description and number of the quote.
Examle:
Request: The description of 0000004 v 1. Quote: quote-0000001. Description: Pet Dogs
Maximum length 2000 characters.
xCBL Order xPath:
For free text items the field will contain the product description entered by the user. For Request the
concatenated text generated by the system will be sent. See example above.
/Order/OrderDetail/ListOfItemDetail/ItemDetail/LineItemNote
For catalogue products eform data can be sent if an eform is connected to the product.
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/ItemIdentifiers/ListOfItemChar
acteristic
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 19
NEW_ITEM-VENDOR[n]:
The internal id representing the vendor in the eProcurement system.
Mapped to the “Vendor ID” column in the Catalogue template.





Catalogue items: As specified when the vendor was activated during the supplier activation. For Open
Marketplace items the IBX supplier short name will be used.
Free text (Predefined vendor and user defined product): As specified in the Vendor ID in the free text
Catalogue.
Free text (User defined vendor and product): All user defined items will have the same dummy vendor
ID. Not applicable for Open Marketplace.
Web Shop punch out (double): As specified when the vendor was activated during the supplier
activation.
Request: As specified in the request vendor directory. Should be the vendors TPID.
Maximum length 50 characters (OCI standard is 10 characters)
xCBL Order xPath:
Details about the vendor should be sent in:
/Order/OrderHeader/OrderParty/SellerParty
The Vendor ID should also be used to generate the SOAP envelop for the order.
NEW_ITEM-VENDORMAT[n]:
The Vendor Part Number.
Retrieved from the “Vendor Product No” column in the IBX Catalogue template.




Catalogue items: Specified by the vendor in the Catalogue,
Free text: Can be specified when defining the product in Shop.
Web Shop punch out (double): Can be specified when defining the product in Shop.
Request: The quoted article number.
Maximum length 40 characters.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/ItemIdentifiers/PartNumbers/Se
llerPartNumber/PartNum/PartID
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 20
NEW_ITEM-MANUFACTMAT[n]:
The Manufacturer Part Number.
Retrieved from the “Manufacturer Product No” column in the IBX Catalogue template.




Catalogue items: Specified by the vendor in the Catalogue,
Free text: Can be specified when defining the product in Shop.
Web Shop punch out (double): Can be specified when defining the product in Shop.
Request: Not sent.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/ItemIdentifiers/PartNumbers/Ma
nufacturerPartNumber/PartyID
NEW_ITEM-MATGROUP[n]:
The UNSPSC (version 7.0401) code of the current item.




Catalogue items: Specified by the vendor in the Catalogue,
Free text: Can be specified when defining the product in Shop.
Web Shop punch out (double): Sent by the vendor.
Request: The quoted UNSPSC code.
Has to be included in order xCBL document.
xCBL Order xPath:
/Order/OrderDetail/ListOfItemDetail/ItemDetail/BaseItemDetail/ItemIdentifiers/CommodityCode
NEW_ITEM-EXT_PRODUCT_ID[n]:
Unique key representing an item in the Shop index. Is calculated hash based on the Catalogue name, Vendor Part
Number and Unit of measure.
Primarily used for OCI Function calls. IBX Shop supports Validate and Details function calls. See OCI 4.0
documentation from SAP for details.
Can also be used internally in the eProcurement system if needed.
Maximum length 40 characters.
xCBL Order xPath:
N/A
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 21
IBX specific OCI fields
OCI fields specific to IBX workflows and functionality.
NEW_ITEM-ZZ_CONTACT_NAME1[n]:
Contains the full name of the contact person of the current vendor.




Catalogue items: As specified in the “Vendor Contact” column.
Free text (User defined product): As specified in the “Vendor Contact” column in the free text
Catalogue.
Free text (User defined vendor and product): Specified when defining the vendor.
Web Shop punch out (double): N/A.
NEW_ITEM-ZZ_E_MAIL[n]:




Catalogue items: As specified in the “Vendor eMail” column.
Free text (User defined product): As specified in the “Vendor eMail” column in the free text Catalogue.
Free text (User defined vendor and product): Specified when defining the vendor.
Web Shop punch out (double): N/A.
NEW_ITEM-ZZ_NAME1[n]:




Catalogue items: As specified in the “Vendor Name” column.
Free text (User defined product): As specified in the “Vendor Name” column in the free text Catalogue.
Free text (User defined vendor and product): Specified when defining the vendor.
Web Shop punch out (double): N/A.
NEW_ITEM_ZZ_CONTRACTNO[n]:




Catalogue items: As specified in the “Contract No” column.
Free text (User defined product): specified in the “Contract No” column in the free text Catalogue.
Free text (User defined vendor and product): N/A
Web Shop punch out (double): N/A.
NEW_ITEM_ZZ_VIEW
View ID that identifies the IBX Shop view.
NEW_ITEM_ZZ_ PRODUCT_GUID
Global Unique identifier (GUID) for the checked out item. The GUID is referring to the item in the IBX Shop
shopping cart that was checked out using the OCI call. The GUID can be used later in the process to get
information from IBX Shop about the checked-out item.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 22
NEW_ITEM_ZZ_ CALL_OFF_METHOD
Flag to indicate the call-off method. The values 01 to 08 are sent, representing the following:
01 Catalogue
02 Vendor form
03 Requisition
04 Webshop
05 User defined
06 Price check
07 Request: Free request
08 Request: Requisition
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 23
List of fields
Field name
Description
NEW_ITEM-CURRENCY
Currency
NEW_ITEM-CUST_FIELD1
UNSPSC
NEW_ITEM-CUST_FIELD2
Off Catalog Flag
NEW_ITEM-CUST_FIELD3
NEW_ITEM-CUST_FIELD4
NEW_ITEM-CUST_FIELD5
Catalog ID
NEW_ITEM-DESCRIPTION
Product Name
NEW_ITEM-EXT_PRODUCT_ID
Internal Product ID from IBX Shop
NEW_ITEM-EXT_QUOTE_ID
Number of an external bid for this item (as
reference for a subsequent purchase order)
NEW_ITEM-EXT_QUOTE_ITEM
Item of external bid
NEW_ITEM-LEADTIME
Lead Time
NEW_ITEM-LONGTEXT
Product Description
NEW_ITEM-MANUFACTCODE
SRM manufacturer number of the item
NEW_ITEM-MANUFACTMAT
Manufacturer Product No
NEW_ITEM-MATGROUP
UNSPSC, eClass or Buyer Specific Product Category
NEW_ITEM-MATNR
SRM product number of the item
NEW_ITEM-PRICE
Price
NEW_ITEM-PRICEUNIT
PRICE_QUANTITY
NEW_ITEM-QUANTITY
Quantity in order unit
NEW_ITEM-SERVICE
Service Flag
NEW_ITEM-UNIT
Order unit of measure
NEW_ITEM-VENDOR
Vendor ID
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 24
Field name
Description
NEW_ITEM-VENDORMAT
Vendor Product No
NEW_ITEM-VENDORNAME
Vendor Name
NEW_ITEM-ZZ_APPROVAL_FLAG
Approval Flag
NEW_ITEM-ZZ_ASSORTMENT
Assortment
NEW_ITEM-ZZ_BUNDLE_FLAG
Flag to indicate item is bundled
NEW_ITEM-ZZ_BUYER_PRODCAT
Buyer Specific Product Category
NEW_ITEM-ZZ_CALL_OFF_METHOD
Flag to indicate Call-off method
NEW_ITEM-ZZ_CITY1
City
NEW_ITEM-ZZ_CONTACT_NAME1
Free Text Supplier Contact Name
NEW_ITEM-ZZ_CONTENTUNIT
CONTENT_UNIT
NEW_ITEM-ZZ_CONTRACT
Contract title
NEW_ITEM-ZZ_CONTRACTNO
Contract Number
NEW_ITEM-ZZ_COUNTRY1
Country
NEW_ITEM-ZZ_DELIVERYTERMS
Delivery Terms
NEW_ITEM-ZZ_E_MAIL
Free Text Supplier Email
NEW_ITEM-ZZ_FAX_COUNTRY
Fax Country
NEW_ITEM-ZZ_FAX_NO
Free Text Supplier Fax number
NEW_ITEM-ZZ_INTERNAL_NOTE1
Internal Note
NEW_ITEM-ZZ_MATERIALNO
Material Number
NEW_ITEM-ZZ_NAME1
Vendor Name
NEW_ITEM-ZZ_NOCUPEROU
Number of Content Units per Order Unit
NEW_ITEM-ZZ_PCARD_FLAG
Procurement Card Flag
NEW_ITEM-ZZ_PHONE1
Vendor Phone No
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 25
Field name
Description
NEW_ITEM-ZZ_PO_BOX1
POBox
NEW_ITEM-ZZ_POSTALCODE1
PostalCode
NEW_ITEM-ZZ_PROCESS_TYPE
Process Type
NEW_ITEM-ZZ_QUANTITY_INT
Lot Size
NEW_ITEM-ZZ_QUANTITY_MIN
Minimum Order Quantity
NEW_ITEM-ZZ_REASON_FOR_USE
ReasonForUse
NEW_ITEM-ZZ_ROUNDTRP_FLAG
Roundtrip Flag
NEW_ITEM-ZZ_STATE1
State
NEW_ITEM-ZZ_STREET1
Street
NEW_ITEM-ZZ_TIERED_FLAG
Flag to indicate item has tiered pricing
NEW_ITEM-ZZ_VAT
VAT code (%age as decimal) returned from
catalogue
NEW_ITEM-ZZ_VIEW
View ID
NEW_ITEM- ZZ_ PRODUCT_GUID
Global Unique identifier (GUID) for the checked
out item
SUPPLIERMPID
Supplier TPID (Trading Partner ID)
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 26
Summary
Only IBX Shop
Request
IBX Shop + Request
NEW_ITEM-DESCRIPTION
Always sent
Always sent
Always sent
NEW_ITEM-QUANTITY
Always sent
Always sent
Always sent
NEW_ITEM-UNIT
Always sent
Always sent
Always sent
NEW_ITEM-PRICE
Always sent
Always sent
Always sent
NEW_ITEM-CURRENCY
Always sent
Always sent
Always sent
NEW_ITEM-LEADTIME
Always sent
Always sent
Always sent
NEW_ITEM-LONGTEXT
Not always sent
Always sent
Not always sent
NEW_ITEM-VENDOR
Always sent
Always sent
Always sent
NEW_ITEM-VENDORMAT
Always sent
Always sent
Always sent
NEW_ITEM-MANUFACTMAT
Not always sent
N/A
Not always sent
NEW_ITEM-MATGROUP
Always sent
Always sent
Always sent
NEW_ITEM-EXT-PRODUCT_ID
Always sent
N/A
Not always sent
NEW_ITEM-ZZ_ CONTACT_NAME1
Not always sent1
Not always sent2
Not always sent1,2
NEW_ITEM-ZZ_E_MAIL
Not always sent1
Not always sent2
Not always sent2
NEW_ITEM-ZZ_NAME1
Not always sent1
Not always sent2
Not always sent2
NEW_ITEM-ZZ_CONTRACTNO
Not always sent
Not always sent
Not always sent
1.
Sent for User Defined Orders and Vendor Form items if available
2.
If Vendor ID is not available for the vendor this field is included.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 27
Examples
When the end user presses check out in the IBX Shop or IBX Request the following form could be posted to the
HOOK_URL specified in the outbound OCI.
Note: The order of the fields is not fixed.
Note: Fields can be sent with empty values.
Example 1 (Catalogue item from IBX Shop)
The below example is for a catalogue item. Does not include the NEW_ITEM-LONGTEXT field.
<form name="ociform" action=" https://eprocurement.site.com/RecieveOCI.jsp" method="post"
enctype="application/x-www-form-urlencoded; charset=UTF-8">
<input type="text" name="NEW_ITEM-DESCRIPTION[1]" value="Taschenlampe Sabrelite 2000C
Gelb"/>
<input type="text" name="NEW_ITEM-QUANTITY[1]" value="1"/>
<input type="text" name="NEW_ITEM-UNIT[1]" value="EA"/>
<input type="text" name="NEW_ITEM-PRICE[1]" value="43.00"/>
<input type="text" name="NEW_ITEM-CURRENCY[1]" value="EUR"/>
<input type="text" name="NEW_ITEM-LEADTIME[1]" value="1"/>
<input type="text" name="NEW_ITEM-VENDOR[1]" value="B3083820-09AC-11DF-9B0C-C07B56D89593"/>
<input type="text" name="NEW_ITEM-VENDORMAT[1]" value="153176"/>
<input type="text" name="NEW_ITEM-MANUFACTMAT[1]" value="WA142000240"/>
<input type="text" name="NEW_ITEM-MATGROUP[1]" value="39111702"/>
<input type="text" name="NEW_ITEM-EXT_PRODUCT_ID[1]"
value="448f129ad5ebd8903ae85708c1316dbb"/>
</form>
Example 2 (Quote from Request from an ad-hoc vendor)
<form name="ociform" action=" https://eprocurement.site.com/RecieveOCI.jsp" method="post"
enctype="application/x-www-form-urlencoded; charset=UTF-8">
<input type="text" name="NEW_ITEM-DESCRIPTION[1]" value="Java developer"/>
<input type="text" name="NEW_ITEM-QUANTITY[1]" value="1"/>
<input type="text" name="NEW_ITEM-UNIT[1]" value="EA"/>
<input type="text" name="NEW_ITEM-PRICE[1]" value="15000.00"/>
<input type="text" name="NEW_ITEM-CURRENCY[1]" value="EUR"/>
<input type="text" name="NEW_ITEM-LEADTIME[1]" value="1"/>
<input type="text" name="NEW_ITEM-VENDOR[1]" value="8c7d1ea0-7823-1000-b356-c0a87c200001"/>
<input type="text" name="NEW_ITEM-VENDORMAT[1]" value="112233"/>
<input type="text" name="NEW_ITEM-MATGROUP[1]" value="8800000"/>
<input type="text" name="NEW_ITEM-EXT_PRODUCT_ID[1]"
value="448f129ad5ebd8903ae85708c1316dbb"/>
<input type="text" name="NEW_ITEM-ZZ_E_MAIL[1]" value="order@vendorz.com"/> <!-- email
address as entered by user in Request -->
<input type="text" name="NEW_ITEM-LONGTEXT_1:132[]" value="Request: The description
of0000004 v 1. Quote: quote-0000001. Description: Pet Dogs"/>
</form>
Example 3 (Catalogue item from IBX Shop with eForm data)
The below example is for a catalogue item. Does not include the NEW_ITEM-LONGTEXT field.
<form name="ociform" action=" https://eprocurement.site.com/RecieveOCI.jsp" method="post"
enctype="application/x-www-form-urlencoded; charset=UTF-8">
<input type="text" name="NEW_ITEM-DESCRIPTION[1]" value="Taschenlampe Sabrelite 2000C
Gelb"/>
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 28
<input type="text" name="NEW_ITEM-QUANTITY[1]" value="1"/>
<input type="text" name="NEW_ITEM-UNIT[1]" value="EA"/>
<input type="text" name="NEW_ITEM-PRICE[1]" value="43.00"/>
<input type="text" name="NEW_ITEM-CURRENCY[1]" value="EUR"/>
<input type="text" name="NEW_ITEM-LEADTIME[1]" value="1"/>
<input type="text" name="NEW_ITEM-VENDOR[1]" value="B3083820-09AC-11DF-9B0C-C07B56D89593"/>
<input type="text" name="NEW_ITEM-VENDORMAT[1]" value="153176"/>
<input type="text" name="NEW_ITEM-MANUFACTMAT[1]" value="WA142000240"/>
<input type="text" name="NEW_ITEM-MATGROUP[1]" value="39111702"/>
<input type="text" name="NEW_ITEM-EXT_PRODUCT_ID[1]"
value="448f129ad5ebd8903ae85708c1316dbb"/>
<input type="text" name="NEW_ITEM-LONGTEXT_1:132[]" value="Quality=High
Temperature=40
Size=XL
Color=Green"/>
</form>
Encoding
All content is UTF-8 encoded.
Timeout
OCI integration between two applications depends on the end users access to both applications. The shopping
cart is posted from IBX Shop through the browser to the eProcurement system. This requires the user to have
session’s active in both applications in the same browser.
Most web applications have a session timeout value, usually 30 minutes. This means that after 30 minutes of
inactivity the session will be terminated.
This means that if the end user spends too much time in IBX Shop (more than the timeout setting in the
eProcurement system) the session will terminate in eProcurement and it will not be possible to check out the
shopping cart from Shop.
The session timeout in IBX Shop is 60 minutes.
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 29
5 Request OCI inbound
Standard OCI 4.0 fields
NEW_ITEM-DESCRIPTION - Item name
NEW_ITEM-QUANTITY - Item quantity
NEW_ITEM-UNIT - Item unit of measure
NEW_ITEM-PRICE - Item price
NEW_ITEM-CURRENCY - Item currency
NEW_ITEM-VENDORMAT - vendor product number. It’s the Supplier reference field on the items tab in Request.
NEW_ITEM-LINE - The position of the item in the shopping cart
NEW_ITEM-CUST_FIELD1 - Product group code or 99999999 depending on what the user wants to be sent
NEW_ITEM-MATGROUP - Product group code or 99999999 depending on what the user wants to be sent
NEW_ITEM-LEADTIME - Item lead time
NEW_ITEM-CUST_FIELD5 - Account code. The account code will be the first non-null, non-empty value out of:

the account code of the categorization rule for the quote's supplier

the account code of the quote's supplier

"REQUEST" string
NEW_ITEM-EXT_QUOTE_ID - The id of the supplier quote
NEW_ITEM-VENDOR - Vendor id. If vendor id is empty REDSUPPLIE sting will be sent
NEW_ITEM-CUST_FIELD7 - 1 if the supplier is open marketplace, 0 otherwise
NEW_ITEM-CUST_FIELD2 - "Quote description" text followed by the quote displayable id (e.g. 00000358 v 1).
NEW_ITEM-LONGTEXT_n:132[]- request id, followed by quote id, followed by item description, followed by the
eForm fields (if the “enable checkout of eform fields” option is enabled on Request side)
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 30
IBX specific OCI fields
NEW_ITEM-ZZ_STANDARD_PRODCAT - sent as it was received
NEW_ITEM-ZZ_SPECIFIC_PRODCAT - product group code
NEW_ITEM-ZZ_BUYER_PRODCAT - product group code
NEW_ITEM-ZZ_PROCESS_TYPE - Always sent with the fixed value ‘REQUEST’
NEW_ITEM-ZZ_SUPPLIERTYPE - sent as it was received
NEW_ITEM-ZZ_AGREEMENTTYPE - sent as it was received
NEW_ITEM-ZZ_AGREEMENT_ID - sent as it was received
NEW_ITEM-ZZ_DELIVERYTERMS - sent as it was received
NEW_ITEM-ZZ_ASSORTMENT - sent as it was received
NEW_ITEM-ZZ_VIEW - Shop view (BORG)
NEW_ITEM-ZZ_SE_CUST_FIELDS_XML - sent as it was received
NEW_ITEM-ZZ_INTERNAL_PRODUCT_ID - sent as it was received
NEW_ITEM-ZZ_NAME1 – supplier organisation name
NEW_ITEM-ZZ_E_MAIL – supplier contact email
NEW_ITEM-ZZ_CONTACT_NAME1 - name of the supplier contact person
NEW_ITEM-ZZ_CONTRACTNO - supplier agreement number
NEW_ITEM-ZZ_CALL_OFF_METHOD - 06 for price check, 07 for free request, 08 for purchase requisition
OCI SPECIFICATION
The information contained in this document is proprietary. Copyright © 2015 Capgemini. All rights reserved.
Page 31
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising