This article is part of a series that describes how to use Elvis 6 with Adobe InDesign.
In this article, the process of installing and uninstalling the plug-in in InDesign is described.
The Elvis InDesign plug-in
The Elvis InDesign plug-in (also known as the Elvis InDesign client) is a plug-in that connects InDesign and InDesign Server to Elvis Server.
This makes it possible to open layouts that are stored in Elvis, to place files from Elvis onto the layout, to save changes made in InDesign back to Elvis, and more.
For information about compatibility of the Elvis InDesign client with Elvis, InDesign and Smart Connection, see the WoodWing Compatibility Matrix.
Each InDesign instance requires a separate user license. For details, see Elvis 6 license types.
Step 1. Download the installer from the Client Install page of Elvis 6 Server.
Do one of the following:
- From the Avatar menu in the Pro client, choose Install clients.
- Access the Elvis Server launcher and click Client install page.
- Enter the following URL in a Web browser:
<Elvis 6 Server URL>/install/
Step 2. Unzip the downloaded file, run the installer and follow the steps onscreen.
Using the InDesign client requires an Elvis Pro license. Make sure that:
- Sufficient licenses are assigned in Elvis Server
- The user or user group has this license type assigned
InDesign Server startup
When the Elvis plug-in is used in InDesign Server, the Elvis server credentials need to be passed as arguments in the start-up command of InDesign Server. This should look as follows:
InDesignServer -port <port_number> -elvisserver "<elvis_server_url" -elvisusername "<elvis_username>" -elvispassword "<elvis_password>"
A sample start-up command is:
InDesignServer -port 18383 -elvisserver "http://elvis.woodwing.net" -elvisusername "username" -elvispassword "password"
To see if the log-in to Elvis was successful, verify the console.
During installation, plug-ins are installed in the following locations:
- InDesign folder > Plug-ins > Elvis
- InDesign folder > Plug-ins > WoodWing
To make it possible to open layouts directly from the Pro client, the following file is installed:
- On Windows: C:\ProgramData\WoodWing\ElvisInDesign.vbs
- On MacOS: /Applications/ElvisInDesign
Components added to InDesign
After installation, the following components will have been added to InDesign:
- An "Elvis" entry to the main menu. It contains options for connecting to and working with Elvis. For the InDesign client version 3.2 and higher, the menu also contains a Help option for accessing the documentation on the WoodWing Help Center.
Figure: The "Elvis" menu contains options for connecting to and working with Elvis.
- Options to the Links panel. The following entries are added for displaying in the panel:
From the panel menu, choose Panel Options...
- Elvis Path. The path of the linked file on Elvis Server.
- Elvis ID. The Elvis ID of the linked file.
- Elvis Url. The URL to the Elvis object of the linked file.
Figure: The Elvis options in the Links Panel Options dialog.
Figure: The Links panel with Elvis options shown in the Link Info pane.
- An About Elvis Plug-ins... option in the InDesign menu (on MacOS) or Help menu (on Windows). This will display which version of the Elvis InDesign client plug-in is installed.
Uninstalling the plug-in
To uninstall the files that were installed during the installation of the plug-in, do the following:
- On Windows: In Add/Remove programs, choose Elvis InDesign and select to remove it.
- On MacOS: Run the following file: InDesign folder > Uninstall Elvis InDesign plug-ins.
- 15 November 2018: Renamed from 'Installing the Elvis InDesign client for Elvis 6'.
- 15 November 2018: Updated section 'Installed components' with a list of files that are installed during installation.
- 15 November 2018: Added section 'Uninstalling the plug-in'.