Global XML configuration

From VYRE

Jump to: navigation, search
Fig 1. An example view of global XML configuration screen

Contents

Overview

Global XML configurations are reusable components governing which XML blocks are printed. Configurations are used in system components which produce XML, either directly or indirectly. The same global XML configuration instance can be referenced across different components. This feature appeared in the Unify 4.6, and was supported in the following areas:

The general advice is to keep the amount of ticked check boxes to minimum to achieve better page latencies and minimize hardware resource consumption.

The global xml configuration is used for both json and xml.

In 4.8, the global xml configuration has support for users and linked users

Details

The essence of Global XML configuration is to tell to the system which parts of content data should be returned. It serves two functions:

  • It tells which linked information is necessary to retrieve. Example: search results portlet needs to retrieve all items from schema X and also those items that are linked to schema X via link definition Y.
  • It acts as a filter to prevent against retrieving unnecessary information and thus saving hardware resources and improving overall latency. Example: search results portlet only needs to retrieve item content from schema X but not metadata, version information nor localized sub-items.

The root of global XML configuration starts with any number of different schemas (these are called "root level schemas"). It can start with just one schema (e.g. to define structure for currently shown item of known schema) or with multiple schemas (e.g. to define the structure for advanced search results portlet that returns results of multiple known schemas).

Element blocks

The table below shows the dependency between GUI component checkbox and relevant block in Item XML block:

GUI element Description XPath REST JSON
Load Content prints item content XML from content repository data-item/content or file-item/content - see Content Repository XML blocks for more details item.content
Load Metadata prints item metadata XML from content repository data-item/metadata or file-item/metadata - see Content Repository XML blocks for more details item.metadata
Load PDF templates prints a list of all PDF templates in the system (deprecated). data-item/pdf-templates or file-item/pdf-templates - see PDF Template XML block for more details not supported
Load Only Item Link Count available only for linked stores (not for root of tree), if selected it will only show the number of items linked through that link definition This functionality was introduced in 4.6.1. If you are using a previous version this feature will not be available. data-item/item-links/count item.itemLinkCounts[<item_link_unique_title>].count
Load Creator Properties prints the data about creator of this item data-item/creator or file-item/creator (with relevant subtags and attributes) item.creator
Load Creator Profile Picture prints the profile picture (which is an item) data of creator of this item data-item/creator/user-profile-picture or file-item/creator/user-profile-picture (with relevant subtags and attributes). See User profile picture XML block for more details. item.creator.userProfilePicture
Load Last Modifier Properties prints the data about last modifier of this item data-item/last-modifier or file-item/last-modifier (with relevant subtags and attributes) item.lastModifier
Load Modifier Profile Picture prints the profile picture (which is an item) data of the last modifier of this item data-item/last-modifier/user-profile-picture or file-item/last-modifier/user-profile-picture (with relevant subtags and attributes). See User profile picture XML block for more details. item.lastModifier.userProfilePicture
File Info - Load Derived Files prints the derived file information of this item. Only applicable for file stores file-item/derived-files - see File info XML block for more details item.derivedFiles
File Info - Load Original File prints the original file information of this item. Only applicable for file stores file-item/original-file - see File info XML block for more details item.originalFile
File Info - Load All Services prints the information about all file services. Only applicable for file stores. Only applicable if "Load Derived Files" is selected file-item/derived-files/all - see File info XML block for more details item.derivedFiles
Taxonomy - Basic Taxonomy prints the taxonomy of currently viewed item, "basic" style. Cannot be used in conjunction with "flat" style data-item/categories or file-item/categories - see Taxonomy XML block for more details not supported
Taxonomy - Flat Taxonomy prints the taxonomy of currently viewed item, "flat" style. Cannot be used in conjunction with "basic" style data-item/categories or file-item/categories - see Taxonomy XML block for more details not supported
Taxonomy - Nested Taxonomy prints the taxonomy of currently viewed item, "nested" style data-item/taxonomy or file-item/taxonomy - see Taxonomy XML block for more details item.taxonomy
Localized Versions - Load Content same as "Load Content", but for localized item(s) of the main item data-item/localizations/locale/data-item/content (similar for file-item) not supported
Localized Versions - Load Metadata same as "Load Metadata", but for localized item(s) of the main item data-item/localizations/locale/data-item/metadata (similar for file-item) not supported
Localized Versions - Load Creator same as "Load Creator Properties", but for localized item(s) of the main item data-item/localizations/locale/data-item/creator (similar for file-item) not supported
Localized Versions - Load Last Modifier same as "Load Last Modifier Properties", but for localized item(s) of the main item data-item/localizations/locale/data-item/last-modifier (similar for file-item) not supported
Localized Versions - Basic Taxonomy same as "Taxonomy - Basic Taxonomy", but for localized item(s) of the main item data-item/localizations/locale/data-item/categories (similar for file-item) not supported
Localized Versions - Flat Taxonomy same as "Taxonomy - Flat Taxonomy", but for localized item(s) of the main item data-item/localizations/locale/data-item/categories (similar for file-item) not supported
Localized Versions - Nested Taxonomy same as "Taxonomy - Nested Taxonomy", but for localized item(s) of the main item data-item/localizations/locale/data-item/taxonomy (similar for file-item) not supported
Version History - Load Content same as "Load Content", but for all versions of this item data-item/version-history/data-item/content (similar for file-item) not supported
Version History - Load Metadata same as "Load Metadata", but for all versions of this item data-item/version-history/data-item/metadata (similar for file-item) not supported
Version History - Load Creator same as "Load Creator Properties", but for all versions of this item data-item/version-history/data-item/creator (similar for file-item) not supported
Version History - Basic Taxonomy same as "Taxonomy - Basic Taxonomy", but for all versions of this item data-item/version-history/data-item/categories (similar for file-item) not supported
Version History - Flat Taxonomy same as "Taxonomy - Flat Taxonomy", but for all versions of this item data-item/version-history/data-item/categories (similar for file-item) not supported
Version History - Nested Taxonomy same as "Taxonomy - Nested Taxonomy", but for all versions of this item data-item/version-history/data-item/taxonomy (similar for file-item) not supported

Nesting

As each store can be item linked to any other store, it is possible to configure a relevant connection in global XML configuration, too. By adding a linked store and enabling some properties, Unify would additionally load linked items and display relevant bits in XML. It is possible to nest this linking any levels that are necessary.

Similar applies to user links - it is possible to request to display information about linked users and relevant properties. Pre 4.8 user links cannot be nested in the same manner as item-link.

Other issues

There are some restrictions enforced by the GUI:

  • if "Show all services" check box is checked, "Show derived files" check box must be checked, too as corresponding generated XML of "all services" is embedded into XML of "derived file"'s.
  • "Basic Taxonomy" cannot be selected together with "Flat Taxonomy". Selecting both doesn't make any sense (if you need descriptions, just use the latter); but the more important factor is that they both use same XPath element which can bring lots of confusion if allowed.

See also

Personal tools