SAPUI5 Application Index

To use this indexing and caching mechanism for SAPUI5 applications, components, and libraries, you have to define the execution of the report /UI5/APP_INDEX_CALCULATE as a background job.

The SAPUI5 application index provides an indexing and caching mechanism for information related to SAPUI5 applications, components, and libraries that are contained in SAPUI5 repositories on the SAP NetWeaver Application Server for ABAP. It makes it possible to retrieve and find this information significantly faster than when carrying out the calculations each time it is requested.

The cached information consists of calculation results related to the back-end support for cache busting on SAPUI5 repository level. The indexing refers specifically to SAPUI5 applications or SAPUI5 components with an SAPUI5 component ID. For more information, see Concepts.

If you activate cache busting in the SAP Fiori launchpad, the SAPUI5 application index is used to identify updated applications that need to be reloaded by the browser. For more information, see SAP Library for User Interface Add-On 1.0 for SAP NetWeaver on SAP Help Portal at http://help.sap.com/nw-uiaddon. Under Application Help, open SAP Library and search for Cache Buster for SAP Fiori.

Calculation Report /UI5/APP_INDEX_CALCULATE

The SAPUI5 application index is calculated by the report Calculation of SAPUI5 Application Index for SAPUI5 Repositories (/UI5/APP_INDEX_CALCULATE).

Note

If you want to use the SAPUI5 application index, you have to define the execution of this report as a background job as described below.

You can specify which SAPUI5 repositories are included by the report in the calculation of the SAPUI5 application index:

All SAPUI5 repositories
SAPUI5 repositories depending on the expiration period you specified (in hours and minutes)
A single SAPUI5 repository

The SAPUI5 application index is empty initially and needs to be calculated from scratch.

Execution as Background Job Required

To use the SAPUI5 application index and to ensure that its content is up-to-date, you have to define the execution of the report /UI5/APP_INDEX_CALCULATE as a background job (transaction SM36). This is because changes to the SAPUI5 repositories do not automatically trigger a recalculation of the SAPUI5 application index.

Example: You want the SAPUI5 application index to be recalculated completely every two hours. You define a variant with All SAPUI5 repositories as execution mode, use this variant in the definition of the background job, and set the execution period for the job to two hours.

Note

Make sure that you schedule a time interval that matches your needs. For frequently updated systems an interval of ten minutes might be appropriate.

However, it might be useful to execute the report manually to recalculate the SAPUI5 application index or parts of it after changes are made to the content of the SAPUI5 repositories, for example in the following cases:

In a development scenario where changes are required to become effective before the next execution of the report as a background job
After submitting changes using the SAPUI5 ABAP repository team provider or when the interactive SAPUI5 repository load tool has been used
After importing SAP notes or ABAP transports

Monitoring Background Jobs

You can use the Computing Center Management System (CCMS) to monitor the execution of background jobs. For example, you can set up alerts for the report /UI5/APP_INDEX_CALCULATE by using the data collection method CCMS_BATCH_MONITORING and the analysis method CCMS_BP_MON_ANALYZE.

Note

This monitoring refers only to the executions of the job itself. It does not detect any application log entries with problems created by the report.

For more information, see SAP Library for SAP NetWeaver at http://help.sap.com/nw_platform. Under Application Help, open SAP NetWeaver Business Warehouse and search for Monitoring Jobs with the Alert Monitor and Setting Up the Monitoring of Jobs with the Alert Monitor.

Application Log

Issues during the recalculation of the SAPUI5 application index are written as the following messages to the application log:

Message Type	Classification	Issue
Error	Very high	Exception because manifest.json file is not valid or cache buster token could not be calculated
Error	High	Component ID occurs/is used more than once
Warning	Medium	Component ID is potentially not valid

To access the application log, choose View … Logs in the report /UI5/APP_INDEX_CALCULATE. The application log is also persisted in client 000 by default and can be analyzed using transaction SLG1.

Technically, the application log is referenced by the object /UI5/APPIDX. This object has the following subobjects:

Subobject	Application Log Entries
GENERAL	General information like time and duration of the last calculation of the SAPUI5 application index, number of SAPUI5 repositories, and number of updated table entries
UI5REP	Error messages that occurred when a SAPUI5 repository was processed The external ID is the SAPUI5 repository name.
UI5COMP	SAPUI5 component-related messages from a consistency check carried out at the end of the calculation of the SAPUI5 application index The consistency check includes the following: Whether the same component ID is contained in more than one SAPUI5 repository Whether the component ID is valid Whether a reuse component defined in the dependencies is not contained in the SAPUI5 application index The external ID is the SAPUI5 component ID.

Subobject

Application Log Entries

GENERAL

General information like time and duration of the last calculation of the SAPUI5 application index, number of SAPUI5 repositories, and number of updated table entries

UI5REP

Error messages that occurred when a SAPUI5 repository was processed

The external ID is the SAPUI5 repository name.

UI5COMP

SAPUI5 component-related messages from a consistency check carried out at the end of the calculation of the SAPUI5 application index

The consistency check includes the following:

Whether the same component ID is contained in more than one SAPUI5 repository
Whether the component ID is valid
Whether a reuse component defined in the dependencies is not contained in the SAPUI5 application index

The external ID is the SAPUI5 component ID.

The application log contains only entries of the last run of the report /UI5/APP_INDEX_CALCULATE and any older entries are removed automatically. For more information, see SAP Library for SAP NetWeaver at http://help.sap.com/nw_platform. Under Application Help, open SAP NetWeaver Business Warehouse and search for Analyze Logs.

Monitoring Application Logs

To monitor the calculation results, you might want to build CCMS methods that evaluate the application logs for the object /UI5/APPIDX and the subobjects GENERAL, UI5REP, and UI5COMP. For more information, see SAP Library for SAP NetWeaver on SAP Help Portal at http://help.sap.com/nw_platform. Under Application Help, open SAP NetWeaver Business Warehouse and search for Creating a Data Supplier for the CCMS Alert Monitor and Application Log (BC-SRV-BAL).