Smart Connection full installation

A full installation of Smart Connection is an installation on a system on which Smart Connection is not yet installed.

The installation consists of the following steps:

1. Installation
2. Configuration
3. Licensing
4. (Optional) Setting up templates
5. Testing the installation

Note: It is assumed here that a fully working Enterprise Server is set up, including Brands and Issues.

Before you start

Please check the compatibility of Smart Connection, with InDesign, InDesign Server, InCopy, and Enterprise Server. For more information, see the Compatibility Matrix for the version of Adobe that is used.

Upgrading InDesign and InCopy

When you are upgrading to a new version of Adobe InDesign or InCopy, keep the following in mind:

• All InDesign and InCopy users should use the same Adobe version. This is because documents created in a newer version cannot be opened in a previous version.
• Convert any InDesign and InCopy templates to the new version of InDesign and InCopy. Do this by opening the file and re-saving it.

What is installed?

During the installation, the following is installed:

• Plug-ins in the plug-in folder of InDesign, InDesign Server, or InCopy respectively. These contain all the functionality of Smart Connection.

For an overview of what is added, see:

• Components that are added to InDesign by Smart Connection
• Components that are added to InCopy by Smart Connection

• The WoodWing Studio IDP application. This identity provider (IDP) application is used for the communication between a Web browser and the Smart Connection plug-ins. It is used in the following cases:

1. Single Sign-On (SSO). When a user successfully logs in to the authentication provider, the Web browser sends a URL with a specific URI scheme. The application intercepts this URI and lets Smart Connection know that the log on was successful by calling a script.
2. Opening layouts and articles from Studio. When a user opens a layout or article from Studio into InDesign or InCopy, Studio calls a URL with a specific URI scheme. The used protocol defines the application that is called (InDesign or InCopy), and the version of that application.

Note: The application is only installed on macOS (in the /Applications folder); on Windows, the functionality is provided via the registry and scripting.

1. Installation

Installing Smart Connection can be done in the following ways:

• By manually running the installer. This method is aimed at end users who want to install Smart Connection on their system.
• By running the installer via a command prompt. (Windows only) This method is aimed at system administrators who want to remotely control software installations.

Running the installer manually

Step 1. Download the installer from the Software Releases page.

Step 2. Double-click the installer and follow the steps on screen.

Note for installing on macOS 10.14 Mojave and higher Due to the security features of macOS, notifications may appear during the installation such as: "Installer" would like to access your calendar "Installer" would like to access your photos Click OK to continue the installation. Please note that personal data such as your calendar or photos is not actually accessed. The messages appear because these applications are located in a folder or store data in a folder that has an increased protection. The installer actually needs access to the common folder but not the applications or folders that reside in that folder. This is not clearly explained in the message that appears. Also note that each message only appears once, so if you see a message appear when installing one application it will not appear again when installing another application. Controlling these settings can be done in System Preferences > Security and Privacy > Privacy.

Step 3. When done, click Close to close the installer.

Running the installer via a command prompt

Info: This method is available for Windows only and requires the installer for Smart Connection 15.0.0 for Adobe 2020, or any higher version of Smart Connection (see how to check the version of Smart Connection that is installed).

Step 1. Download the installer from the Software Releases page and make it available in a central location.

Step 2. Use the following command to perform the installation:

msiexec.exe /i "<path to installer>" /qn ADDLOCAL=<name of plug-in to install> <application ID>_PATH="<path to application>"

The following parameters are used:

• ADDLOCAL: The name of the plug-in to install. Use one of the following parameters:
• InCopy
• InDesign
• InDesignServer

• application ID_PATH: The ID and path of the application into which the plug-ins need to be installed. Use one of the following application IDs:
• IC for InCopy
• ID for InDesign
• IDS for InDesign Server

Example: Here, Smart Connection for Adobe 2020 is installed for InDesign: msiexec.exe /i "C:\Smart Connection for Adobe 2020.msi" /qn ADDLOCAL=InDesign ID_PATH="C:\Program Files\Adobe\Adobe InDesign 2020"

Note: Multiple plug-ins can be installed simultaneously. Here, the plug-ins for InDesign and InCopy are installed: msiexec.exe /i "C:\Smart Connection for Adobe 2020.msi" /qn ADDLOCAL=InDesign,InCopy ID_PATH="C:\Program Files\Adobe\Adobe InDesign 2020" IC_PATH="C:\Program Files\Adobe\Adobe InCopy 2020"

Functionality conflicts with existing plug-ins

Some of the Smart Connection plug-ins that are installed contain functionality that conflicts with default plug-ins in InDesign, InDesign Server, and InCopy.

To make Smart Connection work, the working of the default plug-ins is disabled by doing one of the following:

• For Smart Connection 2018 or higher: The default plug-ins are prevented from being loaded when InDesign, InCopy, and InDesign Server is started. A reference to these plug-ins is kept in a file named PluginConfig.txt which is stored in the application folder of InDesign, InDesign Server, and InCopy.

• For Smart Connection 2017 or lower: The plug-ins are moved to a folder named 'Plug-Outs' in the application folder of InDesign, InDesign Server, and InCopy. When uninstalling Smart Connection, these plug-ins are automatically placed back into their original location.

These plug-ins are taken from the following locations in the InDesign/InCopy application folder:

• InDesign: /Plug-Ins/InCopyWorkflow folder and /Plug-Ins/UI folder

• InDesign Server: /Plug-Ins/InCopyWorkflow folder

• InCopy: /Plug-Ins/InCopyWorkflow folder and the /Plug-Ins/UI folder

The following plug-ins are moved:

Note: On macOS the plug-ins have extension .InDesignPlugin, on Windows the plug-ins have extension .apln.

• Assignment UI. Assignment-related user interface.
• InCopy Bridge. InDesign Bridge functionality.
• InCopy Bridge UI. Live Edit user interface.
• InCopyExport. Standard export.
• InCopyExportUI. User interface for the standard export.
• InCopyFileActions. File related actions for Live Edit.
• InCopyFileActionsUI. File related actions for Live Edit.
• InCopyImport. Import of stories.
• InCopyWorkflow UI. User interface for the InCopy workflow.

2. Configuration

The way that Smart Connection can be used is controlled by configuring Enterprise Server and Smart Connection. For more information, see Configuring Smart Connection.

3. Licensing

Before Smart Connection can be used, a license needs to be activated for it. For more information, see the articles about activation.

4. (Optional) Setting up templates

A new article or layout is typically based on a template that matches the styling of the publication of which the article will be part.

Make sure that such templates exist. See Working with article templates in Smart Connection.

5. Testing the installation

As a final step, test the working of Smart Connection by logging in and performing tasks such as creating a new layout, placing files that are stored in Enterprise, checking-in the layout, and so on.

Document history

• 7 April 2021: Added section 'What is installed?'.