WoodWing Help Center

Integrating Elvis 6 in Enterprise Server 10

Integrating Elvis 6 in Enterprise Server 10

Elvis 6 can be tightly integrated with Enterprise Server 10 to make the assets that are stored in Elvis available in the workflow of Enterprise. This makes it possible to:

For a general overview, see Integrating Enterprise Server with Elvis 6 - How it works.

Installation

The integration is done by installing a Server plug-in in Enterprise Server.

Step 1. Download the Enterprise Server plug-in named Elvis integration for Enterprise from the download page for your version of Enterprise Server:

Step 2. Unzip the file and place the resulting 'Elvis' folder into the following location:

<Enterprise Server folder>/config/plugins

Configuration

Configuration consists of the following steps:

  1. Connecting Enterprise Server to Elvis Server
  2. Setting up the communication between Enterprise and Elvis
  3. Defining how Elvis assets are used in Enterprise
  4. Granting Elvis Pro users access to the 'Used In' panel

1. Connecting Enterprise Server to Elvis Server

Connect Enterprise Server to Elvis Server by setting the Elvis URL.

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. In the ELVIS_URL option, define the URL of the Elvis Server to connect to.

 * Elvis server URL (without a trailing slash)
 *
 * Used for server communication between Enterprise and Elvis Server.
 *
 * This is typically 'localhost' (if Elvis and Enterprise are running 
 * on the same machine), or the internal ip address of the Elvis Server.
 */
define('ELVIS_URL', 'http://localhost:80');

2. Setting up the communication between Enterprise and Elvis

Whenever an asset is updated in Elvis (such as updating its metadata, opening it in an external editor, or deleting it), Enterprise users need to be made aware of this. Similarly, when an Enterprise user makes a change to an asset, this needs to be communicated to the Elvis users.

This communication is provided through a script that runs on Enterprise Server using cURL. It is a long-polling PHP script which periodically checks the Elvis Server for asset updates.

Once an asset update is received it is applied directly to the Enterprise object.

Setting up cURL

The script is executed on Enterprise Server by using cURL.

Installation is done as follows:

  • For Mac OS X and Linux: cURL is pre-installed on these systems, no installation steps are necessary.
  • For Windows: download it from the cURL download site and install it.

Setting up the schedule for the script to run

The script runs for a maximum amount of time and needs to be scheduled to always run.

The following parameters are used:

  • maxexectime. The maximum amount of time that the script runs in seconds. The value should be between 60 and 1800 seconds (1 and 30 minutes) and should match the schedule interval. Default value=600.
  • maxtimeoutperrun. The maximum timeout in seconds for each update call to the Elvis Server. It should not be higher than the 'maxexectime' value. Default value=60.

The scheduling can be done by using Cron (Linux / Mac OS X) or the Task Scheduler (Windows).

Example configuration

Consider an example configuration with the following settings:

  • Enterprise runs under http://localhost/enterprise
  • The script should run every 5 minutes (=300 seconds) for an indefinite period of time

Configuring the Server plug-in

To give the plug-in sufficient access rights for making the changes to the assets, give it Super User rights for Elvis and Admin rights for Enterprise Server.

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. Validate the following credentials:

  • ELVIS_SUPER_USER
  • ELVIS_SUPER_USER_PASS
  • ELVIS_ENT_ADMIN_USER
  • ELVIS_ENT_ADMIN_PASS
/**
 * Elvis SUPER_USER username and password, needed for creating PDF previews 
 * with InDesign Server.*/
define('ELVIS_SUPER_USER', 'woodwing');
define('ELVIS_SUPER_USER_PASS', 'ww');

/**
 * Enterprise Admin username and password, needed for metadata synchronization  
 * from Elvis to Enterprise. By default we use a user which is known in both 
 * systems with the same credentials.*/
define('ELVIS_ENT_ADMIN_USER', ELVIS_SUPER_USER);
define('ELVIS_ENT_ADMIN_PASS', ELVIS_SUPER_USER_PASS);

Step 3. Save and close the file.

3. Defining how Elvis assets are used in Enterprise

An asset that is stored in Elvis can be used in Enterprise in one of the following ways:

  • As a shadow object that is created in Enterprise and that is linked to the asset in Elvis (default setting). Only when the Elvis file needs to be worked on is the original file — together with the file preview, thumbnail, metadata and versions — retrieved from Elvis and stored on the local system of the user.
  • As a copy that is created in Enterprise and that is not linked to the original in Elvis.
  • As a variant: a copy that is stored in Elvis and linked to a shadow object in Enterprise. The variant is also linked to the original image, thereby making it possible to see the original asset and all its variants. Variants are stored in a dedicated folder in Elvis, known as a 'Production Environment'. Multiple Production Environments can be set up, one for each Brand / Category combination. This makes it possible to use the same asset across different Brands.

For more information including how to configure this, see Controlling how Elvis assets are used in Enterprise 10.

4. Granting Elvis Pro users access to the 'Used In' panel

The Used In panel in Elvis Pro shows where in Enterprise an asset is used, for example on which layouts it is placed.

To see and use the panel, users need to be granted access. Do this by enabling the Permission named 'Use In' for a user or user group.

For more information, see Controlling user access to folders and assets in Elvis 6.

Enabling the plug-in

The installed plug-in needs to be enabled in Enterprise Server. Do this by accessing the Server Plug-ins page.

By accessing the page, the plug-in should be automatically enabled and show a green icon.

The Elvis Server plug-in

Figure: The Elvis plug-in enabled on the Server Plug-ins page.

Testing the integration

Step 1. In Enterprise Server, access the Health Check page.

Step 2. At the bottom of the page, click Clear All.

Step 3. Only select the Elvis Content Source test.

Step 4. Click Test.

The test is executed and the result is displayed next to the test. It should display “OK”.

Note: If the test fails, an error is displayed together with instructions for solving it. Follow the instructions and then run the test once more.

Step 5. Test the integration by for example dragging some files from Elvis into InDesign onto a layout that is stored in Enterprise.

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.