1 Administrative Tasks

This chapter describes the processes for maintaining users and roles as well as batch processes. For information regarding standard end user activities like creating and viewing reports, please see the Oracle Retail Insights User Guide.

Oracle Support

It is considered to be a best practice to have all Oracle Retail Insights Cloud Service Suite supports requests submitted through a single point of contact for that customer environment; the client designated administrator is usually designated to perform this role.

The link to use when submitting Service Requests (SR) is:

https://support.oracle.com

User Creation

Before users can access the Oracle Retail Insights Cloud Service Suite applications it is necessary to provision each user access to the system, and assign roles to each user to control what functionality will be available to them. The access provisioning is done using Oracle Identity Management (OIM). The following steps explain how to define users, assign roles and revoke access for users when needed. The OIM Application URL and the login with the required administrator access would be needed to execute the below steps:

1. Log into the OIM application.

2. Under Administration, click Users.

   Figure 1-1 Select Users

   
   

3. Under Actions, click Create.

   Figure 1-2 Select Create

   
   

   The Create User screen appears.

4. Under Basic Information, enter the following:

   • First Name

   • Last Name

   • For Organization, enter Retail

   • For User Type, enter Full time employee

   • E-mail: Email address of the employee

5. Under Account Settings, enter:

   • User Login: <firstname>.<lastname>

   • Password:

   • Confirm Password

   Figure 1-3 Complete User Information

   
   

6. Click Submit.

Assigning Members to a Role

To assign members to a role, complete the following:

1. Log into the OIM application.

2. Click Users.

   Figure 1-4 Select Users

   
   

3. Click the oim.test user.

   Figure 1-5 oim.test User

   
   

4. Click the Roles tab.

   Figure 1-6 Roles Tab

   
   

5. Click the Request Roles button.

   Figure 1-7 Request Roles Button

   
   

6. Click the Add to Cart button next to the role you want to assign.

   Figure 1-8 Adding Roles to the Cart

   
   

7. Click Next.

   Figure 1-9 Add Access Request

   
   

8. Click Submit.

   Figure 1-10 Submit Access Request

   
   

   The role is now assigned to the User.

   Figure 1-11 User Details

   
   

Retail Insights Cloud Services Default Enterprise Roles

Retail Insights Cloud Services is built with role-based access. Permissions are associated with roles.

The following roles are available:

Table 1-1 Retail Insights Cloud Services Default Enterprise Roles

Application Module	Default Enterprise Roles	Corresponding Application Roles
ORMI/ORCI	AltHierarchyInsights_Job	AltHierarchyInsights
ORCI	ConsumerInsights_Job	ConsumerInsights
ORCI	CustomerInsights_Job	CustomerInsights
ORCI	CustomerDetailInsights_Job	CustomerDetailInsights
ORCI	CustomerLoyaltyInsights_Job	CustomerLoyaltyInsights
ORMI/ORCI	CustomerOrderInsights_Job	CustomerOrderInsights
ORCI	CustomerSegmentInsights_Job	CustomerSegmentInsights
ORMI/ORCI	EmployeeInsights_Job	EmployeeInsights
ORMI	FranchiseInsights_Job	FranchiseInsights
ORMI	InventoryInsights_Job	InventoryInsights
ORMI	PlanningInsights_Job	PlanningInsights
ORMI/ORCI	PromotionInsights_Job	PromotionInsights
ORMI	PurchaseOrderInsights_Job	PurchaseOrderInsights
ORMI/ORCI	SalesInsights_Job	SalesInsights
ORMI	SupplierInsights_Job	SupplierInsights
ORMI/ORCI	RetailAnalysts	RetailAnalyst
ORMI/ORCI	RIApplicationAdministrators	RIApplicationAdministrator

Using a combination of the roles above will grant access to sets of metrics and attributes in RI in an additive fashion. One exception is the CustomerDetailInsights role, which is a special role intended to grant access to detailed customer information, such as their name and phone number. This role must be used in combination with the CustomerInsights role to get access to these attributes, and can be limited to a subset of RI users. Without the additional role, the CustomerInsights role only grants access to basic non-identifying customer information such as the customer ID and generic user-defined attributes.

Additionally, the following Oracle Business Intelligence roles are used in combination with the application roles above. Assign a combination of these system roles depending on the level of access required for each user. For example, a local systems administrator could be granted all of the roles in this table, and the permissions will be additive.

Table 1-2 Retail Insights Cloud Services OBIEE Roles

