This article is part of a series that describes how to use Elvis 5 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.
System requirements
For information about compatibility of the Elvis InDesign client with Elvis, InDesign and Smart Connection, see the WoodWing Compatibility Matrix.
License requirements
Each InDesign instance requires a separate user license. For details, see Elvis 5 license types.
Installation
Different installation steps exist depending on the version of the plug-in that you want to install.
Installation steps for the Elvis InDesign client version 3.2 and higher
Info: This version is provided as part of Elvis Server 5.23 or higher.
Step 1. Download the installer from the Client Install page of Elvis 5 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 Server URL>/install/
Example: localhost/install/
Step 2. Unzip the downloaded file, run the installer and follow the steps onscreen.
Steps for older versions
Step 1. Download the installer from the Client Install page of Elvis 5 Server.
Do one of the following:
- From the Avatar menu in the Pro client, choose Install clients (requires Elvis 5.21 or higher).
- Access the Elvis Server launcher and click Client install page.
- Enter the following URL in a Web browser:
<Elvis 5 Server URL>/install/
Example: localhost/install/
Step 2. Unzip the downloaded file, open the folder and start the installation by double-clicking one of the following files:
- For Windows:
| Adobe version | File |
|---|---|
| Adobe CS6 | win_install_CS6.bat |
| Adobe CC | win_install_CC.bat |
| Adobe CC 2014 | win_install_CC.bat |
| Adobe CC 2015 | win_install_CC.bat |
- For Mac OS:
| Adobe version | File |
|---|---|
| Adobe CS6 | mac_installer_CS6.app |
| Adobe CC | mac_installer_CC.app |
| Adobe CC 2014 | mac_installer_CC.app |
| Adobe CC 2015 | mac_installer_CC.app |
Step 3. Wait until the process is completed and then close the window.
Step 1. Download the installer from one of the following locations:
- For Elvis 5.0.61 and higher: Launch the Client Install page from the Elvis Server launch panel, click the icon for the Elvis InDesign client plug-in and save the file.
Figure: The Client install page option on the Elvis Server launch panel (left) and the Elvis InDesign client option on the Client Install page (right).
- For Elvis 5.0.60: Contact WoodWing Support.
Step 2. Double-click the downloaded file.
The Adobe Extension Manager will launch and will automatically install the plug-in.
Step 3.Verify that the plug-ins have been correctly installed by checking the following:
- For Mac OS X: Verify that the following 2 plug-ins exist:
- Location: InDesign application folder/Plug-ins/Elvis/
- File: Elvis.InDesignPlugin
- File: ElvisUI.InDesignPlugin
- For Windows: Verify that the following folders and files exist:
- Location: InDesign application folder/Plug-ins/Elvis/
- Folder: (Elvis Resources)
- Folder: (ElvisUI Resources)
- File: Elvis.pln
- File: ElvisUI.pln
Step 4. (Optional, only when upgrading from a previous version of the plug-in) Verify that the new version has been installed by checking the About Elvis Plug-ins... dialog.
- Mac OS X: InDesign > About Elvis Plug-ins...
- Windows: Help > About Elvis Plug-ins...
Assigning licenses
Each InDesign instance requires a separate user license. For details, see Elvis 5 license types.
Setting user permissions
The user needs to be given permission to use the Elvis InDesign client.
Step 1. In the Elvis Desktop Client, access the Manage Permissions tab.
Choose System > Manage Permissions.
Step 2. Locate the user or user group who should be given permission.
Step 3. Under "Client types" in the Capabilities tab, select InDesign client.
For more information about Capabilities, see Controlling user access to clients and client features in Elvis 5.
Assigning licenses
Make sure to assign sufficient licenses in Elvis Server for using the Elvis InDesign client.
InDesign Server startup
With the startup command of InDesign Server you also need to pass the Elvis server credentials as arguments. The command should look as follows:
InDesignServer -port <port_number> -elvisserver "<elvis_server_url" -elvisusername "<elvis_username>" -elvispassword "<elvis_password>"
A sample startup command is:
InDesignServer -port 18383 -elvisserver "http://elvis.woodwing.net" -elvisusername "username" -elvispassword "password"
In the console you can find a line that indicates if the login to Elvis was successful or not.
Installed components
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, follow the steps as outlined below.
Check which version is installed
Various versions of the Elvis InDesign client exist, each with their own process for uninstalling the software.
Check which version of the InDesign client is installed by accessing the About Elvis Plug-ins window:
- In the InDesign menu (on Mac OS X) or Help menu (on Windows), choose About Elvis Plug-ins... .
Depending on your version of the software installed, follow the steps as outlined below.
Steps for versions 3.2 or higher
Do one of the following:
- Run the Elvis InDesign client installer and choose to uninstall the software.
- (MacOS only) From the InDesign folder, run the file named 'Uninstall Elvis InDesign plug-ins.app'.
- (Windows only) Uninstall 'Elvis InDesign' by using the Windows 'Add/remove programs' feature.
Steps for older versions
An uninstaller can be used for uninstalling the plug-ins. This uninstaller is part of the download package for the Elvis InDesign client.
Step 1. Download the package from the Client Install page of Elvis 5 Server.
Do one of the following:
- Access the Elvis Server launcher and click Client install page.
- Enter the following URL in a Web browser:
<Elvis 5 Server URL>/install/
Example: localhost/install/
Step 2. Unzip the downloaded file, open the folder and start the process by double-clicking one of the following files:
- For Windows:
| Adobe version | File |
|---|---|
| Adobe CS6 | win_uninstall_CS6.bat |
| Adobe CC | win_uninstall_CC.bat |
| Adobe CC 2014 | win_uninstall_CC.bat |
| Adobe CC 2015 | win_uninstall_CC.bat |
- For Mac OS:
| Adobe version | File |
|---|---|
| Adobe CS6 | mac_uninstaller_CS6.app |
| Adobe CC | mac_uninstaller_CC.app |
| Adobe CC 2014 | mac_uninstaller_CC.app |
| Adobe CC 2015 | mac_uninstaller_CC.app |
The process will take a few moments to complete.
Step 1. Access the Adobe Extension Manager for your version of InDesign.
Step 2. In the list of products, choose InDesign.
Step 3. In the list of extensions, select the 'Elvis InDesign client' extension and click 'Remove'. Confirm that you want to remove the extension.
The process will take a few moments to complete.
Document history
- 22 November 2018: Renamed article from 'Installing the Elvis InDesign client for Elvis 6'.
- 22 November 2018: Updated section 'Installed components' with a list of files that are installed during installation.
- 22 November 2018: Added section 'Uninstalling the plug-in'.
Comments
0 comments
Please sign in to leave a comment.