Home : Digital Asset Management : Upgrading & Synchronizing OpenEdit

Upgrading OpenEdit

The Upgrade Plugins tool is used to upgrade or install plugins for the OpenEdit framework. It is accessed via the "Settings" menu in the OpenEdit Admin Toolbar. Any installed plugins will appear with a corresponding "Installed Version" number. Any plugins which have not been installed will show no "Installed Version" number.

To upgrade an installed plugin, check the "To Update" box for that plugin, and click the "Upgrade" button. If you wish to install a new plugin from the list, check the "To Update" box for that plugin, and click the "Upgrade" button. That plugin will be installed with the newest version available.

The Scheduler

The scheduler is accessed from the "Settings" menu in the OpenEdit Admin Toolbar. The scheduler is a powerful tool that allows you to run actions based on a timer. Normal uses for this include synchronizing your OpenEdit Digital Asset Management system to your databases or other external sources. It can also be used to synchronize two instances of the OpenEdit DAM.

Configuring a New Scheduler Action

  • To schedule a new action, simply click the "New" button in the scheduler. This will create a new action. By default, new actions will try to execute /run.html.
  • Click on the new action to edit it.
  • Fill in the data fields.
    • Name: This is the display name for the action in the scheduler.
    • Path: This is the path that will be run on the timer. To run a custom action, you will need to set up an xconf file that runs the action, then type the path to that page here.
    • Period: The action will be re-executed after this amount of time. Example values: "1d" for 1 day, "1h" for 1 hour, "1s" for 1 second. Enter "0" to only run this action upon startup.
    • Start Delay: After startup, the scheduler will wait this long to run the action for the first time. See sample values above.
  • Be sure to click "Save" when you are done.

Configuring a New OpenEdit-OpenEdit Sync

We found that many people want to have more than one copy of their OpenEdit Digital Asset Management system, whether it be for load balancing issues, or running separate servers for users in varying geographical locations. To solve this issue, we created the OpenEdit-OpenEdit sync process, which can be configured through the scheduler. To set up a sync, first click the "New Sync" link at the top of the scheduler, and then fill in the following data:

  • Name: This is the display name for the action in the scheduler.
  • Path: Leave the path as it is when you clicked the "New Sync" link.
  • accountname: This needs to be the username of an administrator level account that exists, with the same password on both OpenEdit instances to be synchronized.
  • syncpath: The relative path that will be synchronized. This would commonly be /archive to synchronize you entire archive directory.
  • exclude: This is a comma separated list of files that will be ignored by the synchronization process. This can use regular expressions to exclude many files at once. (e.g. "*_site.xconf, /archive/products/*")
  • siteurl: The URL of the OpenEdit site that you want to synchronize with.
  • Start Delay: The scheduler will wait this long after the web server is started to execute this action.
  • Period: After the action is executed, the scheduler will wait this long to re-run the action.

Be sure to click "Save" when you have finished entering data. As long as the action is set to be enabled, it will execute after you click "Save" (after the delay time).