Configuring multicasting in Studio Server

Info: Performing the steps described in this article requires direct server access. Depending upon how your system is hosted and the level of access you have to that system, coordination may be required with your Partner or WoodWing Support team. For a full overview of the steps that need to be done by WoodWing and how to request them, see WoodWing Cloud - Change management.

Multicasting is an alternative to the broadcasting feature and should be used in segmented networks with multiple subnets.

This article describe how to configure multicasting in Studio Server.

Note: Support for broadcasting or multicasting is not available in Studio for InDesign and InCopy 16.0.0 for Adobe 2021 or higher; use RabbitMQ instead.

Requirements

This feature makes use of a 'Multicast Mediator' which takes care of the multicasting. It is a separate service written in Python that needs to run continuously on a server machine.

Various versions of Python exist; make sure to use Python version 2.x.

Configuration steps

Step 1. Open the configserver.php file (recommended: config_overrule.php file) for the Studio Server installation.

Step 1a. Configure the following options:

Time-to-live

• Name in file: MULTICAST_TTL
• Location: SERVERFEATURES
• Possible values:
• 0 Host
• 1 Subnet
• 32 Site
• 64 Region
• 128 Continent
• 255 Unrestricted
• Default value: 32
• Example:

define ('MULTICAST_TTL', 32);

 Network interface connection

• Name in file: MULTICAST_IF
• Location: SERVERFEATURES
• Possible values: The address of your network card.
• Default value: 127.0.0.1
• Example:

define ('MULTICAST_IF', '127.0.0.1'),

Note: Multicast messages are sent out through the network interface. Make sure that the right interface is referenced, especially if your server machine has more than one network card.

Event port

• Name in file: EventPort
• Location: SERVERFEATURES
• Possible values: The port on which messages are sent.
• Default value: 8093
• Example:

define ('EventPort', '8093'),

Multicast Group

• Name in file: MulticastGroup
• Location: SERVERFEATURES
• Possible values: The address of the multicast group.
• Default value: 224.0.252.1
• Example:

define ('MulticastGroup', '224.0.252.1'),

Step 1b. Disable the following option:

• Name in file: Broadcasting
• Location: SERVERFEATURES
• Example:

// define ('Broadcasting'),

Note: Messages are sent to the client applications by using either 'Broadcasting' or 'Multicasting'. When using multicasting therefore, the Broadcasting option needs to be disabled.

Step 2. Configure the Multicast Mediator.

Studio Server itself cannot perform multicasting because this is not supported by PHP. Instead, a Multicast Mediator is used (shipped with Studio Server).

This Multicast Mediator is a separate service written in Python that needs to run continuously on a server machine. This essentially means that Python needs to be installed to let Studio Server perform multicasting. Studio Server tells the mediator through TCP/IP which multicast messages need to be send.

The following Multicast Mediator settings can be controlled:

MC_MEDIATOR_PORT

• File: configserver.php file (recommended: config_overrule.php file)
• Name of option: MC_MEDIATOR_PORT
• Possible values: The MC_MEDIATOR_PORT setting is a UDP port used for the IP address indicated by the MC_MEDIATOR_ADDRESS setting. This can be the local address if the mediator is running on the same machine as the Studio Server.
• Default value: 127.0.0.1
• Example:

define ('MC_MEDIDATOR_PORT', '8094');