| Oracle® Retail Xstore Suite 19.0/Oracle® Retail Merchandising Suite 19.1.000 Implementation Guide Release 19.0 F32771-04 |
|
 Previous |
 Next |
| Oracle® Retail Xstore Suite 19.0/Oracle® Retail Merchandising Suite 19.1.000 Implementation Guide Release 19.0 F32771-04 |
|
Previous |
Next |
This chapter describes the RTLog Generator component of Xstore Office Cloud. The RTLog Generator Cloud application can be used with both the cloud or on premise Merchanding/Pricing applications.
This chapter describes how configure the RTLog Generator application deployed on cloud.
The RTLog Generator on cloud is a Java and XML based web application that exposes a Spring-JAXWS implemented SOAP web service and JAXRS implemented REST web services. It is distributed as a web archive along with a configuration .zip file ready to be deployed on an Oracle WebLogic 12c server. It is usually deployed alongside the other Xstore office cloud applications.
The RTLog Generator cloud application can be configured in the following way.
Customize the RTLog Generator's mapping configuration via REST services.
|
Note: For more information on how to customize the RTLog Generator, see the Configuration section in Chapter 6, "RTLog Generator On Premise" and the Retail Xstore - RTLog Generator Extension Guidelines (Doc ID 2174095.1) onhttps://support.oracle.com. |
This section describes the RTlog Generator Cloud integration.
RTLog Generator Cloud application provides three REST services to retrieve, update and delete the RTLogMappingConfig.xml file. All the three services point to the URL at
https://<hostname>/rtlog-generator/rest/config/file/v1/RTLogMappingConfig
A new property configUploadDir is added to rtlogconfig.properties.
If RTLog generator is deployed on cloud, its mapping configuration file RTLogMappingConfig.xml is not accessible to a user. To customize the mapping, restful APIs are provided to upload a customized RTLogMappingConfig.xml to override the default out-of-box one. This directory specifies the upload directory to host the customized mapping file. In a cluster environment with multiple RTLogGen nodes, all nodes must be configured to point to the same config upload directory on shared file system. This is to ensure that once a mapping file is uploaded, it is visible to all the nodes.
#### #### (uncomment and configure this if and only if you are setting up a cluster of RTLogGen nodes on cloud) #### ####configUploadDir = DIR/rtlogconfig_upload
Table 7-1 REST Services related to the RTLogMappingConfig.xml
| HTTP Protocol | Security Protocol | Response Type | Description |
|---|---|---|---|
|
GET |
OAuth2 |
application/xml |
Returns the active RTLogMappingConfig.xml file. If the customer has not uploaded a customized configuration xml file yet, provides a copy of the default mapping configuration XML file that is provided with the deployment. |
|
PUT |
OAuth2 |
application/json |
Customer submits the updated RTLogMappingConfig.xml file as the request body. Returns JSON that contains the number of bytes in the uploaded XML file. |
|
DELETE |
OAuth2 |
No content |
If the customer has uploaded a configuration XML file previously, it will be deleted and HTTP 200 status is returned. If there is no customized RTLogMappingConfig.xml file active yet, HTTP 204 status is returned. The default RTLogMappingConfig.xml that is part of the deployment will resume being the active mapping configuration. |
The examples below show how to retrieve and update the RTLogMappingConfig.xml.
Example 7-1 Get active RTLogMappingConfig.xml - Get Current RTLog Mapping Configuration
$ curl -H "Authorization: Bearer <token>" https://<rlog-generator-host>/rtlog-generator/rest/config/file/v1/RTLogMappingConfig" > RTLogMappingConfig.xml
Example 7-2 Update RTLogMappingConfig.xml - Update the RTLog Mapping Configuration
$ curl -H "Authorization: Bearer <token>" -X PUT -T "/path/to/mapping/file" https://<rlog-generator-host>/rtlog-generator/rest/config/file/v1/RTLogMappingConfig"
Similar to the example above, using the -X option with the value of DELETE will delete any customer uploaded mapping configuration XML file.
RTLog Generator Cloud application's ability to provide a mechanism to retrieve the published RTLog files varies depending on the type of Sales Audit application that it is integrated with.
For Merchandising on cloud, SFTP process is used to transfer the files
SFTP credentials to connect to the Merchandising's SFTP directory on cloud are made available to the RTLog Generator Cloud deployment team.
SFTP connectivity utilizes public/private key based authentication.
Cloud Application Management is responsible for SFTP credentials rotation.
For Sales Audit on premise, REST service provides the way to download the files.
For Cloud Release 19.1, there is no coupling of RTLog delivery target (ReSA on cloud or ReSA on-premises) with delivery method (SFTP or rest service). RTLog generator's chef script allows a user to make two separate choices:
If the delivery target is ReSA on cloud or ReSA on-premises.
If the preferred delivery method is through SFTP or REST.
RTLog Generator's web services are secured by requiring HTTPS protocol for transport layer security and require OAuth2 authentication for application level security. All of the Xoffice applications on cloud including the RTLog Generator have a valid OAuth Client (Application) registered with a specific tenant of the Oracle Identity Cloud Service. Sales Audit is required to do the same in order to communicate with the RTLog Generator application via REST web services.
OAuth2 authentication is a two-step process.
Acquire a valid OAuth2 Bearer token using the IDCS or OCI IAM Client Credentials.
Provide the token value in the HTTP Authorization header for all of the web service requests until the token's validity is expired.
In order to acquire a valid IDCS or OCI IAM token, the following information is needed beforehand.
IDCS or OCI IAM tenant host information to build the URL for requesting a token
https://<IDCS_TENANT_HOST>/oauth2/v1/token
ClientID and ClientSecret for the RTLog Generator Client App (that is Sales Audit).
A command line utility or any software that can make HTTP requests with the ability to setup specific header values
"curl" in Linux environments
Access to a command/utility to encode the credentials in base64 format.
"base64" command in Linux environments
"certutil" command in Windows environments
The following example shows how to request a token using the curl command line tool in a Linux environment. Ensure to replace the clientID, clientSecret and IDCS_TENANT_HOST with the appropriate values.
Example 7-3 Request IDCS Oauth2 Token - OAuth2 Token Request
$ curl -i -H "Authorization: Basic $(echo -n clientID:clientSecret | base64)" -H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8" https://<IDCS_TENANT_HOST>/oauth2/v1/token -d "grant_type=client_credentials&scope=urn:opc:idm:__myscopes__"
You may generate Base64 encoded text of the "clientID:clientSecret" ahead of the request and use it directly in the curl command for the Basic Authorization header value. The following example shows the response that contains the token.
Example 7-4 IDCS Oauth2 Token Response - OAuth2 Token Response
{"access_token": "<oauth2_token>",
"token_type": "Bearer",
"expires_in": 3600 }
The response above shows the token value and the expiration time in seconds. Usually, the token is a sequence of random characters of varying length up to a maximum of 16K.
The following example shows how to provide the OAuth2 token while communicating with RTLog Generator REST services. The following example shows how to request the current active RTLogMappingConfig.xml file. Please make sure to replace the "<token>" with a valid OAuth2 token acquired in the last step and provide the correct RTLog Generator Host value.
