Controlling how Elvis assets are used in Enterprise 10

Step 1. Open the configuration file of the Elvis plug-in in Enterprise in a text editor:

Tip: (For Enterprise Server 10.1 or higher only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.

For Enterprise Server 10.0 – 10.4:

<Enterprise Server folder>/config/plugins/Elvis/config.php

For Enterprise Server 10.5 or higher:

<Enterprise Server folder>/config/config_elvis.php

Step 2. Locate the 'ELVIS_CREATE_COPY' option and configure it as follows:

• For Enterprise Server 10.0.x:
• Set the option to 'false'

define('ELVIS_CREATE_COPY', 'false');

• For Enterprise Server 10.1.x or higher:
• Set the option to 'Shadow_Only'

if( !defined('ELVIS_CREATE_COPY') ) {
	define( 'ELVIS_CREATE_COPY', 'Shadow_Only' );
}

Note: Setting the option can influence the setting for restoring an archived layout from Enterprise. When making use of this feature, please check supported combinations in Restoring an archived layout in Elvis 5 Server - configuration.

Step 3. Save the file. The changes will be automatically implemented.

Step 1. Open the configuration file of the Elvis plug-in in Enterprise in a text editor:

Tip: (For Enterprise Server 10.1 or higher only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.

<Enterprise Server folder>/config/plugins/Elvis/config.php

Step 2. Locate the 'ELVIS_CREATE_COPY' option and configure it as follows:

• For Enterprise Server 10.0.x:
• Set the option to 'true'

define('ELVIS_CREATE_COPY', 'true');

• For Enterprise Server 10.1.x or higher:
• Set the option to 'Hard_Copy_To_Enterprise'

if( !defined('ELVIS_CREATE_COPY') ) {
	define( 'ELVIS_CREATE_COPY', 'Hard_Copy_To_Enterprise' );
}

Note: Setting the option can influence the setting for restoring an archived layout from Enterprise. When making use of this feature, please check supported combinations in Restoring an archived layout in Elvis 5 Server - configuration.

Step 3. Save the file. The changes will be automatically implemented.

Info: This feature requires Enterprise 10.1.1 or higher and Elvis 5.18 or higher.

Setting up this feature requires the following steps to be performed:

1. Creating a folder in Elvis in which to store the assets
2. Setting up access rights in Elvis
3. Configuring the Server plug-in
4. Defining how assets in the Production Zone folder are to be used
5. Testing Enterprise Server

1. Creating a folder in Elvis in which to store the assets

Log in to the Elvis Desktop client or the Elvis Pro client as an administrator and create a folder in Elvis which will act as the 'Production Zone': the location where the assets in Elvis will be copied to.

Note: This folder should be a base folder (a folder at the top of the hierarchy).

2. Setting up access rights in Elvis

Set up access rights to the Production Zone folder in Elvis to make sure that users cannot delete the assets in the Production Zone folder.

For information about how to do this, see Controlling user access to folders and assets in Elvis 5.

Step 1. Set up the following Rule:

• Restrict permissions to folders: select the created Production Zone folder
• Restrict permissions with a metadata query: -sceUsed:true

Step 2. Assign the Rule to users and user groups and make sure that the option Delete is not selected.

3. Configuring the Server plug-in

Step 1. Open the configuration file of the Elvis plug-in in Enterprise in a text editor:

Tip: (For Enterprise Server 10.1 or higher only) Easily manage and configure settings of all configuration files by adding them to a single configuration file.

For Enterprise Server 10.0 – 10.4:

<Enterprise Server folder>/config/plugins/Elvis/config.php

For Enterprise Server 10.5 or higher:

<Enterprise Server folder>/config/config_elvis.php

Step 2. Locate the 'ELVIS_CREATE_COPY' option and set it to 'Copy_To_Production_Zone'.

if( !defined('ELVIS_CREATE_COPY') ) {
	define( 'ELVIS_CREATE_COPY', 'Copy_To_Production_Zone' );
}

Note: Setting the option can influence the setting for restoring an archived layout from Enterprise. When making use of this feature, please check supported combinations in Restoring an archived layout in Elvis 5 Server - configuration.

Step 3. Locate the 'DEFAULT_ELVIS_PRODUCTION_ZONE' option and define the folder location by using the following placeholders:

• ${brand}. This will be replaced by the Brand name once the Brand is created.
• ${date:<format>}. This will be replaced by the current date once the Elvis asset is copied. For details about the format, see http://php.net/manual/en/function.date.php.

if( !defined('DEFAULT_ELVIS_PRODUCTION_ZONE') ) {

	define( 'DEFAULT_ELVIS_PRODUCTION_ZONE', '/Production Zone/${brand}/${date:Y-m}' );

Step 4. Save the file.

4. Defining how assets in the Production Zone folder are to be used

While the Production Zone folder is meant as a location in which copies of an Elvis asset are stored, users who can see this folder might treat it as any other folder in Elvis and move assets from it to Enterprise.

When doing so, these users might expect that a copy is created of this asset, similar to when an asset from any other Elvis folder is moved.

However, the default behavior is that no copy is created. This is because Enterprise recognizes that a shadow object for this asset already exists and uses that same shadow object again.

As a result, the same shadow object is now used in multiple places but users might be under the impression that a different file has been created. When editing the file, they might not be aware that these changes are also applied to the asset in the other locations in Enterprise. (See also Working with assets that are stored in the Production Zone folder of Elvis 5.)

Consider implementing one of the following solutions to prevent these unwanted changes:

• Do not give access to the Production Zone folder to users. Modify the Elvis Rule so that users don't see the folder in Elvis. When users want to re-use an Elvis asset in Enterprise, they can locate the original asset in Elvis and move it once more to Enterprise. This way, a new copy of the file is added to the Production Zone folder in Elvis and in Enterprise a new shadow object is created.

• For images only (requires Enterprise Server 10.1.3 or higher) Always have a copy created. Configure the Elvis plug-in in Enterprise to make sure that each time an image is moved from the Production Zone folder to Enterprise, a copy is created in the Production Zone folder in Elvis and a new shadow object is created in Enterprise. For this, set the following option in the Elvis plug-in configuration file to true:

if( !defined('ELVIS_CREATE_COPY_WHEN_MOVED_FROM_PRODUCTION_ZONE') ) {
	define( 'ELVIS_CREATE_COPY_WHEN_MOVED_FROM_PRODUCTION_ZONE', true );
}

5. Testing Enterprise Server

In Enterprise Server, run the 'Elvis Content Source' check on the Health Check page.