Export Configuration

From VYRE

Jump to: navigation, search

Contents

Introduction

The Content Export Configuration allows users to export content (data-items and file-items) from Unify. It is not specific to an single store and can be used to export data from multiple stores. It is used in conjunction with a search results. Content Export uses the results from a search to determine what items it will export. When an export is complete, it is placed in the users (exporters) Order Inbox. The exporter is the official way to export large dataset. The export configuration can be used in:

  • 'Item - Search Results' portlet
  • 'Item - Advanced Search Results' portlet
  • Ajax Search Framework
  • Backend Search

To create a new Export Configuration navigate to Content (Module) > Export Configurations. The UI was redesigned in 4.6.3.3. The Export Configuration now comprises of three main sections :

  1. Core Details
  2. Export Data
  3. Export Files

Core Details

Adding a title
  1. Title: a descriptive ‘title’ for the export configuration.
  2. Output type: allows you to choose the format that the exported file(s) will be in. There are five options to choose from:
    • Excel (in xls format). Prior to Unify 4.6.3 this was called Excel. The exported files will be in legacy Microsoft Excel format in a file with a xls extension. The output file should be readable by all versions of Microsoft Excel and most other spread sheet programs.
    • Excel (in xlsx format). Introduced in Unify 4.6.3. The exported file will be in the newer Microsoft Excel format in a file with a xlsx extension. The output file can be opened in versions of Microsoft Excel grater than 2007 and in older version after installing a Compatibility Pack. This is the recommended export output type since it provides considerable performance improvements over the old Excel export, especially when exporting large numbers of items.
    • PDF. The exported file will be in PDF format. The PDF file will contain one table, made up of all the items being exported.
    • XML. The exported file will be a zip file containing one XML file for each item being exported. The format of the XML will be similar to what is returned by the search results portlet. Each of the defined file exports will also be contained within the zip file.
    • XML for import configurations. The exported file will be a zip file containing one XML file for each item being exported. The format of the XML will what is expected by the Content Importer. Each of the defined file exports will also be contained within the zip file.
  3. Export files: enables the export of original and derived files of file-items.
  4. Export index prefix: all files from a single export will be prefixed with the export queue id. For example, "055_<file_name>". It is not recommended to use this option.

Export Data

Fill in the boxes with the default values you want to export

The Export Data option will only appear if the output type is:

  • Excel (in xls format)
  • Excel (in xlsx format)
  • PDF

Export Data section is divided into three further sections:

  • Default Values: core item information.
  • Attribute Values: content/metadata attribute values.
  • Linked Attributes: linked attribute values.

Default Values

Below is a list of all available default values:

  1. item ID
  2. file name: only applicable for file-items, the filename of the latest content version
  3. item name
  4. item description
  5. item keywords
  6. locale
  7. item creation date: in the dd.MM.yyyy HH:mm format
  8. item modification date: in the dd.MM.yyyy HH:mm format
  9. item creators full name: in the format of first_name middle_name last_name.
  10. item modifiers full name: in the format of first_name middle_name last_name.
  11. item view count: total view count.
  12. item order count: total item download count.
  13. taxonomy: comma seperated list of all taxonomy path that an item is taxonomised to.

Limitations

There are two main limitations when using default values:

  1. The column name for default values cannot be customised.
  2. Custom order cannot be defined for default values. The data will only appear in the order listed above.

Attribute Values

Attribute values is the first textbox in 'Export Data' section. It is used to get the attribute value of the exported Item.

Requirement

The requirement for defining a list of attributes to be exported are:

  • the attribute must be specified by name not by id.
  • each attribute must be defined in a new line.

Limitations

  • exports the raw attribute value (from the item xml).
    • does not the presentation rule( pretty print) version.
    • exports attributes with multiple-select presentation rule as comma separated.
  • only exports the first value of an attribute with one or many cardinality.

Linked Attributes

Linked Attributes is used to export data from linked items that can be several links deep by specifying a linkPath. Each new linked attribute must be defined in a new line.

The variables are defined in the table below:

Variables Notes root Path previous paths available since
itemLink<id> linkPath used to traverse through a item-link Y itemLink, uesrLink -
userLink<id> linkPath used to traverse through a user-link Y itemLink -
itemCreator<user_value_id> item or linked item creator. The user_value_id can be:username, userId, profileId, active,<profile_property_name>. Y itemLink -
itemLastModifier<user_value_id> item or linked item modifier. The user_value_id can be:username, userId, profileId, active,<profile_property_name>. Y itemLink -
itemAttribute<id> item or linked attribute value. Y itemLink -
userAttribute<user_value_id> The user_value_id can be:username, userId, profileId, active,<profile_property_name>. Y userLink, itemCreator, itemLastModifier -
itemId linked item id. N itemLink 4.3.x
itemName linked item name. N itemLink 4.3.x
itemDescription linked item description. N itemLink 4.3.x
itemCreationDate linked item creation date. N itemLink 4.3.x
itemModificationDate linked item modification date. N itemLink 4.3.x
itemCreatorFullName linked item creator full name. N itemLink 4.3.x
itemModifierFullName linked item modifier full name. N itemLink 4.3.x
itemViewCount linked item view count. N itemLink 4.3.x
itemOrderCount inked item order count. N itemLink 4.3.x
itemTaxonomy linked item taxonomy. N itemLink 4.3.x
itemFileName linked item file name (actual file name for filestores, or item_XXX.xml for datastores). N itemLink 4.3.x
linkedItemCount number of active linked items N itemLink 4.6.3.1

Examples

itemLink1/itemAttributeName
userLink1/userAttributeUsername
itemCreator/userAttributeuser.name.given
itemLastModifier/userAttributeuser.name.family
itemLink2/itemLink3/itemAttributeName
itemLink123/itemViewCount

Limitations

Linked Attributes only returns the value of the first linked item or user.

Export Files

Export files

The Export Files section will only appear if the 'Export files' option has been selected in the 'core detail' section. If this feature is enabled the exporter will return a zipped file.

File Export Type

Allows the export of files from file-items. The options are:

  1. Export originals: get the originally uploaded files. This is the default selection, it should be changed as required.
  2. Export previews: export the previews.
  3. Export custom derived file if it exists, else original: if there has been any derived files uploaded manually, they will be exported using this option. Otherwise it will download the original file.
  4. Export files listed in the file list field below (since 4.4): this option will export all the files from the file service ids specified in the text area IDs files (derived or original) to be exported per item (separated by linebreak. In the screen capture below, this box is filled as an example with values 95 and 100, which correspond to two file services ids.

Optional Feature

Option to export m3u playlist.

Restrictions

  • unlike the File Order Portlet, users cannot choose how to name the exported file.
  • cannot export files from linked items.

Performance Issues

There are three common performance problems when exporting data:

  • high CPU usage
  • low memory
  • low disk space

High CPU usage

  • exporting too many attribute values or linked atributes

Low Memory

  • exporting linked attributes for items that are linked to huge amount of items
  • exporting large file (ie. videos), Unify copies the files in memory.

Low Disk space

  • exporting large file (ie. videos)
  • exporting alot of derivied files

Alternatives

Other alternative ways to export data out of Unify is:

  • Feeds
  • Solr Export
  • File Order Portlet
Personal tools