Application Module	Application Roles	Permissions Level
ORMI/ORCI	BI Consumer	Ability to view content created by others. Cannot create new content.
ORMI/ORCI	BI Author	Ability to create and share new content, including analyses and dashboards.
ORMI/ORCI	BI Application Administrator	Ability to modify and share user content, restrict access to objects, and configure advanced OBI features such as scheduled agents and BI Publisher reports.

Assign the above roles to the user following the steps mentioned in the previous section as per your requirement.

Note: For additional information, see Appendix A, "Appendix: Roles and Permission Grants".

Revoking Role Membership

To revoke the membership of a member in a role:

1. Log into the OIM application.

2. Click Users.

   Figure 1-12 Select Users

   
   

3. Click the oim.test user.

   Figure 1-13 Select Role to Revoke Users

   
   

4. Click the Roles tab.

   Figure 1-14 Roles Tab

   
   

5. Select the Role you want to revoke and click the Remove Role button.

   Figure 1-15 Remove Roles Button

   
   

6. In the Remove Roles screen, click Submit.

   Figure 1-16 Remove Roles Screen

   
   

Deleting a User or Disabling User Privileges

To delete or disable a user

1. Log into the OIM application.

2. Under Administration, click Users.

   Figure 1-17 Select Users

   
   

3. Select the user and click Disable or Delete as necessary.

   Figure 1-18 Delete and Disable

   
   

4. You can also Lock or Unlock a particular user from the same screen if needed.

Resetting a User Password

To reset the password of a user:

1. Log into the OIM application.

2. Under Administration, click Users.

   Figure 1-19 Select Users

   
   

3. Click the Search tab and then select on the User you want to reset the password.

4. Click on Reset Password.

   Figure 1-20 Reset Password Button

   
   

5. In the Reset Password screen, make sure Auto-generate the Password is selected and Click on Reset Password. (The system will auto generate the password and will email it to the user.)

   Figure 1-21 Reset Password

   
   

Approve Requests from User

The users can also request for the Roles or revoke those that are available for him to access the RIS Service. Below are the steps to approve the request from the User.

1. Login into OIM Application.

2. Click Pending Approvals.

   Figure 1-22 Select Pending Approvals

   
   

3. Click on the Action that is assigned to you.

   Figure 1-23 Pending Approvals Tab

   
   

4. Click the Claim button.

   Figure 1-24 Claim the Pending Approval

   
   

5. Click Approve or Reject.

   Figure 1-25 Approve Pending Approval

   
   

6. Once done the request is completed.

Approve Requests from User for Multiple Roles

The users can also request for the multiple Roles or revoke them if they are available for him to access the RIS Service. Below are the steps to approve the request from the User.

1. Login into OIM Application.

2. Click Pending Approvals.

   Figure 1-26 Select Pending Approvals

   
   

3. Click on the Action that is assigned to you.

   Figure 1-27 Pending Approvals Tab

   
   

4. Click the Claim button.

   Figure 1-28 Claim the Pending Approval

   
   

5. Click Approve or Reject.

   Figure 1-29 Approve Pending Approval

   
   

6. Once done, if approved, the request is split into multiple requests, one for each role for each user. Approve all of them by following steps 3 to 5.

7. Once all the requests are approved, all the roles will be assigned to users.

Note: The customer administrator can request multiple roles for multiple users. Once this request is made, the customer administrator is required to approve the request using the Approve Requests from User for Multiple Roles process.

Importing a Batch of User Accounts

If you have batch of users that have to be created, the Oracle team can bulk load the users into the OIM Application. When users are bulk loaded their initial password will be set to the current password of a template user. The new users will be required to change their password on first login.

To request the creation of accounts by bulk loading, follow the below steps.

1. Create CSV file listing all users to create (see example below).

2. Create or identify a user to whose password will be used as the initial password for all created users.

3. Open an SR with Oracle support and provide the CSV file and user from steps 1 and 2.

   ##################
    filename.csv
   ###################
   ##########################################
   USR_LOGIN,USR_FIRST_NAME,USR_LAST_NAME,USR_EMAIL,ORG_NAME
   ce.admin1,ce,admin1,[e-mail],Retail
   ce.admin2,ce,admin2,[e-mail],Retail
   ce.admin3,ce,admin3,[e-mail],Retail
   ce.admin4,ce,admin4,[e-mail],Retail
   ce.admin5,ce,admin5,[e-mail],Retail
   ce.admin6,ce,admin6,[e-mail],Retail
   ce.admin7,ce,admin7,[e-mail],Retail
   ce.admin8,ce,admin8,[e-mail],Retail
   ce.admin9,ce,admin9,[e-mail],Retail
   ce.admin10,ce,admin10,[e-mail],Retail
   ##########################################
   

