Using CMIS Sync. Set Up CMIS Sync and Start Syncing

Transcription

1 Using CMIS Sync The CMISSync service allows an Interactive Tool to use a 'synced' ERW location in order to read input files or to write an output generated. This allows an Interactive Tool to access the ERW repository in a dynamic fashion, rather than having an initial (fixed) set of input files (on interactive tool start-up) and a single set of output files copied back to the ERW when the interactive tool is closed. The purpose of using CMISsync is to allow additional input files to be made available to the Interactive Tool, without having to restart the Tool allow output to be written back and made available within the ERW repository straight away, without having to close (stop) the Interactive Tool There is a processing overhead placed on the ERW to enable such syncing between tools and the ERW repository, therefore this approach should be used only when the normal Input/Output folder approach is not suitable, e.g. where there is no need for dynamic reading or writing of files between the ERW and the interactive tool, i.e. all the input files required are made available when the tool is started and the output generated does not need to be made available within the ERW until the interactive tool has been closed. It is also advised that you Stop Syncing when you are finished with your tool to prevent unnecessary processing of file synchronisation in the background. A Tool must be configured to allow for CMISSync, see below for more information. The guidance for CMIS Sync is as follows:- Set Up CMIS Sync and Start Syncing Navigate to Synced area within Interactive Tool Stop CMIS Syncing Set Up Tool to allow use of CMIS Sync Set Up CMIS Sync and Start Syncing Connection to the CMISSync folder works in a similar fashion to the connection to interactive tools. Before setting up the sync, you need to follow the instructions preparing to run Interactive Tools. Locate the CMIS Sync connection utility, (which is made available in a folder in the Shared Files area -> CMIS Sync):- Hover over the CMIS Sync Connection.jar file and select Download. The following pop-ups will appear:- Click OK to the Unable to open web browser message

2 DO NOT CLOSE the RDP File Sync support applet until you are finished with CMIS Sync. If you do close the connection your session with the CMIS Sync service will be terminated. In Windows, open Remote Desktop Connection (Start->All Programs->Accessories->Remote Desktop Connection) In Computer: key in the localhost string shown in the RDP File Sync support applet (do not include the preceding rdp:// or the trailing /) The login screen appears key in your ERW username and password and click OK. You are now presented with the ubuntu welcome screen:- To open a command console, click Applications (in the top left) and select System Tools->Xterm:-

3 A command console appears:- Key in the command cmissync start. If this is the first time you have used CMIS Sync, you will be presented with the following welcome screen:-

4 Keep selecting Continue until you see the below screen. You should now see a red circle icon appear in the top right of the screen as shown below. If you have used CMIS Sync before, the red circle icon should already appear. Click the red circle icon and select the Add a remote folder option. The following screen appears:-

5 Key in into the Web Address field. The User: field is pre-population with your ERW user name. Key in your password into the Password: field, and select Continue, this is the same password as you use to access the ERW. The following screen appears:- Click the arrow next to Main Repository to reveal the folder structure.

6 All folders appear as 'selected' (green). Deselect all folders except User Homes. Click the arrow next to User Homes to reveal your user area and file structure (this is your My Files area). Click the checkbox next to the folder you wish to sync (it will go green). Select Continue. The following screen appears:- Enter your own folder name in the Enter a name for the local folder where the documents are synchronised box (i.e. overwrite the default value), and click Add. You do not need to change the local path of the repository.

7 Click Finish. Your files will now be synced and will be available to the Interactive Tool when it is initiated. You can now close the ubuntu screen and the RDP File Sync support applet. Don't forget to Stop Syncing (below) when you have finished with your Tool. Navigate to Synced Area within an Interactive Tool When your Interactive Tool has started, synced files will be available in the following location (navigate to this location within your Interactive Tool to access them) :- \sharedhome\ username\cmissync\ foldername\user Homes\ username\alfresco folder Username is your user name. Foldername is the name of the local folder you have when setting up the sync (above). It is this location that will be used to sync input and output into the Interactive Tool. Stop CMIS Syncing and Stop Service When you have finished with your Interactive Tool it is important to stop syncing to prevent unnecessary processing of file synchronisation in the background. To stop syncing, connect to and login to the CMIS Sync service. Locate the CMIS Sync connection utility, ( which is made available in a folder in the Shared Files area -> CMIS Sync) :- Hover over the CMIS Sync Connection.jar file and select Download. The following pop-ups will appear:-

8 Click OK to the Unable to open web browser message. DO NOT CLOSE the RDP File Sync support applet until you are finished with CMIS Sync. If you do close the connection your session with the CMIS Sync service will be terminated. In Windows, open Remote Desktop Connection (Start->All Programs->Accessories->Remote Desktop Connection) In Computer: key in the localhost string shown in the RDP File Sync support applet (do not include the preceding rdp:// or the trailing /) The login screen appears:- Key in your ERW username and password and click OK. You are now presented with the ubuntu welcome screen:-

9 Click the red circle icon which should appear in the top right of the screen. Select the synced folder, e.g. it is MyFiles in the above example, and select Remove the folder from synchronization from the fly-out menu. Select Yes, stop synchronizing permanently. Then, to stop the service, open Tools->Xterm:- a command console, click Applications (in the top right) and select System

10 Key in the command cmissync stop. The CMIS Sync service is now stopped. You can now close the ubuntu screen and the RDP File Sync support applet.

11 Set-up a Tool to Use CMIS Sync The CMIS Sync service allows the user to navigate to a synced area of the ERW repository while they are using an Interactive Tool. This enables the tool to read the content (files) within the synced area, and provides a location to which output can be written back to the ERW straight away. To enable the user to access a CMIS Synced area of the ERW during tool use, the following lines must be made in the O/S Guest Customisation element of the Tool definition as shown below:- mkdir -p /sharedhome echo " :/home /sharedhome nfs rw,hard,intr 0 0" >> /etc/fstab mount /sharedhome these lines should be entered before the mkdir -p /home/$$username/.ssh line.