Configurations for Application Usage Insights

There are permissions and privileges that are required for administering and viewing Application Usage Insights. In addition there are scheduled process jobs that are required.

You will need to have the right permissions, and to run some ESS scheduled process to ensure your data is accessible and up to date. Here's what you need to do:

  • Ensure that any users accessing this feature have the privilege of ORA_ZCA_VIEW_APPLICATION_USAGE_INSIGHTS_UI. Use the steps in "Set Up Application and Usage Tracking" in this chapter to assign this privilege.

  • Starting from 21B, the Application Usage Insights subject area shows data for users and their teams based on their organization hierarchy. If users aren't part of an organization hierarchy, the application doesn't return any data. To give visibility to users, you need to add them to a hierarchy or grant them the ORA_ZCA_VIEW_APPLICATION_USAGE_INSIGHTS_ORG privilege. See the Related Topics link, "Create Job and Abstract Roles" at the end of this section and follow the steps to add Functional Security Policies.

  • For Click History reporting, the Sales Administrator, Sales VP, and Sales Manager roles come enabled to access the Click History Purge Process and User Analytics Click Mapping Translation ESS jobs. Any custom roles need to assign the Populate Click Description Process privilege to their role to manage the ESS jobs. Note that for setup or when you enable a new language you need to run the User Analytics Click Mapping Translation job once.

  • Refresh the data by running the ESS job Refresh BI Reports Audit Data for User Adoption Reporting.

  • The following scheduled processes must be mandatorily executed for viewing insights:
    • Process Click History Mapping Data
    • Click History Data Purge Process
  • You will need to have the right permissions, and to run some ESS scheduled process to ensure your data is accessible and up to date. Here's what you need to do:
    • Enable Application Usage Insights charts and click history logging by setting the ORA_ZCA_CH_DISABLE profile option to NO.

The instructions for running ESS scheduled processes is detailed in Chapter 5, "ESS Scheduled Processes".

This table provides details on the insights ESS Scheduled processes.

ESS Scheduled Process Name

Details

Process Click History Mapping Data

This process adds flow names to clicks; "stamps" the click information to the click information from the logs. Both the Click area and Application Usage Insights use this data.

This job requires that use user have the privilege of ORA_ZCA_POPULATE_CLICK_DESCRIPTIONS_PRIV

This job runs automatically by the hour. Users can change the run schedule.

For 21C or earlier this process requires the profile option enabled for BI_CH_SA_ENABLED

After 21C this process runs automatically.

Click History Data Purge Process

This process aggregates click history data older than 90 days. Both the Click History subject area and Application Usage Insights use this data.

This job requires that the user have the privilege of ORA_ZCA_POPULATE_CLICK_DESCRIPTIONS_PRIV

The run times for this process can be modified. Values of 90 and 180 are valid values.

Refresh BI Reports Audit Data for User Adoption Reporting

This process populates data for the Resource System Usage and Object Activity subject areas. Application Usage Insights also uses this data.

This job requires that the user have the privilege of ACM_RUN_CRM_ANALYTICS_REFRESH_JOB_PRIV

The profile option FND_TRACK_USER_ACTIVITY needs to be set to "ENABLED" to run.

Click History Mapping Translation Processor

This process populates the descriptions of clicks for the Click History subject area and Application Usage Insights.

This job requires that the user have the privilege of ORA_ZCA_POPULATE_CLICK_DESCRIPTIONS_PRIV

You need to run this process manually once to get started, and then again if you add a new language.

Cache Application Usage Insights Report Data

This job requires that the user have the privilege of ORA_ZCA_POPULATE_CLICK_DESCRIPTIONS_PRIV

This process runs automatically but you can modify the run times.

This table shows the privileges and profile options, that a user needs to view, manage and run the data that is used in the Application Usage Insights feature.Set Profile Option Values

Privilege and Profile Option

Details

View Application Usage Insights UI

ORA_ZCA_VIEW_APPLICATION_USAGE_INSIGHTS

Users must be granted this privilege to view Application Usage Insights UI. This is out of the box granted to the following roles:

  • Sales VP

  • Sales Manager

  • Sales Administrator

For any other roles, or custom roles you will need to do steps to grant this privilege to the role.

Run CRM Analytics Audit Table Refresh Job

ACM_RUN_CRM_ANALYTICS_REFRESH_AUDIT_TABLE_JOB_PRIV

This privilege permits you to run the "Refresh BI Reports Audit Data for User Adoption Reporting" ESS job

Run Populate Click Description Process

ORA_ZCA_POPULATE_CLICK_DESCRIPTIONS

This privilege permits you to schedule and run these ESS jobs:

  • Process Click History Mapping Data

  • Click History Data Purge Process

  • Cache Application Usage Insights Report Data

  • Click History Mapping Translation Processor

User Session Activity Tracked

FND_TRACK_USER_ACTIVITY

This profile option allows the site to run "Refresh BI Reports Audit Data for User Adoption Reporting" ESS job

Enable tracking user activity at the session level.

Click History Processing Interval

ORA_ZCA_CHTIMER_FREQ

This profile option determines how often new clicks are processed and added to the Click History Data.

Enable Application Usage Insights Charts and Click History Reporting

ORA_ZCA_CH_DISABLE

All charts within Application Usage Insights, and all click history data collection used for click history reporting in Application Usage Insights, are disabled by default beginning in Update 22D. If you want to use Application Usage Insights charts or click history reporting you can enable them by changing the ORA_ZCA_CH_DISABLE profile option value to No. If you've already been using these features, you'll find them disabled in Update 22D and must re-enable them, as a one-time step. Click history logging provides data for click history reports in Application Usage Insights and reports run from the CRM – CRM Click History subject area in Oracle Transactional Business Intelligence (OTBI).

Disable Click History Features

FBI_USER_SYSTEM_USAGE_TRANSACTION_ANALYSIS_DUTY

This profile option gives access to viewing and reporting with the User Adoption and Click History subject areas.

View Application Usage Insights UI with custom roles

ORA_ZCA_VIEW_APPLICATION_USAGE_INSIGHTS_ORG

This privilege lets users view organization data in Application Usage Insights UI. This privilege should be granted to view metrics for all the users in the company. If this privilege is granted to the user, the user will be able to view metrics for all the users in the Company, this is specifically used for administrator users who want to see company-wide data without being part of the resource hierarchy.

For steps to add this privilege to users see the Related Topics link, "Create Job and Abstract Roles" at the end of this section, and follow the steps to add Functional Security Policies.

Expose the custom objects configuration link within the Reports application drop-down menu

ORA_ZCA_APPLICATION_USAGE_INSIGHTS_MANAGE_CUSTOM_OBJECTS

This privilege exposes a Configuration link within the Reports menu providing administrators the ability to select which custom objects to expose or hide user adoption metrics for. When the administrator selects a custom object, its name will appear within the Record Usage area of the menu in addition to standard objects for sales teams to see. When sales teams select that custom object they will see user adoption metrics for it. Metrics such as the number of custom objects records created and updated are supported.