| Oracle® Retail Xstore Office Cloud Service Administration Guide Release 19.10 F89727-01 |
|
 Previous |
 Next |
| Oracle® Retail Xstore Office Cloud Service Administration Guide Release 19.10 F89727-01 |
|
Previous |
Next |
This chapter describes how to set up Xstore Office Cloud Service.
After the environments are provisioned, customers can file a service requests (SR) through the Oracle Ticketing System Service Requests for the following operations:
Adding additional Org IDs
Update Merchandise Hierarchy
Install RTLog Generator
Integrating Oracle Retail Xstore Office Cloud Service (XOCS) with
Omnichannel Cloud Data Service (OCDS),
Oracle Retail Order Broker (OROB),
Oracle Retail Customer Engagement (ORCE),
Oracle Retail XBRi
By default Xstore Office Cloud Service is setup with a default organization ID. If you want to setup additional organization IDs or do not want to use the default organization ID, see the Organization Management section in the Oracle Retail Xstore Office Cloud Service User Guide, for more information about how to add an organization ID.
|
Note: Org IDs cannot be changed, only added. |
If the default merchandise hierarchy level labels need to be modified, customers can submit an SR with the following information:
Environment where this change needs to be made (Dev/Stage/Prod)
Specify the Merchandise Hierarchy Levels.
Example:
INPUT_1 -> Number of Levels available in the Merchandise Hierarchy: [4 ] INPUT_2 -> Level1 code: [GROUP] INPUT_3 -> Level2 code: [DEPARTMENT] INPUT_4 -> Level3 code: [CLASS] INPUT_5 -> Level 4 code: [SUBCLASS]
|
Note: Translation properties files for each language used, will have to be uploaded through the Customization Management feature in the Xadmin UI.Translation files are uploaded as a .zip file. Within the .zip file, all translation files must be in a version1 folder. |
RTLog generator for integration with Sales Audit (ReSA) is not installed by default during provisioning.
Customers need to submit an SR for installation of the rtlog generation and specify if they want to integrate with ReSA CLOUD (through SFTP), or ReSA ON-PREMISES (through REST API)
The SR should contain the following information:
Environment where this change needs to be made (Dev/Stage/Prod)
RTLog Generator RESA integration type: Type of Integration (ReSA CLOUD or ReSA ON-PREMISES)
RTLog Generator Data Transfer Protocol: REST or SFTP
If the Data Transfer Protocol is SFTP, then:
RESA SFTP Host: SFTP Host name (CLOUD only)
RESA SFTP User: SFTP username (CLOUD only)
RESA SFTP working directory: SFTP working directory (CLOUD only)
Integrating with OCDS, OROB, ORCE and XBRi although done through Xadmin UI (refer to the Oracle Retail Xstore Office Cloud Service User Guide) requires that the retailer submits an SR for Oracle Cloud networking to allow the OCDS, OROB, ORCE, XBRi endpoints/sftp with the Oracle outbound proxy.
The SR should contain the following information:
Environment where this change needs to be made (Dev/Stage/Prod)
Indicate the Cloud Service with which to integrate, the endpoints or the sftp
A fully provisioned account must have both a production environment and a staging environment. No one other than Oracle Cloud Operations (CloudOps) personnel can have direct access to any of the cloud environments.
Implementation teams access Xstore Office Cloud Service through the Xadmin UI or through REST web service APIs. See the Oracle Retail Xstore Suite Services Guide and the Oracle Retail Xstore Office Cloud Service User Guide for detailed information on features available in Xstore Office Cloud Service.
Figure 3-1 below shows the integration data flows and the corresponding webservices APIs that are available in Xstore Office Cloud Service.
As you can see from the diagram in Figure 3-1 Xstore Office Cloud Service does not have its own SFTP server.
Xstore Office Cloud Service does not use a WebDAV server for file deployments and pospoll uploads.
To get data from/upload data to XOCS the retailer will need to use the REST APIs documented in the Oracle Retail Xstore Suite Services Guide (My Oracle Support Doc ID: 1994467.1). The guide has details on invoking the File Rest API to PUT/GET/DELETE and view listing of the files in containers.
Another thing worth mentioning is that XOCS environments are provisioned with empty Xcenter and Replication databases and minimum required data in Xadmin database.
It will be responsibility of the retail/SI partner teams to load data in XOCS. Refer to Data Seeding on how to load data in XOCS.
At the time of provisioning, the client is provided with an administrative user account (Delegated Customer Admin) on all cloud environments. Each user on the system, including anyone involved with the implementation requiring access to the system, must be provided with an individual account on the service. Accounts can be requested from the Customer Admin on the account. See User Setup for more details.
In order to invoke the REST APIs provided by XOCS you first need to setup an OAuth Client.
Follow the instructions in the Oracle Retail Xstore Office Cloud Service Security Guide to create an OAuth Client. Specifically the "Xstore Office Setup App".
Example with curl
https://docs.oracle.com/cd/F13595_01/xocs/pdf/198/xstoreofficecs-1910-sg.pdf
See the Xcenter Endpoints section of the Oracle Retail Xstore Suite Services Guide (My Oracle Support Doc ID: 1994467.1) for details and examples on invoking the File Rest API to PUT/GET/DELETE and view listing of the files in containers.
After the environments are provisioned the retailer/SI partners will need to load data in Xstore Office Cloud Service.
The data types are generally loaded either through OCDS (when using Oracle Merchandising and Pricing cloud Services), REST APIs or Xadmin UI (not recommended).
Organization Hierarchy is the first data set that needs to be loaded in Xstore Office Cloud Service. Organization Hierarchy is required in order for the primary Xadmin user to be able to assign roles for other Xadmin users for specific organizations.
The provisioning process or Adding Additional Organization IDs should have set up the merchant's organization IDs.
Further creation of the hierarchy can be done via Xadmin UI or uploaded via REST (.mnt and/or .xload file format).
See the Oracle Retail Xstore Office Cloud Service User Guide on more information about managing the organization hierarchy through Xadmin UI:
See the Web Service Access and Usage section for information on how to create an OAuth client and invoke the REST APIs.
|
Note: At least the top level node (*:*) for an organization needs to be setup via one way mentioned above.Organization Hierarchy is required even when XOCS is integrated with OCDS, even though the integration with OCDS is expected to bring the entire organization hierarchy data into Xstore Office Cloud Service. |
Once the organization hierarchy is loaded you can:
Configure the integrations for OCDS, OROB, ORCE and/or configure the broadcasters (refer to the Setup Integrations section in this document)
Setup users (refer to the User Setup section in this document)
Continue to load the other data (tax location, retail stores, items, departments and so on). Refer to the Other Retail Data section below.
This section describes other retail data.
Before loading the retail stores, tax location data set will have to be loaded via a data load file (.mnt, .xload) or through REST API.
See the example below for a sample of a Tax Location:
<Header line_count="13" download_id="123" application_date="2018-11-06" /> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-1000"/><fld id="CreateDate" val="1525803068534"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="Ohio Tax Location"/><fld id="Name" val="Ohio Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-2000"/><fld id="CreateDate" val="1525803068538"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="Illinois Tax Location"/><fld id="Name" val="Illinois Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-AT"/><fld id="CreateDate" val="1525803068540"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="AT Tax Location"/><fld id="Name" val="AT Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-BR_SP"/><fld id="CreateDate" val="1525803068559"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="Brazil State - SAO PAULO"/><fld id="Name" val="Brazil State - SAO PAULO"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-DE"/><fld id="CreateDate" val="1525803068542"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="DE Tax Location"/><fld id="Name" val="DE Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-ES"/><fld id="CreateDate" val="1525803068543"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="ES Tax Location"/><fld id="Name" val="ES Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-FR"/><fld id="CreateDate" val="1525803068545"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="FR Tax Location"/><fld id="Name" val="FR Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-GB"/><fld id="CreateDate" val="1525803068547"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="GB Tax Location"/><fld id="Name" val="GB Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-IT"/><fld id="CreateDate" val="1525803068549"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="IT Tax Location"/><fld id="Name" val="IT Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-MX"/><fld id="CreateDate" val="1525803068555"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="MX Tax Location"/><fld id="Name" val="MX Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-NL"/><fld id="CreateDate" val="1525803068551"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="NL Tax Location"/><fld id="Name" val="NL Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-PT"/><fld id="CreateDate" val="1525803068553"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="PT Tax Location"/><fld id="Name" val="PT Tax Location"/><originDS>Local</originDS></dao></ConfigData> INSERT~XML_PERSISTABLES~<ConfigData><dao name="TaxLocation" cmd="INSERT_OR_ UPDATE|UPDATE"><fld id="OrganizationId" val="10"/><fld id="TaxLocationId" val="TL-SE"/><fld id="CreateDate" val="1525803068557"/><fld id="CreateUserId" val="XADMIN"/><fld id="UpdateDate" val="1541542977883"/><fld id="UpdateUserId" val="XADMIN"/><fld id="OrgCode" val="*"/><fld id="OrgValue" val="*"/><fld id="Description" val="SE Tax Location"/><fld id="Name" val="SE Tax Location"/><originDS>Local</originDS></dao></ConfigData>
If integrations to Oracle Retail Merchandise Cloud Service have been set up, data will be loaded through OCDS. See the Oracle Retail Xstore Suite 19.0/Merchandising Suite 19.0 Implementation Guide for more information.
Stores can be created either through Xadmin UI, upload via REST (.mnt, .xload) or through OCDS (if the integration with Oracle Retail Merchadising Cloud Service has been set up).
See the Oracle Retail Xstore Office Cloud Service User Guide on more information about managing retail stores through Xadmin UI.
Data can be deployed to the Xcenter database (and stores) by using the REST web service to put a file in the "autodeploy" directory. Review the details of the service in the Oracle Retail Xstore Suite Services Guide from the online documentation. For more information about the "autodeploy" feature, see the Oracle Retail Xstore Office Cloud Service User Guide on how to Automatically Deploy Data Manager Changes and Data Manager Automatic Deployment Time.
Call this service via REST like PUT: https://CLOUDHOST:443/xcenter/rest/MyMerchCode/v1/file/autodeploy/1000/mydatafile.mnt
See the Web Service Access and Usage section for information on how to create an OAuth client and invoke the REST APIs.
A Customer Administration User will be created as part of the Xstore Office Cloud Service provisioning process. Before end users can access the Xstore Office Cloud Service application it is necessary to create and provision users. This includes provisioning access to the system, assigning organizations, a role and org nodes to each user to control what functionality will be available to them.
Upload an org hierarchy .mnt file(s) by invoking the File Resource REST API before trying to setup users. Details on the File Resource REST API are in the Oracle Retail Xstore Suite Services Guide. Details on the credentials needed for invoking any REST API is in the Oracle Retail Xstore Office Cloud Service Security Guide.
Users can be created via the Identity Cloud Service (IDCS)/Oracle Cloud Infrastructure Identity and Access Management (OCI IAM) UI. Refer to the Oracle Cloud Administering Oracle Identity Cloud Service Guide and the Oracle Cloud Infrastructure Documentation on the steps how to create users via the Identity Cloud Service (IDCS) UI.
The ability to add and edit users through the Xadmin UI is no longer available. The users are synchronized from IDCS/OCI IAM at a configurable interval. The Xadmin UI still supports the ability to assign locales, organizations, roles and organization nodes to a user (see the Oracle Retail Xstore Office Cloud Service User Guide).
User roles, role groups, and security configurations in general are administered through the Xadmin User Management UI (see the Oracle Retail Xstore Office Cloud Services User Guide).
Most of the integrations (with the exception of Sales Audit ReSA) can be configured through the Xadmin UI.
Refer to the Integrations chapter in this document for more information.
Any Xstore register that communicates with Xstore Office Cloud Service must first be enrolled in IDCS/OCI IAM via Xstore Office Cloud Service. This can be done either via Xadmin or Xenvironment. Refer to the Oracle Retail Xstore Office Cloud Service Security Guide about the steps to be followed for Cloud Enrollment of Xstore Clients.
