Metadata mapping between Studio Server and Assets Server – Home

When Studio Server is integrated with Assets Server it is important that metadata information is shared between the two systems so that information about how and where files are used in Studio Server can be verified and searched on.

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

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

Fields that are mapped when importing files from Studio Server

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

Studio Server name	Assets Server name	Read	Write ¹
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	-	x⁴
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 Assets 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	x³
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	x²
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

¹ Content Source users must have edit permissions in Assets Server for all fields that are marked as 'write'.

² Changing the name of a file in Studio Server will rename the file in Assets Server. The file extension will not be changed.

³ The MIME type is mapped to the corresponding MIME type Studio Server format.

⁴ Copyright marked is derived from the copyright field in Assets Server.

Fields that are mapped when linking a file

When a file is linked to Studio Server (for example by dragging it onto an InDesign layout that is stored in Studio Server), the following Assets Server fields are mapped to corresponding Studio Server fields.

The Assets Server fields are read-only and are updated automatically when the data in Studio Server changes.

Name	Description
Archived from Studio Internal name: sceArchived	A boolean value that represents if a file is archived from Studio Server.
Category Internal name: sceCategory	The name of the Category in Studio Server that the file belongs to.
Category ID Internal name: sceCategoryId	The ID of the Category in Studio Server that the file belongs to.
Created in Studio Internal name: sceCreated	The date and time when the link was created.
Studio Server creator Internal name: sceCreator	The Studio Server user who created the link.
Studio Server ID Internal name: sceId	The object ID of the file in Studio Server.
Studio System ID Internal name: sceSystemId	The GUID of the Studio Server where this file is used.¹
Modified in Studio Internal name: sceModified	The date and time when the metadata was modified.
Modified in Studio by Internal name: sceModifier	The Studio Server user who modified the metadata.
Publication Internal name: scePublication	The name of the Publication (Brand) in Studio Server that the file belongs to.
Publication ID Internal name: scePublicationId	The ID of the Publication (Brand) in Studio Server that the file belongs to.
Used in Studio Internal name: sceUsed	A boolean value that represents if a file is used in Studio Server.

¹ A file can only be used on one Studio Server at a time.

Fields that are mapped when placing a file

When a linked file is placed on a layout, various relations are established between the file 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 Studio Server that the file belongs to.
Channel ID Internal name: sceChannelId	The ID of the Publication Channel in Studio Server that the file belongs to.
Edition Internal name: sceEdition	The name of the Edition in Studio Server that the file belongs to.
Edition ID Internal name: sceEditionId	The ID of the Edition in Studio Server that the file belongs to.
Studio relations Internal name: sceRelations	A JSON structure with relations of this file as shadow object to Studio Server entities such as layout, Category, Publication Channel, Issue, page and On pasteboard.¹
Issue Internal name: sceIssue	The name of the Issue in Studio Server that the file belongs to.
Issue ID Internal name: sceIssueId	The ID of the Issue in Studio Server that the file belongs to.
Layout Internal name: sceLayout	The name of the layout on which the file is placed.
Layout ID Internal name: sceLayoutId	The ID of the layout on which the file is placed.
Page Internal name: scePage	The page number of the page on which the file is placed.
Placed on page Internal name: scePlaced	A boolean value that represents if a file is placed on a page of an InDesign layout stored in Studio Server.
State Internal name: sceStatus	Name of the Workflow Status in Studio Server.
State ID Internal name: sceStatusId	The ID of the Workflow Status in Studio Server.

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

Fields that are mapped when archiving a file

When images are archived that are placed on a layout or part of a Digital article, the relation between the archived image and the archived layout or archived Digital article is stored.

The following table shows the fields that are populated:

Name

Description

Channel

Internal name: sceChannel

The name of the Publication Channel in Studio Server that the file belongs to.

Channel ID

Internal name: sceChannelId

The ID of the Publication Channel in Studio Server that the file belongs to.

Edition

Internal name: sceEdition

The name of the Edition in Studio Server that the file belongs to.

Edition ID

Internal name: sceEditionId

The ID of the Edition in Studio Server that the file belongs to.

Studio relations

Internal name: sceRelations

A JSON structure with relations of this file as shadow object to Studio Server entities such as layout, Category, Publication Channel, Issue, page and On pasteboard.¹

Issue

Internal name:
sceIssue

The name of the Issue in Studio Server that the file belongs to.

Issue ID

Internal name: sceIssueId

The ID of the Issue in Studio Server that the file belongs to.

Layout

Internal name: sceLayout

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

Layout ID

Internal name: sceLayoutId

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

Page

Internal name:
scePage

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

Placed on page

Internal name: scePlaced

A boolean value that represents if a file is placed on a page of an InDesign layout that is archived together with the image. Will be left empty when not applicable.

State

Internal name: sceStatus

Name of the Workflow Status in Studio Server.

State ID

Internal name: sceStatusId

The ID of the Workflow Status in Studio Server.

Created in Studio by

Internal name: sceCreator

The Studio Server user who created the link to this file.

It is not the user who triggers the archiving. It is basically brought over from the file before the archiving took place.

Created in Studio

Internal name: sceCreated

The date and time when the link was created.

It is not the date when the archiving took place. It is basically brought over from the file before the archiving took place.

Modified in Studio by

Internal name: sceModifier

The last Studio Server user who modified the metadata.

The archiving process has no impact on this field, this field will not reflect who triggers the archiving. It is basically brought over from the file before the archiving took place.

Modified in Studio

Internal name: sceModified

The last date and time when the metadata was modified.

The archiving process has no impact on this field, this field will not reflect the date and time archiving took place. It is basically brought over from the file before the archiving took place.

Used in Studio

Internal name: sceUsed

Normally, this field indicates if a file is used in Studio Server or not. Obviously for an archived file this file is no longer used in Studio Server. However, this field is automatically set to TRUE when ‘Studio System ID’ field is set; it is therefore always set to TRUE for this case.

Studio ID

Internal name: sceId

The object ID of the archived file in Studio Server.

Studio System ID

Internal name: sceSystemId

The GUID of the Studio Server where this file is used.²

When this field is set, the ‘Used in Studio’ field is automatically set to TRUE.

Archived from Studio

Internal name: sceArchived

Indicates that this is an archived file.

It is set to TRUE.

Archived in Studio

Internal name: sceArchivedInEnterprise

Indicates that this is an archived file.

It is set to TRUE.

Article ID

Internal name: sceArticleId

The ID of the Digital article on which the file is placed.

Left empty when not applicable.

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

² A file can only be used in one Studio Server at a time.

Configuring field mapping

Configuring the mapping between fields (either standard fields or custom fields) can be done by following the steps described in Configuring the mapping of metadata fields between Studio Server and Assets Server.

Note: We do not recommend to make changes to the mapping between standard fields but advise to create custom fields instead and to configure the mapping between that custom field and another field.

Revisions

4 August 2021: Added section 'Fields that are mapped when archiving a file'.
8 June 2021: Updated section 'Fields that are mapped when placing a file' with 'State' and 'State ID'.
8 June 2021: Removed section 'Studio Server fields without mapping'.