Configuring Smart Caching for Smart Connection
The Smart Caching feature of Smart Connection allows a file to be automatically downloaded onto a user's system when the file is routed to that user. Downloading the file takes place in the background while the user continues working with Smart Connection.
As a result, the file is immediately available when the user wants to edit the file and saves the user from having to manually start the download process and then having to wait for it to be completed.
This feature is especially useful when connection speeds are low and/or when files in large sizes need to be downloaded.
By default this feature only works when a file is routed to an individual user but it can also be enabled for user groups of no more than 7 users.
This article explains how to configure Smart Caching for Smart Connection. For information about using it, see Automatically downloading a routed file in Smart Connection.
Using Smart Caching for Smart Connection requires the following to be in place:
- One of the following versions of Smart Connection:
- Smart Connection for Adobe InDesign CC 2014 or InCopy CC 2014 (version 10.3.0 or higher)
- Smart Connection for Adobe InDesign CC 2015 or InCopy CC 2015 (version 11.2.0 or higher)
- Smart Connection for Adobe InDesign CC 2017 or InCopy CC 2017 (version 12.1.0 or higher)
- The Content Station Server plug-in 10.28 or higher1 (see step 6 'Installing the Content Station Server plug-in' in Content Station 10 full installation.)
- The Content Station Server plug-in 10.29 or higher1 for using Smart Caching for user groups
- The Content Station Desktop app 2.2.0 (available since Content Station 10.28) or higher1
- RabbitMQ integrated in Enterprise Server 10.0 or higher
- An Enterprise Server license (used by the Desktop app for connecting with Enterprise Server)
1 Smart Connection makes use of the Smart Caching feature of Content Station 10 and therefore requires components of Content Station 10. Content Station 10 itself is not required.
It is assumed here that all these are in place and fully working.
Note: Smart Caching is not supported for Smart Connection for InDesign Server.
Before you start
Please be aware that even when enabling Smart Caching on system level, that each individual user can pause or disable the Smart Caching functionality on their system from within the Content Station Desktop app or from the Smart Connection Preferences. In other words: enabling Smart Caching on system level does not guarantee that the feature is actually active for each user that is allowed to use it because the user may have paused or disabled it on their system.
Configuration steps need to take place in Enterprise Server and optionally in Smart Connection:
- Enterprise Server: enabling Smart Caching on system level
- Enterprise Server: allowing the user to use Smart Caching
- Smart Connection: enabling Smart Caching through the WWSettings.xml file
1. Enterprise Server: enabling Smart Caching on system level
The Smart Caching feature first needs to be enabled in Enterprise Server.
Step 1. In the instance of Enterprise Server in which the Content Station 10 Server plug-in is installed, access the Content Station Management Console.
Click Integrations > Content Station 10
Step 2. In the menu on the left, select Smart Caching.
Step 3. Click Enable Smart Caching.
Smart Caching now works when a file is routed to a single user. Making it work for sending a file to a user group requires additional steps.
Note: For performance reasons, this feature is restricted to user groups of no more than 7 users.
Step 4. (Optional) Enable Smart Caching for each user group as needed.
2. Enterprise Server: allowing users to use Smart Caching
Users need to be given permission to use Smart Caching by setting the Access Profile for users and user groups.
In Enterprise Server, set the following Access Right:
Applications > Smart Caching
Note: Enabling this Access Right and assigning it as part of an Access Profile to one Brand makes Smart Caching available for use in ALL Brands on that server that the user has access to.
3. Smart Connection: enabling Smart Caching through the WWSettings.xml file
Smart Caching for Smart Connection is enabled by default. If needed, users can disable it through the Smart Connection Preferences.
Note: Smart Caching can also be disabled in the Content Station Desktop application itself but this would also disable it for Content Station 10. The preference in Smart Connection makes it possible to only disable Smart Caching for Smart Connection.
Optional: to make sure that the Smart Caching preference is always enabled or always disabled without allowing the user to change the preference, add the following option to the WWSettings.xml file and set it to yes or no depending on your needs:
Mac OS X
- /Library/Application Support/WoodWing
Note: This folder is hidden by default. To display this folder, change the folder options. (See the Windows Help file.)
Important: Make sure to validate the WWSettings.xml file for correct content. See Validating the WWSettings.xml file.
How users connect to Smart Caching
Even though Smart Caching has been enabled in Enterprise Server and users have been given permission to use it, the users can influence the working of Smart Caching through the Desktop app in the following ways:
- Whether or not Smart Caching is enabled on their system. When first using Smart Caching for a particular server, the user is asked if Smart Caching needs to be enabled. Should users be on a slow connection, they may decide to disable Smart Caching for performance reasons. Users can also disable Smart Caching at any point through the Desktop app settings or the Smart Connection preferences.
- Pausing Smart Caching. Smart Caching can at any time be paused through the Content Station Desktop app
For more information about using Smart Caching in Smart Connection see Automatically downloading a routed file in Smart Connection.
When Smart Caching is for some reason not working correctly, please be aware that the working of it can be controlled or influenced in various locations. Make sure to check these locations when troubleshooting issues:
- Smart Caching option in Content Station Management Console. This can be seen as the 'main switch' for Smart Caching. When disabled, the feature is not working at all.
- Smart Caching Access Right. Users need to be given permission to use Smart Caching through an Access Right.
Note: Enabling this Access Right and assigning it as part of an Access Profile to one Brand makes Smart Caching available for use in ALL Brands on that server that the user has access to. Or in other words: even when the Access Right is not assigned to a Brand through an Access Profile, it might still be available for that Brand because it is assigned to another Brand in the same instance of Enterprise Server.
- Smart Caching Preference for Smart Connection. Smart Caching can be enabled or disabled for Smart Connection only through the Smart Connection Preferences. Whether or not this preference can be edited by a user is controlled through the WWSettings.xml file.
- Smart Caching options in the Content Station Desktop app. For each instance of Enterprise Server that is connected to the Content Station Desktop app, Smart Caching can be disabled. The working of Smart Caching (for Smart Connection as well as for Content Station) can also be paused from within the app.
- 11 December 2017: Updated section 'Requirements' with Smart Connection for Adobe InDesign CC 2017 or InCopy CC 2017.
- 19 October 2017: Updated section 'Requirements' with Smart Connection for Adobe InDesign CC 2015 or InCopy CC 2015.