This is intended for organizations that want to automate the review archival process upon review completion. In short,
when a review completes, you'll get a zip archive that contains everything that happened in the review. The archive will
contain PDF documents, and the file versions involved. This non-proprietary format will allow you to keep your
regulatory review data for years to come, without having to maintain a Collaborator server forever.
How does the automated process work?
We'll call the Collaborator command line client directly from a server trigger when the review changes phases. We wont check to see if the phase has transitioned to completed, because the archive command line will not export an in-progress review. If your team is using the tool heavily, then you should create a shell script or batch file, and check the review phase before calling the Collaborator command line client. This will result in improved performance, but is not really necessary for small or medium sized installations.
Configuring the trigger in Collaborator
1. Install the Collaborator client software on the Collaborator server.
Command line client instalaltion: http://codecollaborator.smartbear.com/docs/manual/9.0/client_install.html
2. Create a directory to store our archived reviews. We'll be using c:\my-archived-reviews in this example. Note that we'll use /my-archived-reviews in the Linux example.
3. Login to the Collaborator web interface as an administrator.
4. Go to the Admin->Triggers page
5. Find the "Review Phase Changed" trigger, and configure it as follows:
Windows:
Executable: c:\program files\collaborator client\ccollab.exe
Parameters: admin archive $
{review.id} --zip-path c:\my-archived-reviews
Linux:
Executable: /usr/local/ccollab_client/ccollab.exe
Parameters: admin archive ${review.id}
--zip-path /my-archived-reviews
Note: You'll need to update the executable path for the Collaborator command line client as necessary.
More information on Collaborator server triggers:
http://codecollaborator.smartbear.com/docs/manual/9.0/admin_triggers.html