How to setup Asset Bank to publish from one Asset Bank instance to another. (Previously known as synchronisation.)
Overview:
The Publishing feature allows you to send assets from one Asset Bank to another. This can be set up to happen at a particular time of day, AND/OR at the press of a button (via Admin > Publishing). In addition, it also allows you to update metadata on previously synchronised assets and then send these changes across to the target Asset Bank (i.e. as well as publishing assets from one Asset Bank to another, you can also publish changes to assets that have already been sent over, enabling you to keep them in sync).
Important to note:
- the assets metadata will be effectively sent over only if the receiving Asset Bank has matching attributes (type and name) as the sending one.
- if the Asset Banks have Asset Types enabled you will need to have the same Asset Types name on both sending and receiving Asset Bank for all the assets you intend to publish, and these should also be in the same order
- if Asset Types are enabled then the 'Media Types' for the receiving instance must be exactly the same as the instance being published from
- if you delete an asset from the target Asset Bank that had been published, then this will not be sent across again
How to set it up:
If you are running version 3.1244.8 or greater then you need to firstly select a password to secure your Asset Bank Copy publishing actions. The password will be used on both the sending and receiving Asset Banks.
1. Sending/local instance (i.e. the Asset Bank you want to publish FROM)
- Navigate to Admin > Publishing and click Add a new Publishing Action. Click Specify search criteria to specify which assets will be published. All assets meeting the given search criteria will be published as part of this publishing action.
- Select a name for the publishing action and choose Asset Bank Copy as the transfer method. The Server field must be a valid URL for the target Asset Bank (the one you want to publish TO). This is in the form http://www.your-domain.co.uk/asset-bank or http://[server IP]:[port]/asset-bank.
- Prior to version 3.1396: Ticking Run Daily will cause the publishing action to run daily at the hour specified in run-publishing-actions-hour-of-day. If Run Daily is left unticked then the publishing action will do nothing until it is explicitly run from the admin interface.
- Version 3.1396 onwards: If you want to schedule the publishing action to run at intervals automatically then clicked the 'Scheduled?' checkbox and you will be presented with following options...
- Start Time - the first time to run the sync
- Interval & Interval Type - the type of interval between each sync (day, hour or minute) and the number of each interval type (so entering 2 in the text box and picking hour from the drop down list will result in the sync running every 2 hours).
- Version 3.1244.8 onwards: specify the password you selected in the password text field
- Save the publishing action.
- Check that the import and export date formats are the same in both sending and receiving Asset Bank settings files, otherwise this will cause an error.
Using the settings below, which you can find in the ApplicationSettings.properties, you can configure date formats and image conversion parameters (for example, to publish assets in a JPEG format with a maximum height of 200 pixels, set publish-original-file-destination-format=jpg and publish-original-file-destination-max-height=200)
In the "Import/Export settings" section
- The format of dates in export files
export-date-format=yyy-MM-dd hh:mm:ss - The format of dates in import files
import-date-format=yyyy-MM-dd hh:mm:ss
In the "Scheduled tasks" section
- Prior to version 3.1396: Time of day to run scheduled publishing actions
run-publishing-actions-hour-of-day=2
In the "Asset Publishing Settings" section
- Should we use a converted version as the original file on the recipient Asset Bank? If so, specify the format (jpg, bmp etc), if not leave blank
publish-original-file-destination-format= - If we are using a converted version for the original file, what is the maximum height to use (aspect ratio will be maintained)
publish-original-file-destination-max-height= - If we are using a converted version for the original file, what is the maximum width to use (aspect ratio will be maintained)
publish-original-file-destination-max-width=
2. Receiving/target instance (i.e. the Asset Bank which you are publishing TO)
- Check that the import and export date formats are the same in both sending and receiving Asset Bank settings files, otherwise this will cause an error.
- Set the 'import-try-match-categories-by-leaf-name' setting to true if you want the synchronisation trying matching the categories top level name when the full name (e.g. 'animals/cats') does not match.
- Version 3.1244.8 onwards: Populate the 'digest-authentication-password' setting with the password you selected.
Using the settings below, which you can find in the ApplicationSettings.properties, to configure the import/export settings.
In the "Import/Export settings" section
- The format of dates in export files
export-date-format=yyyy-MM-dd hh:mm:ss - The format of dates in import files
import-date-format=yyyy-MM-dd hh:mm:ss - If a category or folder name specified in a metadata import file does not match the full name of a category then try matching the leaf name (i.e. not the ancestor names) of the specified category against leaf name of the destination categories. For example, if true then 'animals/cats' would match a top-level category called 'cats'.
NOTE this setting affects 'synchronisation' between two Asset Banks as well.
import-try-match-categories-by-leaf-name=false
Comments
0 comments
Please sign in to leave a comment.