WoodWing Help Center

Metadata mapping between Enterprise and Elvis 6

Metadata mapping between Enterprise and Elvis 6

When WoodWing Enterprise is integrated with Elvis it is important that metadata information is shared between the two systems so that information about how and where assets are used in Enterprise can be verified and searched on.

For this purpose, various metadata fields are mapped, thereby making it possible for metadata changes in Elvis to appear in Enterprise and the other way round.

This article provides an overview of the fields that are mapped.

Fields that are mapped when importing assets from Enterprise

The following table shows which fields are mapped and if they are read from Elvis and written back to Elvis.

Enterprise name Elvis name Read Write 1

Aspect ratio

Internal name:
AspectRatio

Aspect ratio

Internal name:
aspectRatio

x

Author

Internal name:
Author

Name

Internal name:
creatorName

x x

Character count

Internal name:
LengthChars

Character count

Internal name:
numberOfCharacters

x

Color space

Internal name:
ColorSpace

Color space

Internal name:
colorSpace

x

Comment

Internal name:
Comment

Version comment

Internal name:
versionDescription

x x

Copyright (c)

Internal name:
Copyright

Copyright

Internal name:
copyright

x x

Copyright Marked

Internal name:
CopyrightMarked

-

x4

Copyright URL

Internal name:
CopyrightURL

Website

Internal name:
licensorWebsite

x x

Created By

Internal name:
Creator

Importer

Internal name:
assetCreator

x

Created On

Internal name:
Created

Imported in Elvis

Internal name:
assetCreated

x

Credit

Internal name:
Credit

Credit

Internal name:
credit

x x

Description

Internal name: Description

Description

Internal name: description

x x

Description author

Internal name:
DescriptionAuthor

Caption writer

Internal name:
captionWriter

x x

Dpi

Internal name:
Dpi

Resolution

Internal name:
resolution

x

Encoding

Internal name:
Encoding

Video codec

Internal name:
videoCodec

x

Format

Internal name:
Format

MIME type

Internal name:
mimeType

x3

Height

Internal name:
Height

Height (pixels)

Internal name:
height

x

Modified By

Internal name:
Modifier

Checked in by

Internal name:
assetFileModifier

x

Modified On

Internal name:
Modified

Checked in

Internal name:
assetFileModified

x

Publication Channels

Internal name:
PubChannels

Channel

Internal name:
sceChannel

x

Source

Internal name:
Source

Source

Internal name:
source

x x

In Use By

Internal name:
LockedBy

Checked out by

Internal name:
checkedOutBy

x

Keywords

Internal name:
Keywords

Tags

Internal name:
tags

x x

Line count

Internal name:
LengthLines

Line count

Internal name:
numberOfLines

x

Name

Internal name:
Name

Name

Internal name:
name

x x2

Paragraph count

Internal name:
LengthParas

Paragraph count

Internal name:
numberOfParagraphs

x

Rating

Internal name:
Rating

Rating

Internal name:
rating

x x

Size

Internal name:
FileSize

File size

Internal name:
fileSize

x

Type

Internal name:
Type

Kind

Internal name:
assetDomain

x

Version

Internal name:
Version

Version number

Internal name:
versionNumber

x

Width

Internal name:
Width

Width (pixels)

Internal name:
width

x

Word count

Internal name:
LengthWords

Word count

Internal name:
wordCount

x

1 Content Source users must have edit permissions in Elvis for all fields that are marked as 'write'.

2 Changing the name of a file in Enterprise will rename the file in Elvis. The file extension will not be changed.

3 The MIME type is mapped to the corresponding MIME type Enterprise format.

4 Copyright marked is derived from the copyright field in Elvis.

Fields that are mapped when linking an asset

When an asset is linked to Enterprise (for example by dragging it onto an InDesign layout that is stored in Enterprise), the following Elvis fields are mapped to corresponding Enterprise fields.

The Elvis fields are read-only and are updated automatically when the data in Enterprise changes.

Name Description

Archived from Enterprise

Internal name:
sceArchived

A boolean value that represents if an asset is archived from Enterprise.

Category

Internal name:
sceCategory

The name of the Category in Enterprise that the asset belongs to.

Category ID

Internal name:
sceCategoryId

The ID of the Category in Enterprise that the asset belongs to.

Enterprise created

