About Caching

Caching at Server Startup

Collaboration and Approvals can be configured to enable caching at server startup.

See Enabling Cache Load at Server Startup) using the AefStartupServlet. This table lists what items are cached:


Cached Items	App Server	Comments
Symbolic Names	Cached	The symbolic name mappings for all registered administrative objects.
Properties	Cached	All app properties files.
Business Type hierarchy	Cached	The type hierarchy. The hierarchy is used by the type chooser, tree-type menu mapping, and type-specific object generator. See the Administration Guides of each app for type hierarchy models.
Type-to-tree menu mapping	Cached	Every type in the system is mapped to an equivalent administrative menu object for displaying the Categories menu.
Suite-specific type-to-tree menu mapping	Cached	The administrative menu objects used by specific apps where special menus are configured for certain types.

All of the above items are cached in the app server tier.

For reference, this table lists the items that are not cached by the servlet, but are cached on-demand in the UI cache when a user accesses them:


Non-Cached Item	Comments
Tables	UI cache for tables
Web Forms	UI cache for forms
Menus	UI cache for categories tree menu and toolbar
Commands	UI cache for categories tree menu and toolbar items
String resource properties	Collaboration and Approvals and app specific string resource files used for internationalization of the user interface
Person	Person-related cache
Channels and portals	UI cache for PowerViews

The Reload Cache Tool

The Reload Cache tool is configured using the administrative command object AEFReloadCacheToolbar, which is connected to the AdminTools menu, which is connected to the My Desk menu object, which in turn is connected to the AEFGlobalToolbar menu.

The default access for this command is assigned to the Administration Manager role and therefore only appears when a user of that role logs in.

When the Reload Cache tool is clicked, the entire cache data is reset and all cached data expires. Any further request to an administrative object from the UI cache obtains the data fresh from the database and is cached again.

The cached data also includes trigger data, such as input arguments, program names, and changes to the state of the eService Trigger Program Parameters objects. When changes occur to this trigger data, the cache must be reloaded to reflect the change.

This table lists the items that are cached at the server start up and that are reloaded when the Reload Cache tool is clicked:


Server Start-up Cached Item	Application Server	Comments
Symbolic names	Cleared and reloaded	Symbolic name mappings for all registered administrative objects
Business Type hierarchy	Cleared and reloaded	Type hierarchy. This tree is used mainly to display the type chooser, build tree-type menu mapping and type-specific object generators.
Type-to-tree menu mapping	Cleared and reloaded	Every type in the system is mapped to an equivalent administration menu object for displaying the tree page.
Type-to-tree menu mapping	Cleared and reloaded	Every type in the system is mapped to an equivalent administration menu object for displaying the Categories menu.
Suite-specific Type-to-tree menu mapping	Cleared and reloaded	Mapping where special menus are configured for certain types.

This table lists the items that are cached on demand, and that get cleared when the Reload Cache tool is clicked:


On Demand Cached Item	Application Server	Comments
Tables	Cleared	UI cache for table
Web Forms	Cleared	UI cache for forms
Menus	Cleared	UI cache for tree and toolbar
Commands	Cleared	UI cache for tree category and toolbar items
Persons	Cleared	Person related cache
Channels and Portals	Cleared	UI cache for PowerViews
Trigger Program Parameters	Cleared	Trigger Program Parameters

This table lists the items that are cached and never get cleared:


Cached Items Not Cleared	Application Server	Comments
String Resource Properties	Cached but never cleared	Collaboration and Approvals and app specific String resource files used for internationalization
Properties	Cached but never cleared	All app Properties files such as emxEngineeringCentral, emxSystem properties