Bulk Role Membership Update (Optional)

If you have quite a few users that have roles to be assigned to, the Oracle team can bulk update the role membership into the OIM Application.

To update the membership of the by bulk update, follow the below steps.

1. Create CSV file with the user role mapping. Please note that the user name must be in upper case (see example below).

2. Open an SR with Oracle support and provide the CSV file and user from steps 1.

   ##################
    role.csv
   ###################
   ##########################################
   UGP_NAME,USR_LOGIN
   Role1,CE.ADMIN1
   Role2,CE.ADMIN1
   Role1,CE.ADMIN2
   Role3,CE.ADMIN3
   Role4,CE.ADMIN4
   Role5,CE.ADMIN5
   Role6,CE.ADMIN6
   Role7,CE.ADMIN7
   Role8,CE.ADMIN8
   Role2,CE.ADMIN8
   Role2,CE.ADMIN9
   ##########################################
   

Note: If you want more than one role attached to a particular user, add one more row with the role that you want the user to have and the user name. Refer to the CE.ADMIN1 in above table for example.

Nightly Batch File Uploads

The following is the file upload process. For details regarding file contents and formatting please refer to the Oracle Retail Insights Cloud Services Integration Guide. The Private/Public Keys must be generated and the public Key must be associated with your SFTP Account for the file uploads. The Adding Authorized Keys section describes the step-by-step method to generate the Keys (2048 bit RSA Keys).

Adding Authorized Keys

The following is the process to generate a 2048 bit RSA key and add the same to the SFTP server. This is done with the help of WinSCP tool on Windows. However the same can be done using ssh-keygen on Linux as well.

1. Launch WinSCP and select Tools -> Run PuttyGen.

2. Select "SSH-2 RSA" for the type of key to generate and enter "2048" for the number of bits in a generated key field and click Generate.

   Figure 1-30 Key Generator

   
   

3. Move the mouse over the blank space in the window until the key is generated.

   Figure 1-31 Key Generator Progress

   
   

4. Once the key is generated, click the Save public key button to save the public key to a file.

5. Click the Save private key button to save the Private key to a file. Confirm to save it with/without a passphrase.

6. Open an SR with Oracle Support, to associate the Public half of the Key with your SFTP account (attach the Key with the SR).

Steps – Login to WinSCP

The Upload steps uses the private key generated in the earlier section.

1. Launch WinSCP and connect to <SFTP Server> using port 22.

2. Enter the username and click Advanced.

3. Click Authentication.

4. In the Private Key File field, click the Browse button and select the private key created in the earlier section.

   Figure 1-32 Advanced Site Settings Dialog

   
   

5. After loading the private key file, click OK.

   Figure 1-33 Private Key File Loaded

   
   

6. Click Login. The window does not prompt for a password and logs into the SFTP server. Provide a passphrase if one has been set up.

Steps to Upload the Batch File

Login to the WinSCP by Following the Steps – Login to WinSCP section.

1. Transfer all data files to the directory /<SFTP User>.

2. Create a directory called COMMAND under /<SFTP User>if it does not already exist.

3. Change to the /<SFTP User>/COMMAND directory.

4. Transfer an empty file called COMPLETE.

Export File Downloads

Login to the WinSCP by following the Steps – Login to WinSCP section. The following is the download file process.

1. Change directory to /<SFTP User>/EXPORT.

2. Download all data files.

Archiving_Reports – Agent Creation and Execution

1. After creating an Analysis (report) that is needed to be refreshed and saved to a file for downloading, from the OBIEE home screen select New -> Agent.

   Figure 1-34 Create a New Agent

   
   

2. After setting the schedule for the Agent execution, go to the Delivery Content tab and select the analysis report, don't worry about the other settings on this tab such as format because these will be overridden by other selections on the Actions tab.

   Figure 1-35 Delivery Content Tab

   
   

3. Ignore the Recipients and Destinations tabs, go to the Actions tab and add a new Action that "Invokes a Java Method".

   Figure 1-36 Action Tab

   
   

4. Select "REPORT ARCHIVE EJBs / biserver / ArchiveReports / BIReportArchieveApplication-ArchiveReports-ArchiveReports / ArchiveReport".

   Figure 1-37 Select Java Method

   
   

5. Enter the filename that the report should be written into, and select "Delivery Content".

   Figure 1-38 New Action Window

   
   

6. Click the small black page icon with the turned corner and select the file format to be written, then click OK.

   Figure 1-39 Select File Format

   
   

