| Oracle® Retail POS Suite Implementation Guide, Volume 4 – Point-of-Service External Order Release 14.1 E54477-01 |
|
 Previous |
 Next |
| Oracle® Retail POS Suite Implementation Guide, Volume 4 – Point-of-Service External Order Release 14.1 E54477-01 |
|
Previous |
Next |
All communication between Oracle Retail Point-of-Service and Siebel is initiated by Point-of-Service. Communication is accomplished using synchronous web service calls.
This chapter provides information about relevant field usage in requests and responses.
Description: Requests all active order headers for my store in Ready To Tender status.
Table 4-1 My Store Only–Order Header Request
| Field | Value | Comment |
|---|---|---|
|
ListOfORPOS_Order_Entry_Io.pagesize |
50 |
Set using parameter: External Order / External Order Maximum Matches |
|
OrderEntry-Orders.Status |
Ready To Tender |
Set using ExternalOrderMapping.xml: Status -> Order -> Searchable |
|
OrderEntry-Orders.Active |
Y |
NA |
Table 4-2 MY Store Only–Order Header Response
| Field | Comment |
|---|---|
|
ListOfORPOS_Order_Entry_Io.recordcount |
Indicates number of Order records in response |
|
OrderEntry-Orders.Id |
NA |
|
OrderEntry-Orders.Created |
NA |
|
OrderEntry-Orders.Account |
NA |
|
OrderEntry-Orders.ContactFirstName |
NA |
|
OrderEntry-Orders.ContactLastName |
NA |
|
OrderEntry-Orders.ContactWorkPhone |
NA |
|
OrderEntry-Orders.OrderNumber |
NA |
|
OrderEntry-Orders.OrderTotal |
NA |
Description: Requests all active order headers for my store in Ready To Tender status.
Table 4-3 Advanced Search–Order Header Request
| Field | Value | Comment |
|---|---|---|
|
ListOfORPOS_Order_Entry_Io.pagesize |
50 |
Set using Parameter: External Order / External Order Maximum Matches |
|
OrderEntry-Orders.Status |
Ready To Tender |
Set using ExternalOrderMapping.xml: Status -> Order -> Searchable |
|
OrderEntry-Orders.Active |
Y |
NA |
|
OrderEntry-Orders.Account |
<User supplied> |
Case-insensitive wildcard search |
|
OrderEntry-Orders.ContactFirstName |
<User supplied> |
Case-insensitive wildcard search |
|
OrderEntry-Orders.ContactLastName |
<User supplied> |
Case-insensitive wildcard search |
|
OrderEntry-Orders.ContactWorkPhone |
<User supplied> |
NA |
|
OrderEntry-Orders.OrderNumber |
<User supplied> |
Case-insensitive wildcard search |
Table 4-4 Advanced Search–Order Header Response
| Field | Comment |
|---|---|
|
ListOfORPOS_Order_Entry_Io.recordcount |
Indicates number of records in response |
|
OrderEntry-Orders.Id |
NA |
|
OrderEntry-Orders.Created |
NA |
|
OrderEntry-Orders.Account |
NA |
|
OrderEntry-Orders.ContactFirstName |
NA |
|
OrderEntry-Orders.ContactLastName |
NA |
|
OrderEntry-Orders.ContactWorkPhone |
NA |
|
OrderEntry-Orders.OrderNumber |
NA |
|
OrderEntry-Orders.OrderTotal |
NA |
Description: Requests an order detail for a specific order.
Table 4-5 Select Order–Order Detail Request
| Field | Value | Comment |
|---|---|---|
|
OrderEntry-Orders.id |
<User supplied> |
NA |
|
OrderEntry-Orders.Status |
Ready To Tender |
Set using ExternalOrderMapping.xml: Status -> Order -> Searchable |
|
OrderEntry-Orders.Active |
Y |
NA |
|
ListOfOrderEntry-LineItems.pagesize |
50 |
Set using DefaultConnectorTechnician: SiebelOrderQueryFormatter -> maxLineItems. |
Table 4-6 Select Order–Order Detail Response
| Field | Comment |
|---|---|
|
OrderEntry-Orders.Id |
NA |
|
OrderEntry-Orders.Created |
NA |
|
OrderEntry-Orders.Account |
NA |
|
OrderEntry-Orders.AgreementId |
NA |
|
OrderEntry-Orders.ContactFirstName |
NA |
|
OrderEntry-Orders.ContactLastName |
NA |
|
OrderEntry-Orders.Freight |
NA |
|
OrderEntry-Orders.OrderNumber |
NA |
|
OrderEntry-Orders.OrderTotal |
NA |
|
ListOfOrderEntry-LineItems.recordcount |
Indicates number of line-item records in response |
|
OrderEntry-LineItems.Id |
NA |
|
OrderEntry-LineItems. ActionCode |
NA |
|
OrderEntry-LineItems.CarrierCode |
NA |
|
OrderEntry-LineItems.CarrierPriority |
NA |
|
OrderEntry-LineItems.LineNumber2 |
NA |
|
OrderEntry-LineItems.NetPrice |
NA |
|
OrderEntry-LineItems.ParentProductId |
NA |
|
OrderEntry-LineItems.PartNumber |
NA |
|
OrderEntry-LineItems.PriceType |
NA |
|
OrderEntry-LineItems.Product |
NA |
|
OrderEntry-LineItems.QuantityRequested |
NA |
|
OrderEntry-LineItems.ServiceId |
NA |
|
OrderEntry-LineItems.ShipToAccountId |
NA |
|
OrderEntry-LineItems.ShipToAddressId |
NA |
|
OrderEntry-LineItems.ShipToContactId |
NA |
|
OrderEntry-LineItems.ShipToAddress |
NA |
|
OrderEntry-LineItems.ShipToAddress2 |
NA |
|
OrderEntry-LineItems.ShipToCity2 |
NA |
|
OrderEntry-LineItems.State2 |
NA |
|
OrderEntry-LineItems.Country2 |
NA |
|
OrderEntry-LineItems. ShipToZip2 |
NA |
Description: Requests an update to an order's status indicating Point-of-Service client has reserved the order for tendering.
Table 4-7 Update Order Status–Lock Order Request
| Field | Value | Comment |
|---|---|---|
|
OrderEntry-Orders.id |
<System supplied> |
NA |
|
OrderEntry-Orders.Status |
Tender In Process |
Set using ExternalOrderMapping.xml: Status -> Order -> Lock |
|
Note: To use a Siebel status other than Tender In Process to indicate an order is being processed by Point-of-Service, change the status of Lock in ExternalOrderMapping.xml to the desired status. |
Description: Requests an update to an order's status to indicate cancel button was pressed in Point-of-Service client while in the process of tendering Siebel Order.
Table 4-9 Update Order Status–Cancel Order Request
| Field | Value | Comment Update Order Status–Cancel Order Request |
|---|---|---|
|
OrderEntry-Orders.id |
<System supplied> |
NA |
|
OrderEntry-Orders.Status |
Ready To Tender |
Set using ExternalOrderMapping.xml: Status -> Order -> Cancel |
|
Note: To use a Siebel status other than Ready To Tender to indicate the locking of an order by Point-of-Service has been cancelled, change the status of Cancel in ExternalOrderMapping.xml to the desired status. |
Description: Requests an update to an order's status to indicate Point-of-Service is unable to accept order as valid for tendering operation.
Table 4-11 Update Order Status–Reject Order Request
| Field | Value | Comment |
|---|---|---|
|
OrderEntry-Orders.id |
<System supplied> |
NA |
|
OrderEntry-Orders.Status |
Pending |
Set using ExternalOrderMapping.xml: Status -> Order -> Reject |
|
Note: To use a Siebel status other than Pending to indicate Point-of-Service has rejected an order because it is in a state where it cannot be processed for tendering, change the status of Reject in ExternalOrderMapping.xml to the desired status. |
Description: Requests an update to an order's status to indicate Siebel is unable to accept a Point of Service request to update an order in Siebel with details about the tendered order.
Table 4-13 Update Order Status–Funded Failed Request
| Field | Value | Comment |
|---|---|---|
|
OrderEntry-Orders.id |
<System supplied> |
NA |
|
OrderEntry-Orders.Status |
Funded Failed |
Set using ExternalOrderMapping.xml: Status -> Order -> Funded Failed |
|
Note: To use a Siebel status other than Pending to indicate Point-of-Service has rejected an order because it is in a state where it cannot be processed for tendering, change the status of Funded Failed in ExternalOrderMapping.xml to the desired status. |
Description: Requests an update to an order's status and detail to indicate Point-of-Service successfully tendered sale.
Table 4-15 Update Order Status and Detail–Funded Order Request
| Field | Value | Comment |
|---|---|---|
|
OrderEntry-Orders.id |
<System supplied> |
NA |
|
OrderEntry-Orders.Freight |
<System supplied> |
NA |
|
OrderEntry-Orders.IntegrationId |
<System supplied> |
Point-of-Service transaction number |
|
OrderEntry-Orders.TaxAmount |
<System supplied> |
NA |
|
OrderEntry-Orders.DiscountAmount |
<System supplied> |
Returned Amount Total. Used only when FundedOrderFormatter's useAdjustmentNRC property is set to true. |
|
OrderEntry-Orders.Status |
Funded |
Set using ExternalOrderMapping.xml: Status -> Order -> Funded |
|
OrderEntry-LineItems.Id |
<System supplied> |
Set to "" if store delivered, that is, store shipped or store-not-shipped. |
|
OrderEntry-LineItems.CarrierCode |
<System supplied> |
Set to "" if store delivered, that is, store shipped or store-not-shipped. |
|
OrderEntry-LineItems.IntegrationId |
<System supplied> |
Point-of-Service LineItem Line Number |
|
OrderEntry-LineItems.ShipCompleteFlag |
<System supplied> |
Set to true if store delivered/shipped; otherwise, false if warehouse shipped |
|
OrderEntry-LineItems.ShipInstrustions |
<System supplied> |
Not set for Warehouse shipped items, otherwise set using ExternalOrderMapping.xml: Shipping -> Instruction |
|
OrderEntry-LineItems.ShipToAccountId |
<System supplied> |
Set to "" if store delivered, that is, store shipped or store-not-shipped. |
|
OrderEntry-LineItems.ShipToAddressId |
<System supplied> |
Set to "" if store delivered, that is, store shipped or store-not-shipped. |
|
OrderEntry-LineItems.ShipToContactId |
<System supplied> |
Set to "" if store delivered, that is, store shipped or store-not-shipped. |
Description: Requests an update to an order's payment details to add tender information collected by Point-of-Service.
Table 4-17 Update Order Payment Detail–Order Payment Request
| Field | Value | Comment |
|---|---|---|
|
OrderEntry-Orders.id |
<System supplied> |
NA |
|
Payments.PaymentMethod |
<System supplied> |
NA |
|
Payments.PaymentStatus |
<System supplied> |
Set using ExternalOrderMapping.xml: Status -> Payment |
|
Payments.TransactionAmount |
<System supplied> |
NA |
All requests sent to Siebel from Point-of-Service request the language-independent code (LIC) LOVLanguageMode.
All Update requests sent to Siebel are sent using the view mode All. All Query requests sent to Siebel use view modes configured in DefaultConnectorTechnician.xml. For example, to limit visibility of Siebel Orders searched using the mystore user to the mystore user's organization, set myStoreViewMode to Organization:
<FORMATTER name="SiebelOrderQueryFormatter"…
<PROPERTY propname="myStoreViewMode" propvalue="Organization"/>
<PROPERTY propname="globalViewMode" propvalue="All"/>
…
</FORMATTER>
All Update requests sent to Siebel are sent using the view mode All. All Query requests sent to Siebel use view modes configured in DefaultConnectorTechnician.xml.
The OPROS store structure must be correctly mapped to the Siebel organization structure to facilitate proper access control for the integrity of the data.
Sales reps from a store must have access to the orders created in that store. The manager of the store will have extra privileges to process the orders.
A position is a job title in a division of an organization. A position hierarchy represents reporting relationships among positions. Positions provide an appropriate basis for access control in many scenarios, as a position in an organization is typically more stable than the individual's assignment to the position.
Customer data and some types of referential data can be associated with one or more positions. If individual data can be associated with a position, then you can apply position access control to the data by one or more of the following means:
Single-position access control–You can associate a single position to individual data records.
Team access control–You can associate multiple positions, in the form of a team, to individual data.
Manager access control–You can grant access concurrently to data associated with a position and data associated with subordinate positions in a reporting hierarchy.
An employee can be associated with one or more positions, of which only one can be the active position at a given time. All types of position access control for an employee are determined by the active position. One of the user's positions is designated as the primary position. When a user logs in, the primary position is the active position.
You can indirectly associate a position with data associated with subordinate positions in a reporting hierarchy. For example, an employee with a particular active position can see orders associated with that position and orders associated with subordinate positions.
Manager-subordinate relationships are determined from a position hierarchy. You can specify one parent position for a position, which represents that the position is a direct report to the parent. The parent of an internal position may be in the same division or a different division. For example, a sales manager in the Sales division may report to a sales vice president in the Corporate division.
In a view using manager access control, this employee or partner user has access to data according to the following behavior:
If the business component on which the view is based uses single-position access control, the user sees data associated directly with the user's active position or with subordinate positions.
If the business component on which the view is based uses team access control, then the user sees data for which the user's active position is on the team or any subordinate position that is the primary member on the team. This is the standard behavior, known as primary manager visibility.
A business component using team access control can be configured to allow the user to see data for all subordinate positions, regardless of whether they are the primary position for a record. This is known as non-primary manager visibility. The basic Siebel application is not set up for this mode.
Logins and passwords are created on the primary manager visibility or organization visibility, thus restricting the access to the customer data pertaining to that store.
A responsibility corresponds to a set of views. Each user must be assigned at least one responsibility. When you assign responsibilities to a user, the user has access to all the views contained in all of the responsibilities assigned to the user and that are also included in the user's current application.
If a view in an application is not included in a user's responsibilities, the user will not see the view or a listing of the view in the Site Map, in the link bar, or in any other picklist. If the user does not have access to any of the views in a screen, then that screen's listing in the Site Map and its screen tab are not displayed.
For example, the responsibility assigned to an administrator might include the views in the Administration - Application screen. The administrator sees this screen listed in the Site Map and can navigate to the views it includes. A customer care agent typically does not have administrative views in a responsibility, so the agent would not see this screen or its views listed in any context. Each user's primary responsibility also controls the default screen or view tab layout for the user. A user can have one or more responsibilities. The user has access to all the views in the union of all the responsibilities assigned. For example, you could assign to a sales manager both the Sales Manager responsibility and the Field Sales Representative responsibility.
