Skip to main content
English (United States) Nederlands

Configuring the Enterprise Server instance for InDesign Server to log in to

Updated

When making use of InDesign Servers to run InDesign Server Jobs, InDesign Server needs to log in to Enterprise Server.

To make this possible, the name of the Enterprise Server to which InDesign Server needs to log in to needs to be defined, as well as the settings for connecting to that server. Each is done in a separate step.

Info: This article contains references to macOS. Running Enterprise Server 10 on macOS is only supported on Enterprise Server version 10.8 or lower.

1. Defining the Enterprise Server name

In this step, the logical name of the Enterprise Server instance to which InDesign Server needs to log in to is defined.

This is done in a configuration file of Enterprise Server.

Step 1. Access the configserver.php file for the installed Enterprise Server.

ClosedShow me the location of this file

<Enterprise Server path>/config

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.

Step 2. Locate the INDESIGNSERV_APPSERVER section.

// INDESIGNSERV_APPSERVER:
//    The logical name of the application server to log on to (from an InDesign Server 
//    point of view). This should match the ServerInfo name in the WWSettings.xml file
//    or the APPLICATION_SERVERS setting.
//
define ('INDESIGNSERV_APPSERVER', SERVERNAME );

Step 3. Replace SERVERNAME with the exact name of the Enterprise Server instance.

Example: Here, the instance of Enterprise Server is named 'xTreme':

define ('INDESIGNSERV_APPSERVER', "xTreme");

Note: Quotation marks are used when adding a custom value, whereas no quotation marks are used for the default value SERVERNAME.

Step 4. Save the file.

2. Defining the Enterprise Server settings

In this step, the connection to the Enterprise Server instance that is referred to in step 1 is defined.

This can be controlled in Enterprise Server or on the system on which InDesign Server is installed.

  • Controlling it in Enterprise Server. Using this method makes it easy to roll-out changes throughout the company, for example when a new version of Enterprise Server is installed. This method will overrule any setting that may have been set on the system on which InDesign Server is installed.
  • Controlling it on the system on which InDesign Server is installed. When using this method, the setting is specific to that system but needs to be updated on that system when the reference to Enterprise Server changes (for example after an upgrade).

Controlling the settings in Enterprise Server

This is a 2-step process:

  1. Configuring the connection in Enterprise Server.
  2. Making sure that InDesign Server uses that connection.

1. Configuring the connection in Enterprise Server

Step 1. Access the configserver.php file for the installed Enterprise Server.

ClosedShow me the location of this file

<Enterprise Server path>/config

Step 2. Locate the APPLICATION_SERVERS section.

// APPLICATION_SERVERS:
// List of available application servers (returned through GetServersReponse SOAP 
// call).
// To return only 'this' application server, just comment out the APPLICATION_SERVERS 
// definition as follows:
//    //define( 'APPLICATION_SERVERS', serialize( array() ) );
// To return NO application servers (and so let clients use wwsettings.xml), define 
// empty APPLICATION_SERVERS as follows:
//    define( 'APPLICATION_SERVERS', serialize( array() ) );
//
define( 'APPLICATION_SERVERS', serialize( array(
   //  ServerInfo( Name, URL [, Developer] [, Implementation] [, Technology] 
   //  [, Version] [, array of Feature] [, Cryptkey (file path)] )
   new ServerInfo( SERVERNAME, SERVERURL, SERVERDEVELOPER, SERVERIMPLEMENTATION, SERVERTECHNOLOGY, SERVERVERSION, unserialize(SERVERFEATURES), defined('ENCRYPTION_PUBLICKEY_PATH') ? ENCRYPTION_PUBLICKEY_PATH : null ), // this server
   new ServerInfo( 'WoodWing.net', 'http://demo.woodwing.net/Enterprise/index.php', SERVERDEVELOPER, SERVERIMPLEMENTATION, SERVERTECHNOLOGY,
   	'', 	// version unknown - may not be null
   	array() )// feature set unknown - may not be null
)));

Two Servers are already present: one that is defined by internal definitions such as SERVERNAME and SERVERURL, and a custom Server named 'WoodWing.net'.

Step 3. Replace the example Server by your own Server and add additional Servers as needed.

Step 4. Save the file.

2. Making sure that InDesign Server uses that connection

Next, it needs to be made sure that InDesign Server uses the connection that is set up on Enterprise Server.

Note: This step only needs to be performed once; once in place, only the configserver.php file needs to be updated for any future changes.

Step 1. Access the WWSettings.xml file on the system on which InDesign Server is installed.

ClosedShow me the location of this file

macOS

Info: Running Enterprise Server 10 on macOS is only supported on Enterprise Server version 10.8 or lower.

  • /Library/Application Support/WoodWing

Windows

  • c:\ProgramData\WoodWing

Note: This folder is hidden by default. To display this folder, change the folder options. (See the Windows Help file.)

Step 2. Comment out or remove the <SCEnt:Servers> </SCEnt:Servers> section.

Step 3. Add a single <SCEnt:ServerInfo> element directly under the Settings node, defining the Server containing the modified configserver.php file.

Example:

<Settings xmlns:SCEnt="urn:Smart Connection Enterprise" xmlns:SC="urn:SmartConnection" xmlns:WoodWing="urn:WoodWing Software">

<SCEnt:ServerInfo name="Enterprise" url="http://localhost/Enterprise/index.php"/>

Note: In this scenario, only one <SCEnt:ServerInfo> element is allowed. During startup, the defined Enterprise Server instance is accessed and the list of Servers is retrieved from the configserver.php file.

Step 4. Save the file.

Important: Make sure to validate the WWSettings.xml file for correct content. See Validating the WWSettings.xml file.

Defining the settings on the InDesign Server system

Step 1. Access the WWSettings.xml file for the system on which InDesign Server is installed.

ClosedShow me the location of this file

macOS

Info: Running Enterprise Server 10 on macOS is only supported on Enterprise Server version 10.8 or lower.

  • /Library/Application Support/WoodWing

Windows

  • c:\ProgramData\WoodWing

Note: This folder is hidden by default. To display this folder, change the folder options. (See the Windows Help file.)

Step 2. Add the instance of Enterprise Server between the <SCEnt:Servers> </SCEnt:Servers> tags in the following syntax:

<SCEnt:ServerInfo name="name" url="URL"/>

  • name is the name as it will appear in the list
  • url is the URL of the instance of Enterprise Server

Example 

<SCEnt:Servers> 
<SCEnt:ServerInfo name="Enterprise" url="http://localhost/Enterprise/index.php"/> 
</SCEnt:Servers>

Step 3. Save the file.

Important: Make sure to validate the WWSettings.xml file for correct content. See Validating the WWSettings.xml file.

Related articles

Comments

0 comments