7. Click Save Agent and give the Agent a name. At this point the Agent has been defined and will execute according to the defined schedule.

   Figure 1-40 Save the Agent

   
   

8. If you would like to do an immediate execution of the Agent you can click Run Agent Now.

   Figure 1-41 Execute the Agent

   
   

   The following dialog displays while the agent is running:

   Figure 1-42 Running Agent Dialog

   
   

Dashboard Column and Tile Configuration

This section provides a detailed approach of configuring the dashboard detailed reports and InfoTiles created within OBIEE 12C. The new column and Info-Tile configuration optimizes the hard-coding of column (exception) values in Conditional Format and in case of InfoTiles, severity formula by storing the column range (min and max) values in the database and rendering it to the dashboard using presentation variables. At present, this has been implemented in CEO dashboard. User can change the dashboard column and tile configuration if required by following the steps mentioned below.

Configuring Dashboard Column

Perform the following procedures to configure the dashboard column values.

Adding Dashboard Configuration Entries to the Database

RI_DASHBOARD_CONFIG is the table to store the dashboard configuration. Below is the screenshot for the field values of the RI_DASHBOARD_CONFIG table.

Figure 1-43 RI_DASHBOARD_CONFIG Table

Where,

Table 1-3 RI_DASHBOARD_CONFIG Table Fields

FIELD_NAME	Regular OBIEE Analysis	INFO-TILE Analysis
REPORT_NAME	Name of the detailed report	Tile Title
PARAM_NAME	Name of the column whose values need to be dynamic	Tile Title
PARAM_TYPE	Tells whether it is a detailed report or tile. Value to be inserted: Column	Tells whether it is a detailed report or tile. Value to be inserted: Tile
ATTR1, ATTR1_MAX_VALUE, ATTR1_MIN_VALUE	Name of the column whose values need to be dynamic. Max column value above which the column appears green and Min column value below which the column appears red.	If the Tile Main Metric value (sub-metric value can also be compared by editing severity formula) lies between the MIN_VALUE and MAX_VALUE, the tile appears to be red (critical). ATTR1 must represent the severity value "critical"
ATTR2, ATTR2_MAX_VALUE, ATTR2_MIN_VALUE	Can be added in future.	If the Tile Main Metric value lies between the MAX_VALUE and MIN_VALUE, the tile appears to be yellow. ATTR2 must represent the severity value "important"
ATTR3, ATTR3_MAX_VALUE, ATTR3_MIN_VALUE	Can be added in future.	If the Tile Main Metric value lies between the MAX_VALUE and MIN_VALUE, the tile appears to be green. ATTR3 must represent the severity value "normal"
ATTR4, ATTR4_MAX_VALUE, ATTR4_MIN_VALUE	Can be added in future.	If the Tile Main Metric value lies between the MAX_VALUE and MIN_VALUE, the tile appears to be blue. ATTR4 must represent the severity value "no severity"

Note: For detailed reports columns, currently only ATTR1 is used. ATTR2, ATTR3,…ATTR8 can also be inserted in the future based on the requirement. For Info-Tiles, ATTR5, ATTR6, ATTR7, ATTR8 can also be inserted in the future based on the requirement.

The MAX_VALUE and MIN_VALUE depend on the Tile severity logic. Example: For a dashboard containing Net Sales Amt Info-Tile, the tile severity is critical if the Main Metric value lies below the MIN_VALUE. For a dashboard containing Return Items Info-Tile, the tile severity is critical if the Main Metric value lies above the MAX_VALUE.

Now, a table for dashboard configuration is created. Let's now insert values into the table to get started. The following typical SQL insert query can be written to insert entries into the RI_DASHBOARD_CONFIG table.

The RI_DASHBOARD_CONFIG table has been exposed in the Retail Merchandising Analytics As-Was. It can be directly rendered in the front-end.

Creating Exceptions Threshold Prompt

Now, we're going to create an Exceptions Threshold prompt to set the presentation variables.

1. Create a Dashboard Prompt by clicking New?Dashboard Prompt.

   
   

   Note: Each page in the dashboard must have a single Exceptions Threshold Prompt. For example, if the dashboard has two pages namely Promotions and Sales, the prompts must be named Promotions Exceptions Threshold Prompt and Sales Exceptions Threshold Prompt respectively.

   
   

2. Click the New icon and select variable prompt.

3. In the Edit Prompt Dialog Box, provide a name for the Presentation variable and select User Input as Text Field.

   The naming for the Presentation variable should be logical to the context and camel cased.

   For example: MtdClearanceSalesMaxCompColumn, MtdClearanceSalesMinCompColumn

   We can have our own label for the variable.

