Export Configuration
From VYRE
Contents |
Setting Up An Export Configuration
Navigate to the ‘Content module’, in this section select ‘Export configurations’.
Click on Add button at the top of the list of ‘Export configurations’.
Create a descriptive ‘title’ for the new configuration.
- Click on the associated checkboxes to choose the relevant information you need to export for an item.
- Under ‘File export type’ choose:
- Export originals: get the originally uploaded files. This is the default selection, it should be changed as required.
- Export previews: export the previews.
- 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.
- 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.
- ‘Output type’ gives the flexibility of choosing different format for the information exported from specific items. The default selection is ‘Excel’ and is recommended to use this because of the ease of viewing and comparing data in Excel table format. Other type includes PDF, XML and XML for import configuration.
- Note: If choosing XML or XML for import configuration, specifically if using XML for re-importing, make sure the syntax and structure is coded properly.
- The next section ‘Names of attributes to export’ should be filled if the user wants to export information related to any specific attributes/metadata of any items. For example Title or Content, use linebreak to separate the attributes.
- Title
- Content
Linked attributes
Linked attributes, at the moment of writing, can only be exported using PDF and Excel export types; this is unsupported for XML types. A list of possible keywords allowed in this textarea:
| Keyword | Notes |
|---|---|
| itemLink | Cannot be specified before itemAttribute/userAttribute. |
| userLink | Can only be first path element or either go after another itemLink. |
| itemCreator | Can be first path element or follow itemLink. |
| itemLastModifier | Can be first path element or follow itemLink. |
| itemAttribute | Can be first path element or follow itemLink. |
| userAttribute | Can be first path element or follow any of (userLink, itemCreator, itemLastModifier). |
| itemId * | Can only follow itemLink, exports linked item id. |
| itemName * | Can only follow itemLink, exports linked item name. |
| itemDescription * | Can only follow itemLink, exports linked item description. |
| itemCreationDate * | Can only follow itemLink, exports linked item creation date. |
| itemModificationDate * | Can only follow itemLink, exports linked item modification date. |
| itemCreatorFullName * | Can only follow itemLink, exports linked item creator full name. |
| itemModifierFullName * | Can only follow itemLink, exports linked item modifier full name. |
| itemViewCount * | Can only follow itemLink, exports linked item view count. |
| itemOrderCount * | Can only follow itemLink, exports linked item order count. |
| itemTaxonomy * | Can only follow itemLink, exports linked item taxonomy. |
| itemFileName * | Can only follow itemLink, exports linked item file name (actual file name for filestores, or item_XXX.xml for datastores). |
* - Only available from 4.3.1.8 release.
Examples:
itemLink1/itemAttributeName userLink1/userAttributeUsername itemCreator/userAttributeuser.name.given itemLastModifier/userAttributeuser.name.family itemLink2/itemLink3/itemAttributeName itemLink123/itemViewCount
To retrieve any of the metadata attributes of linked items:
itemLink1/itemAttributeAttribute's ID
Example: itemLink96/itemAttribute592
