Live Data Caches view

Administration Debug Live Data Caches Live Data Caches view

Live data caches are in-memory collection of instances (manifestations) of an N4 entity or entities. Each instance can contain fields from related entities. (An entity is a category or kind of data, for example, unit or unit facility visit (UFV); while an instance of an entity is the actual data for that category, for example, the unit ABC1234567.)

Live data caches are only used with the N4 HTML UI. They are not available when using N4 with the Java client.

The Live Data Caches view displays a record for each of the live data caches configured for the scope at which you are logged in.

Prerequisites

System Diagnostics (DEBUG_SYSTEM_DIAGNOSTICS) privilege
FRMCARINA034 (ENABLE_LIVE_DATA_CACHING) (on page 1) setting is true
A Message Processing Group for LDC. If this is not available, the Live Data Caches view displays a message, like No Data to display. Make sure to create LDC message processing group with active nodes.

Depending on the scope at which you are logged in, you can view the live data caches for the current scope level and any lower scope levels for your Operator. When you log in at a higher scope level, the view displays the live data caches for all the yards for which the FRMCARINA034 (ENABLE_LIVE_DATA_CACHING) setting is set as true. For example, if you log in at the Complex scope level for a multi-facility set up and the FRMCARINA034 setting is set as true for only two out of three facilities in the complex, you will see a record for the live data cache for each of the two facilities.

For each record, N4 displays the topology for the live data cache, in the Yard, Facility, Complex, and Operator columns. In addition to the built-in or system caches, the Live Data Caches view also displays any custom caches that you may have configured for your site. For more information on setting up a custom cache, see Customize the Data Cache.

The Live Data Cache currently does not support the Block Impact Minimizer or the Intra-Block Decker and should only be used for HTML UI functionality.

When enabled, the live data cache are built during node startup and reside in the memory of each node in a cluster. This makes live data cache a resource intensive feature. Therefore, the FRMCARINA034 (ENABLE_LIVE_DATA_CACHING) setting is turned off (set as false), by default.

However, if you use any of the following N4 features that depend on the live data cache, you must override the FRMCARINA034 (ENABLE_LIVE_DATA_CACHING) (on page 1) setting and set it as true either at the complex or at the individual yard scope levels:

POW Monitor view
ASC Schedule Monitor view
Automation customers using the Block Impact Minimizer and the Intra-block Decker with live data cache

If you start up N4 with FRMCARINA034 set as false, just updating FRMCARINA034 to true does not automatically trigger/initiate the live data cache for your site.

IMPORTANT: All customers should notify their Navis Professional Services contact before turning on LDC.

To initiate the live data cache:

Set the FRMCARINA034 setting to true and create a Message Processing Group for LDC.

Open the Live Data Caches view.
Use the Actions menu:

Reset Built-In Caches for Yard: To initiate the built-in live data caches for the current yard.
Reset All Caches for all Yards: To initiate the built-in and custom live data caches for all the yards in your topology.
Reset Custom Cache: To initiate the selected custom cache for the current yard.

To stop/reset the live data cache:

Set the FRMCARINA034 setting as false.

Open the Live Data Caches view.
Use the Actions Stop Live Data Caches option.

Disabling FRMCARINA034 does not automatically clear the cache. If you re-enable FRMCARINA034, you should always reset Live Data Caches to ensure that you do not use stale data.

You cannot add, edit, or delete any records from this view. However, you can use the Actions menu to:

Reset Custom Cache: Reset the data and rebuild the selected custom cache. If you select a built-in cache or if you select multiple records in the list view, this action is not available.
Reset Built-In Caches for Yard: Reset the data and rebuild all the built-in or system caches for the Yard of the selected built-in cache. If you select a custom cache or select multiple records in the list view, this action is not available.

The reset action for the built-in live data caches applies to all the caches for the yard of the selected record. This action does not affect the other yards in the topology of the user.

For example, if a user logs in at the Complex level that has two yards, Yard1 and Yard2. If the user selects a built-in live data cache for Yard2 in the list view and selects the Actions Reset Built-in Caches for Yard, N4 resets the live data caches for Yard2 and not Yard1.

Reset All Caches for all Yards: Creates all the caches for all the yards if the caches are not present. This could happen if the FRMCARINA034 (ENABLE_LIVE_DATA_CACHING) (on page 1) setting was set as false when you started the N4 servers but then you set it as true after the N4 servers started. If you select this action when the caches are already present, it clears and recreates the caches.

When you reset the system cache, the system verifies whether the LDC is ON for the yard. If the LDC is ON, the system then proceeds to build all caches, otherwise displays a warning indicating that the LDC is not enabled for the yard.

You do not have to select any rows in the Live Data Caches view to enable this action.

When you select any of the above actions, N4 displays a confirmation message before resetting the live data caches. If you click No in the message box, N4 does not perform the selected action.

The Actions menu is enabled even if a node is not part of the Message Processing Group. However, in this scenario, you can only start/reset/stop LDC and perform integrity check, but you cannot open the Live Entity Cache form.

If you access the Live Data Caches view from the N4 HTML client, in addition to the above Actions, the Live Data Caches view displays the following additional actions to open the corresponding live updating views for the available entities. For more details see Open Live Data Updating List views (on page 1).

Live Data Cache Columns

The following table displays the columns that you see when you click the Expand arrow () to view the details for the live data caches on a node in the cluster. N4 displays the data in these columns only if the Cache Status for the selected node is Active.

Label	Description
Entity Name	The entity, such as work queue or work instruction, whose data is represented by the live data cache.
Object Count	The number of objects in the live data cache.
Yard	The Yard in the topology for the live data cache. This is the most important component of the topology of a live data cache because any reset actions for the built-in live data caches apply to all the caches for the yard of the selected record, regardless of the yard in the topology of the user. For example, if a user logged in at Yard1 selects a built-in live data cache for Yard2 in the list view and selects the Actions Reset Built-in Caches for Yard, N4 resets the live data caches for Yard2 and not Yard1 where the user is logged in.
Facility	The Facility in the topology for the live data cache.
Complex	The Complex in the topology for the live data cache.
Operator	The Operator in the topology for the live data cache.
Built-In	Displays a period if the cache is a built-in N4 live data cache.
Last Built	The date and time the live data cache was last built. The field is updated only when the live data cache is built, either when the node starts up or when you use the Actions menu to reset the live data cache.