Internal name:
sceCreated

The date and time when the link was created.

Enterprise creator

Internal name:
sceCreator

The Enterprise user who created the link.

Enterprise ID

Internal name:
sceId

The object ID of the asset in Enterprise.

Enterprise System ID

Internal name:
sceSystemId

The GUID of the Enterprise Server where this asset is used.1

Enterprise modified

Internal name:
sceModified

The date and time when the metadata was modified.

Enterprise modifier

Internal name:
sceModifier

The Enterprise user who modified the metadata.

Publication

Internal name:
scePublication

The name of the Publication (Brand) in Enterprise that the asset belongs to.

Publication ID

Internal name:
scePublicationId

The ID of the Publication (Brand) in Enterprise that the asset belongs to.

Used in Enterprise

Internal name:
sceUsed

A boolean value that represents if an asset is used in Enterprise.

1 An asset can only be used on one Enterprise Server at a time.

Fields that are mapped when placing an asset

When a linked asset is placed on a layout, various relations are established between the asset and the layout and the publication of which the layout is part.

The following fields are populated during this process.

Name Description

Channel

Internal name: sceChannel

The name of the Publication Channel in Enterprise that the asset belongs to.

Channel ID

Internal name: sceChannelId

The ID of the Publication Channel in Enterprise that the asset belongs to.

Edition

Internal name: sceEdition

The name of the Edition in Enterprise that the asset belongs to.

Edition ID

Internal name: sceEditionId

The ID of the Edition in Enterprise that the asset belongs to.

Enterprise relations

Internal name: sceRelations

A JSON structure with relations of this asset as shadow object to Enterprise entities such as layout, Category, Publication Channel, Issue, page and On pasteboard.1

Issue

Internal name:
sceIssue

The name of the I issue in Enterprise that the asset belongs to.

Issue ID

Internal name: sceIssueId

The ID of the Issue in Enterprise that the asset belongs to.

Layout

Internal name: sceLayout

The name of the layout on which the asset is placed.

Layout ID

Internal name: sceLayoutId

The ID of the layout on which the asset is placed.

Page

Internal name:
scePage

The page number of the page on which the asset is placed.

Placed on page

Internal name: scePlaced

A boolean value that represents if an asset is placed on an InDesign page in Enterprise.

1 The equally named fields in this table are based on this JSON structure.

Enterprise fields without mapping

The Enterprise metadata property 'State" is deliberately not mapped because it is Enterprise specific and will be stored in Elvis when archiving files from Enterprise to Elvis.

Mapping custom Enterprise fields

Mapping an Enterprise custom metadata property to an Elvis metadata field can be done by configuring the configuration file of the Integrating Elvis 6 in Enterprise Server 10.

Mapping on Brand level

Info: This feature requires Enterprise Server 10.0.6 (or any higher version of Enterprise Server 10.0.x).

By default, the mapped field is available across all Brands in Enterprise. To make it available to specific Brands only, add the Brand ID to the mapping (see examples below).

Note: The mapping applies to all object types; it is not possible to map the custom field to a specific object type (meaning: not on Dossiers only, articles only, and so on).

Examples

More example mappings can be found in the configuration file.

Example 1

Here, the custom Enterprise metadata property 'C_MyCustomField' is mapped to the custom Elvis metadata field 'cf_myCustomField' for all Brands:

$cfgFieldHandlers['C_MyCustomField'] = new ReadWriteFieldHandler("cf_myCustomField", false, "text", "C_MyCustomField");

Example 2

Here, the custom Enterprise metadata property 'C_MyCustomField' is mapped to the custom Elvis metadata field 'cf_myCustomField', but only for Brand with ID = 1:

$cfgFieldHandlers['C_MyCustomField'] = new ReadWriteFieldHandler("cf_myCustomField", false, "text", "C_MyCustomField", 1);

Example 3

Here, the custom Enterprise metadata property 'C_Instructions' is mapped to the default Elvis metadata field 'instructions' for all Brands:

$cfgFieldHandlers['C_Instructions'] = new ReadWriteFieldHandler("instructions", false, "text", "C_Instructions");

Document history

  • 25 September 2017: Added section 'Mapping on Brand level'.
  • 25 September 2017: Updated section 'Examples' with an example showing how to map a field to an Enterprise Brand.
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.