4. Expand the Options pane and under General tab, the Variable Data Type can be based on the column type. Select 'SQL Results' for Default selection and enter a SQL statement in text box.

   Figure 1-44 Edit Prompt Dialog

   
   

   The SQL query added in the text field is explained below:

       SELECT "RI Dashboard Config"."ATTR1_MAX_VALUE" FROM "Retail Merchandising Analytics As-Was" 
       WHERE "RI Dashboard Config"."REPORT_NAME" = 'MTD Clearance Sales' AND "RI Dashboard Config".
        "PARAM_NAME" = 'Comp % Var' AND "RI Dashboard Config"."PARAM_TYPE"='Column'
   

   The above query fetches the max value of the column "Comp % Var" of the report "MTD Clearance Sales" from the table "RI DASHBOARD CONFIG".

5. The number of Presentation variables depends on the number of attributes we added in the table.

   Table 1-4 Number of Presentation Variables

   		No. of Presentation Variables
   Reports:	ATTR1 - MAX	1
   	ATTR1 - MIN	1
   Tile:	ATTR1, ATTR2, ATTR3, ATTR4	2*4=8
   Total no. of Presentation Variables		10

   
   

Including the Exceptions Threshold Prompt in the Dashboards

1. Go to Edit Dashboard. Click on Tools icon on the right and select Dashboard Properties. In the Dashboard Properties dialog box, click edit Filters and Variables icon.

   Figure 1-45 Dashboard Properties Dialog

   
   

2. Load the prompt by clicking on the plus icon.

   Figure 1-46 Dashboard Filters and Variables Dialog

   
   

   After loading the prompt the Dashboard Filters and Variables dialog box looks like:

   Figure 1-47 Filters and Variables after Loading

   
   

Edit Detailed Report Analysis

1. Open the report in the dashboard (Make sure all the reports in the dashboard are formatted).

2. Go to criteria tab and choose Column Properties for the column that needs to be conditional formatted.

3. Go to Conditional Format tab in the Column Properties dialog box. Before including the presentation variables, the conditions look like:

   Figure 1-48 Column Properties Dialog

   
   

4. Click on the condition to add presentation variable. Click Add more options in the Edit Condition dialog box and select Presentation variables.

   Figure 1-49 Edit Condition Dialog

   
   

5. Empty the Value field. Fill the Variable Expr field with the corresponding Presentation Variable. Click OK. Repeat the same for all the required exception columns. Refer the snapshot below for sample.

   Figure 1-50 Edit Condition Dialog Example

   
   
   
   

   Note: For union-criteria analysis that has multiple criteria, include the Presentation Variable in three places: Exceptions column formula Condition Format for Exceptions column Exception filters

   
   

Configuring Dashboard Info-Tile

We have configured the detailed reports using Presentation variables. Now, we are going to configure Info-Tile inside the dashboard.

Editing the Severity Column Formula for Info-Tile

1. Click on Edit formula on the severity column for the required Info-Tile.

2. Write CASE statements in the formula as below.

   CASE 
   WHEN (IfNull("Sales"."Net Pro Sales Amt MTD",0)) <= @{MtdPromotionSalesCriticalMinTile} THEN 'high' 
   WHEN (((IfNull("Sales"."Net Pro Sales Amt MTD",0)) > @{MtdPromotionSalesImpSevMinTile}) AND
   (IfNull("Sales"."Net Pro Sales Amt MTD",0)) <= @{MtdPromotionSalesImpSevMaxTile}) THEN 'medium' 
   WHEN ((IfNull("Sales"."Net Pro Sales Amt MTD",0)) > @{MtdPromotionSalesNoSevMinTile} AND 
   (IfNull("Sales"."Net Pro Sales Amt MTD",0)) <= @{MtdPromotionSalesNoSevMaxTile}) THEN 'none' 
   ELSE 'low' 
   END
   

   The above CASE statement returns the severity value of the tile:

   • If the main metric value is lesser than the MtdPromotionSalesCriticalMinTile, the severity is high.

   • If the main metric value is between the MtdPromotionSalesImpSevMinTile and MtdPromotionSalesImpSevMaxTile, the severity is medium.

   • If the main metric value is between the MtdPromotionSalesNoSevMinTile and MtdPromotionSalesNoSevMaxTile, the severity is none.

   • Otherwise, the severity is low.

   Figure 1-51 Edit Column Formula Window

   
   

Save and Run the Dashboard

Save the reports, Info-Tiles and run the dashboard.

Figure 1-52 Save and Run the Dashboard