File Synchronization Service User Manual Delogue 2012-2018
TABLE OF CONTENTS Table Of Contents... 1 1. General Information... 2 1.1. System Overview... 2 2. System Summary... 2 2.1. System Configuration... 2 2.2. User Level Access... 3 3. Getting Started... 3 3.1. Installation And Logging In... 3 4. Changing Existing Synchronization Path... 4 5. Exit The System... 4 6. Special Instructions For Error Correction... 4 7. Scheduled Synchronization... 4 8. Error Logs... 5 9. Using Folder From Network Drive As Root Folder... 5 Page 1 of 4
1 GENERAL INFORMATION Delogue File Synchronization service is designed to continuous integration between Amazon s3 and User's File System. So any changes made by the user in their local directory will be updated on Amazon s3 directly. 1.1 SYSTEM OVERVIEW Delogue File Synchronization service is designed to direct integration between Amazon s3 and User's file system. Delogue user can download and install the setup. Once setup is installed, any changes in synchronization folder (selected by user at the time of installation) will update Amazon S3 storage. When user will try to link files, then all the uploaded file will display to user where user can select any file to link. 2 SYSTEM SUMMARY Designer users can save files on a local shared drive and then be able to select the files in Delogue and add it to a style. User then can overwrite the file on the shared drive and the file should be updated in Delogue. To make this possible, synchronization service is created. The summary outlines the uses of the system s hardware and software requirements, system s configuration, user access levels and system s behavior in case of any contingencies. 2.1 SYSTEM CONFIGURATION Delogue Synchronization service operates on windows operating system having.net Framework 4.5 is installed. It is compatible with Windows OS having.net framework 4.5 or above. The application requires connection to Internet in order to update file to Amazon S3. Updated files on Amazon S3 can be seen using popup displayed on click of Link Files button in Delogue Style Files tab or style header. After installation of the Delogue Synchronization Service, Delogue Synchronization Service can be used immediately without any further configuration if there are not more than 50 files in synchronized folder. Otherwise, user need to wait for 2 hours for first time synchronization up. It is highly recommend that system should have better hardware configuration and internet connectivity. Following are the points for hardware configuration which can be consider for better performance. 1) C drive must have more than 5 GB of free space 2) RAM should be at least 4 GB 3) Windows 7 and above are recommended with a 64 bit operating system Page 2 of 4
2.2 USER LEVEL ACCESS All the designer user can use the system having File server upload Module access. However to install the setup, user required administrator rights or user have to provide administrator credential. To use it in a distributed environment, Synchronized folder (Selected at the time of installation) need to be shared with all the users who can update synchronization folder. 2.3 CONTINGENCIES In case there is no Internet connection available data cannot be synchronized in Amazon S3. 3 GETTING STARTED 3.1 INSTALLATION AND LOGGING IN The designer user with access to the File server upload module needs to logging in the application and follow the instructions below: 1) Click on the Admin Tab General Settings File Synchronization 2) Click on the link Download Synchronization Setup 3) Open downloaded folder, a zip file, and extract zip. 4) Once extracted, there will be two files at the extracted location: DelogueFileSyncServiceSetup.exe and FileSyncServiceData.txt 5) Click on Setup file DelogueFileSyncServiceSetup.exe 6) Provide administrator credential if user don't own admin rights. 7) During the installation, please provide configuration file FileSyncServiceData.txt from extracted folder. 8) Select the folder name which needs to be synchronized with Amazon S3. 9) Installation completed. 10) Check if service is correctly installed and if it starts automatically. NOTE: Type Services.msc in the search bar. When installed services are displayed, look for Deloguesyncservice. 11) Start the service manually if it has not started automatically. Page 3 of 4
12) In case of further difficulties starting the service, please follow installation path (C:\Program Files\Delogue\FileSynchronizationService), and open ErrorLog.Txt to check for errors, if this file is created. 4 UPDATING THE FILE SYNCH SERVICE In case of an update to the File Sync Service, follow the steps below: 1) Uninstall the current system. It can be done by running the Wizard again and choosing the Uninstall option. 2) Once the system is uninstalled, a restart of the machine running the service will be needed. 3) The user can then download the new version and run the Wizard. Please follow the instructions as mentioned above in 3.1 Installation and Logging in. 4) It is very important that the synchronized folder name remains the same - as it had before you uninstalled the service. Otherwise, the service will not function as expected. 5 EXIT THE SYSTEM To exit Delogue File Synchronization Service, the user can uninstall the service or stop the service manually. 6 SPECIAL INSTRUCTIONS FOR ERROR CORRECTION Please follow the instructions below in case of special difficulties or error messages: 1) Remember to always close the file after editing, otherwise the file might not be updated in Amazon s3. 2) Avoid creating more than 50 files or folders up to 4GB capacity at the same time. The service can crash if network bandwidth or processor are too slow. 3) If files are not being uploaded, try to upload it again after 10-15 mins. NOTE: User can check Log or see while linking file, if file is not present. 4) When logging in for the first time, it is highly recommended to wait 2 hours after the installation in order to have the service up and running. 5) If there are any issues regarding Synchronization, search for service.msc to check if DelogueFileSyncService is running or not. An open service window will appear, where it will be possible to verify that information. If the service is not running, right click to start service. This action requires Administrator rights. 6) Please do not select Repair option from Installation Wizard. 7) Try to avoid too many operations (Copy, Paste, Edit and Delete) on the same File/Folder, without breaks. This might generate errors like Access Denied. Page 4 of 4
7 SCHEDULED SYNCHRONIZATION Service will run scheduled synchronization on every minute to synchronize all content. Any changes made when scheduled synchronization is running will be synchronized on next schedule synchronization. One minute timer for scheduled synchronization will start after service complete syncing all current changes made. 8 ERROR LOGS Users can see error logs in the folder named Logs which exists in the installed folder. Logs files are created per date. 9 USING FOLDER FROM NETWORK DRIVE AS ROOT FOLDER If users need to set a root folder from network drive, the service credentials to access the drive will need to be installed. To do so, the next steps are required: To see the installed services click on Start Type services.msc Find the service with name DelogueFileSyncService (see image 1) Right click on the Service and choose the option Properties In the pop-up window, click the Log on tab Select the option This account and enter the user credentials Username and Password (see image 2) Click Ok and restart the service Image 2 Properties window to insert user credentials Image 1 Service search results Page 5 of 4
Page 6 of 4