3 Console

This chapter contains OGL Console knowledge articles.

What is an API Name?

Every Oracle Guided Learning guide has a unique identifier. These identifiers are called the API names. The API name of a guide can be seen on the Guides page, right below the guideā€™s name.

The API name can be used to:

  • Launch or stop the guide using Javascript API
  • Create a permalink

example apiName on Guides Page

Timestamps in OGL

This table provides a list of OGL attributes and their respective time zones.

Description Timezone of timestamp
OGL Analytics Data/Reports UTC
OGL Item attribute: Last Updated By User's local time
OGL Comments User's local time
OGL Guide Activation Conditions User's local time

Timestamp standardized format is: "MM/dd/yyyy hh:mm a"

(e.g. 09/10/2021 11:35 AM)

How long does it take for OGL updates to reflect in the host application?

Updates made in the OGL reflect on the host application at different intervals. The below table details the time it usually takes for updates to reflect:

Tip:

Maximum time limit for updates to take place should be 90 minutes (after 90 mins, when all Akamai edge servers' cache should expire).

Note:

OGL Analytics data will be captured only by the production environment, and the analytics data will be updated every day at 4:30 AM UTC/ 10 AM IST.

Response Time for New Guides

Area/Description Time
Production Environment Development Environment
Display Group Manager 5 - 10 minutes. Immediately following a refresh.
Publishing an OGL Item Immediately following a refresh. Immediately following a refresh.
Publishing the Theme Immediately following a refresh. Immediately following a refresh.
All other actions Immediately following a refresh. Immediately following a refresh.
Activate/Inactivate the guides 5 minutes. <1 minute.
Guide Activation Condition 5 minutes. <1 minute.
Publish/Un-publish Guides <5 minutes. <1 minute.

Response Time for Existing Guides

Area/Description Time
Production Environment Development Environment
Display Group Manager 5 - 10 minutes. 0 - 20 minutes.
Publishing an OGL Item 5 - 10 minutes. Immediately following a refresh.
Publishing the Theme 5 - 10 minutes. Immediately following a refresh.
All other actions Immediately following a refresh. Immediately following a refresh.