2016. All rights reserved. ecconnect V.11 User Guide

Size: px

Start display at page:

Tracy Goodman
5 years ago
Views:

2 Copyright and trademarks ecconnect User Guide Copyright and trademarks The information in this document is subject to change without notice. This document is intended for the use of InterTrade s clients. No part of this document may be reproduced or transmitted in any form or means without the prior written consent of InterTrade Systems Inc. InterTrade will not be responsible for any errors in this document or for any damages, incidental or consequential (including monetary loss), that might arise from the use of this document or the information in it. All intellectual property rights pertaining to this document and the product shall remain the exclusive property of InterTrade. This document and the product it describes are considered protected by copyright according to applicable laws. Copyright InterTrade All rights reserved. Summary of document changes Document version Description Created by Date 1.0 First version C. Lapointe, InterTrade ii November 8 th, 2016 InterTrade

3 ecconnect User Guide Table of contents Table of contents Copyright and trademarks... ii Summary of document changes... ii Table of contents... 3 Introduction... 5 About ecconnect... 5 ecconnect 11 features... 5 ecconnect components... 5 Administrative tools... 6 Installation... 7 Introduction... 7 Considerations... 7 System requirements... 7 Installing ecconnect... 7 Downloading the installer... 8 How to run the installer... 9 Setting up ecconnect Configuring your business divisions Activating your business divisions Deactivate a business division Delete a business division Setting up user preferences Testing ecconnect Testing the reception of a document Testing sending of a document Troubleshooting ecconnect InterTrade November 8 th,

4 Table of contents ecconnect User Guide Configuring the application settings Using ecconnect Loging in Sending documents Receiving documents Downloading a document Loging out Verifying the ecconnect version Authorize automatic updates Manage the application version Suspending ecconnect Stopping ecconnect Restarting the ecconnect application Uninstalling ecconnect November 8 th, 2016 InterTrade

5 ecconnect User Guide Introduction Introduction About ecconnect ecconnect is a secure communications tool that our clients use for the transfer of electronic documents with InterTrade. ecconnect automatically sends and receives all types of electronic documents from clients internal systems through the InterTrade VAN platform. ecconnect 11 features ecconnect features the following characteristics: Automatically sends/receives electronic documents. Automatically archives sent/received documents, with a configurable purge period. Provides configurable send/retrieve intervals. Has a user-friendly web console and administration tool. Allows users to manage multiple mailboxes directly from the web console. Allows users to consult documents directly via the web console. Operates on a secure, encrypted and reliable communication channel with InterTrade. In the rare case of a system failure, ecconnect automatically restarts and attempts to send and retrieve documents available on the InterTrade VAN platform. ecconnect components ecconnect is comprised of four basic components: mailboxes, a push service, a pull service and a purge service. Mailboxes ecconnect mailboxes serve as the primary storage and release point for all incoming and outgoing documents. Each mailbox has four folders: In, Out, Archive and Transit. The location of mailboxes must be carefully considered during the planning stage of the ecconnect implementation, because ecconnect and your internal system will require read/write access to the In and Out folders. Note that the Archive and Transit folders are for ecconnect usage only. However, all four folders in a mailbox must reside on the same physical drive and under the same subfolder. Folder descriptions In folder: This is where files sent from your trading partners (and that were pulled by ecconnect from InterTrade) are located. ecconnect does not interact with documents once they are in the In folder. Once received in the In folder, a copy will also be archived in the Archive folder. Out folder: This is where documents waiting to be sent to external recipients are located. These files are sent via ecconnect to the InterTrade VAN platform and on to the recipient. Once received in the Out folder, a copy will also be archived in the Archive folder. Archive folder: The Archive folder contains copies of every document sent and received by ecconnect through the InterTrade VAN platform. InterTrade November 8 th,

6 Introduction ecconnect User Guide Transit folder: This is a temporary location for documents that are being transferred. A document in the Transit folder will remain there only until the system confirms that the transfer of the document to the InterTrade VAN platform has been successful. Push service The push service moves documents from the Out folder to InterTrade VAN platform and then on to your trading partners. The frequency with which the push service is triggered can be configured to match your specific business requirements. The frequency settings for the push service are located in the Preferences / Application Settings submenu. Pull service The pull service brings documents from your trading partners into the In folder from the InterTrade VAN platform. The frequency for pulling documents can be set in the Preferences / Application Settings submenu. Purge service The purge service deletes all files located in the Archive folder that have exceeded their retention period. The purge service applies only to the Archive folder. The retention period for documents in the Archive folder can be set anywhere from 7 to 90 days. Administrative tools The ecconnect administrative tools make it easy to monitor and configure all the components of ecconnect. Statistics about pushed and pulled files are instantly available on the Dashboard. A diagnostics page also provides a detailed look at the settings that affect the ecconnect application. 6 November 8 th, 2016 InterTrade

7 ecconnect User Guide Installation Installation Introduction ecconnect may be installed on any computer that meets the requirements detailed below, whether the application will be operated onsite or from a remote location. Considerations When choosing the location of your ecconnect installation, it is important to keep the following details in mind: ecconnect should be installed on a server-grade computer that is available 24/7. The server on which ecconnect is installed must be visible from the internet (HTTPS protocol). The server on which ecconnect is installed must be visible from the internal system that produces/receives electronic documents exchanged with trading partners. The server on which ecconnect is installed should be protected by firewall. ecconnect does not require a dedicated server because it adds very little load. Only install ecconnect once per computer. System requirements The following table lists the system requirements for installing ecconnect: Operating System Microsoft Windows 7 (32 and 64 bits), Windows 10, Windows Server 2012 and up, Linux (32 and 64 bits), and Solaris. Browser Available disk space Memory IE 9+, Edge, Firefox and Chrome. 1 GB 2 GB RAM (minimum) Installing ecconnect This section explains how to complete a full installation of ecconnect. Before proceeding, make sure you have the following information ready: Decide on which machine the ecconnect Administration Tool will be installed, keeping in mind any network or firewall access issues. Have the ecconnect Administration Tool username and password ready. Choose the location where you want to install ecconnect (either locally or on a network drive). Remember that all the folders of a mailbox have to be on the same drive, but the mailbox does not have to be on the same drive as the ecconnect application. Mailboxes can be kept on different drives, as long as the respective folders of each mailbox are on the same drive. InterTrade November 8 th,

8 Installing ecconnect ecconnect User Guide Example: 1 st example : a company with one division 2 nd example : a company with three divisions ecconnect application installed on C drive ABC business division (one division) Mailbox installed on drive F Folders In, Out, Archive and Transit on drive F ecconnect application installed on C drive Business division DEF (1st division) DEF ecconnect application installed on C drive DEF mailbox installed on drive F DEF folders In, Out, Archive and Transit on drive F Business division GHI (2 nd division) GHI mailbox installed on drive I GHI folders In, Out, Archive and Transit on drive I Business division KLM (3rd division) KLM mailbox installed on drive M KLM folders In, Out, Archive and Transit on drive M In order to install ecconnect, you must download the installer from InterTrade and run it on the target machine. Downloading the installer 1. Using a Web browser, go to the following URL: 2. Click the appropriate link for your specific OS. 3. You will be prompted to save the file to your local machine. Click Yes to begin the download of the installer file from InterTrade. (The file size is approximately 100 MB.) 8 November 8 th, 2016 InterTrade

The Installer Language window is displayed. 2.

9 ecconnect User Guide How to run the installer How to run the installer 1. Right-click the installer, and select Run as administrator. The Installer Language window is displayed. 2. Select the installation language (English in this case), and click OK. 3. Click Next. InterTrade November 8 th,

If required, click Browse to select a folder on your computer. 5.

10 How to run the installer ecconnect User Guide 4. Choose the Destination Folder for your installation and click Next. If required, click Browse to select a folder on your computer. 5. Choose the name that will be displayed on the Start menu, and click Install. 10 November 8 th, 2016 InterTrade

11 ecconnect User Guide How to run the installer The next screen will show the details of the installation. Once the installation is complete, click Next. InterTrade November 8 th,

12 How to run the installer ecconnect User Guide 6. Click Finish to exit the installer. 12 November 8 th, 2016 InterTrade

13 ecconnect User Guide Setting up ecconnect Setting up ecconnect In order to function properly, ecconnect needs to be configured with your own unique configuration credentials. To log into your ecconnect web console: 1. Using a Web browser, go to the default URL: where [hostname] is the hostname of the server on which ecconnect was installed, followed by port number You will be asked to enter a User ID and password. 3. Enter the default credentials (You will be able to change the default credentials later.) username: admin password: password and click. The Administration tool s Dashboard will display. 4. Verify InterTrade VAN availability status. If InterTrade VAN availability is, everything is working normally. If InterTrade VAN availability is, it means that the communication with InterTrade is not established. In this case, go to the Help Diagnostics submenu to see the self-diagnostic page. From the self-diagnostic page, if you can, attempt to fix the failed diagnostic test. Then return to the Dashboard to verify InterTrade VAN availability. You want it to be ; if it is still, contact InterTrade technical support. Configuring your business divisions Divisions are used to differentiate the different business units in a company with regard to how the divisions communicate with InterTrade. ecconnect s representation of divisions, under the same company, must be the InterTrade November 8 th,

14 Setting up ecconnect ecconnect User Guide same as how they are set up on InterTrade s VAN system. ecconnect will have separate physical mailboxes for each division to ensure that files are not mixed up. Before setting up a division in ecconnect, it must be created on the InterTrade VAN system by an InterTrade support representative. Only then can InterTrade provide you with the credentials necessary to set up the related division in ecconnect. In order to create the division in ecconnect, you will have to tell ecconnect where the division s mailbox (In, Out, Archive and Transit folders) will be physically located and give the division s credentials as provided by InterTrade. Mailbox locations should be full paths to the directories where your folders will be kept, and can be in any location that is consistently visible to ecconnect. Paths may be entered using Windows, Unix and UNC formats, such as: C:\path\..., c:/path/.., /path/, \\hots\share\... To create your divisions: 1. From the Divisions screen, click. The Create Division form will open. 2. Fill out the required information. a. Name: enter the name of the business division. b. Username: enter the username that InterTrade has provided you. c. Password: enter the password that InterTrade has provided you. d. Division directory: enter the root path where you want the division s mailbox to be created. 3. Click. The division is now created. Repeat this process to add more divisions. Activating your business divisions Once your business divisions have been created, they need to be activated. To proceed, use one of the following options: Option 1 1. Select the Divisions menu option. The Divisions screen will display. 2. In the Status column, click the Inactive status next to the business division that you want to activate. An Action menu will display. 3. Click Activate. 14 November 8 th, 2016 InterTrade

ecconnect User Guide Setting up ecconnect The status of the division is now Active. Option 2 1. Select the Divisions menu option. The Divisions screen will display. 2. From the Divisions screen, choose Actions > Activate for the business division to activate.

15 ecconnect User Guide Setting up ecconnect The status of the division is now Active. Option 2 1. Select the Divisions menu option. The Divisions screen will display. 2. From the Divisions screen, choose Actions > Activate for the business division to activate. A prompt will ask you to confirm your request. 3. Click Ok. The division is now Active. Deactivate a business division To deactivate a division: 1. Select the Divisions menu option. The Divisions screen will display. 2. From the list of divisions, click Actions Deactivate next to the division to deactivate. The Division deactivation window will display. 3. Click Ok. The division is now deactivated. InterTrade November 8 th,

Setting up ecconnect ecconnect User Guide Delete a business division To delete a business division: 1. Select the Divisions menu option. The Divisions screen will display. 2.

16 Setting up ecconnect ecconnect User Guide Delete a business division To delete a business division: 1. Select the Divisions menu option. The Divisions screen will display. 2. From the list of divisions, choose Actions Delete for the division to delete. The Division deletion window will display. 3. Click Ok. The division is now deleted. Setting up user preferences To change the default password: 1. Click. The menu options are displayed. 2. Choose User Settings. The User Settings form will open. 3. Enter the default password (password). 4. Enter your new password. 5. Confirm the new password. 16 November 8 th, 2016 InterTrade

17 ecconnect User Guide Setting up ecconnect 6. Click. The new password is now saved. Testing ecconnect To confirm that ecconnect is transferring inbound documents correctly, a support agent will place a sample document on the InterTrade VAN system for you. To test the outbound communication, you will need to place a sample document in your Out folder. Testing the reception of a document To test the reception of a document: 1. An InterTrade support agent will place a sample document on the InterTrade VAN platform. 2. From the Dashboard, click. The following message will display: Progress. and the status will change to In 3. Go to the Documents menu. The list of documents will be displayed. If you have any documents, they will be displayed in the Documents section. The status column will display Received to confirm that the document was successfully received. Testing sending of a document To test that the documents are sent: 1. Place a document in the Out folder of your ecconnect mailbox. 2. If you want to send it now, click. If not, you can wait for the next configured automatic document pick-up as documented in the Configuring the application settings section. After you click, the following message will display: and the status will change to In Progress. InterTrade November 8 th,

18 Setting up ecconnect ecconnect User Guide 3. Go to the Dashboard to confirm that you document has been sent out by the automatic document pickup. Alternatively, you can go to the Documents menu to see the status of sent documents. The information will confirm that the document has been successfully sent. Troubleshooting ecconnect ecconnect has the ability to test itself and report on these tests to help you pinpoint any communication issues that may arise. The tests are grouped into six categories: Basic Configuration Business Setup Network Connectivity Security Properties System Directories Most importantly, self-test reports indicate whether the test passed or failed. Look for failed tests to help identify any issues. To access the self-diagnostic section of the Administration tool, choose Help > Diagnostics. Configuring the application settings To modify the time interval at which ecconnect pushes and pulls your files or to set the retention period for your files to remain in the Archive folder, you can configure the application settings. 1. From the Preferences menu, choose the Application Settings option. The Application Settings form will open. 2. Enter the web service web URL: 3. If you wish to modify the pull delay, select one of the available options in the pull-down menu. The default setting is two minutes. 4. If you wish to modify the push delay, select one of the available options in the pull-down menu. The default setting is two minutes. 5. If you wish to modify the retention period, select one of the available options in the pull-down menu. The default setting is seven days. 6. The default language setting is English. To modify to French, select it from the pull-down menu. 7. Click Save. Your application settings are now saved. 18 November 8 th, 2016 InterTrade

19 ecconnect User Guide Using ecconnect Using ecconnect Loging in To log in: 1. Using a Web browser, go to your default ecconnect URL. 2. Enter your ecconnect username and password, and click Login. The ecconnect Dashboard will be displayed. Sending documents To send documents: 1. Place the documents in the Out folder of your ecconnect mailbox. InterTrade November 8 th,

The following message will display: and the status will change to In Progress. 3. Go to the Dashboard to confirm that your documents have been sent out by the automatic document pick-up.

20 Using ecconnect ecconnect User Guide 2. If you want to send them now, click. If not, you can wait for the next configured automatic document pick-up as documented in the Configuring the application settings section. The following message will display: and the status will change to In Progress. 3. Go to the Dashboard to confirm that your documents have been sent out by the automatic document pick-up. Alternatively, you can go to the Documents menu to see the status of sent documents. Receiving documents To receive documents: 1. From the Dashboard, and click. The following message will display: Progress. and the status will change to In 2. Go to the Documents menu. The list of documents will be displayed. If you have any documents, they will be displayed in the Documents section. Downloading a document To download a document: 1. Go to the Documents menu. The Documents screen will be displayed. 2. Click the icon in the row that corresponds to the document that you want to download. The Actions menu will display. 20 November 8 th, 2016 InterTrade

21 ecconnect User Guide Using ecconnect 3. Choose Download. The document will download to your computer. Loging out To log out of ecconnect: Click, then You are now logged out. Verifying the ecconnect version To verify the ecconnect version: Click The version information will display. Authorize automatic updates To authorize automatic updates: 1. From the Preferences menu, choose the Update Settings option. The Update Settings window will display. 2. Select Allow updates. 3. Click. Automatic updates are now activated. InterTrade November 8 th,

22 Using ecconnect ecconnect User Guide Manage the application version To choose the application version: 1. From the Preferences menu, choose the Application Settings option. The Update Settings window will display. 2. Clear the Allow updates checkbox. 3. Select the application version that you want from the drop-down menu. 4. Click. The application version is now locked at the selected version. IMPORTANT: No updates to ecconnect will be allowed unless you select the Allow updates check box again. Suspending ecconnect Clicking the Suspend button will temporarily halt ecconnect file movement while the ecconnect web interface is active. Once you have clicked this button, simply click the Resume button to reactivate ecconnect. This function can be used diagnostically to test ecconnect. To suspend ecconnect: 1. From the status section of the Dashboard, click. The following message will display: 2. Click OK. ecconnect is now suspended. 22 November 8 th, 2016 InterTrade

ecconnect User Guide Using ecconnect Stopping ecconnect Clicking the Stop button will permanently stop the ecconnect service and shut down the web interface.

23 ecconnect User Guide Using ecconnect Stopping ecconnect Clicking the Stop button will permanently stop the ecconnect service and shut down the web interface. To reboot ecconnect once you have stopped it using this method, you must restart the service from the Windows Services Control Panel, or from the command line in Linux. To stop ecconnect: 1. From the status section of the Dashboard, click. The following message will display: 2. Click OK. ecconnect is now stopped. Restarting the ecconnect application From the Control Panel of your computer, choose Administrative Tools Services. Select the InterTrade ecconnect application and choose Action Start. ecconnect will restart. Uninstalling ecconnect To uninstall ecconnect from your computer, follow these steps: First, deactivate all divisions. Second, delete all divisions. Third, stop the application from running. The fourth and final step is to uninstall the application. To uninstall ecconnect: 1. From the Windows Control Panel Programs and functionalities, select InterTrade ecconnect, and click Uninstall. The Uninstall assistant will appear. InterTrade November 8 th,

24 Using ecconnect ecconnect User Guide 2. Click Next. 3. Click Next. The Uninstall InterTrade ecconnect window will display. 24 November 8 th, 2016 InterTrade

25 ecconnect User Guide Using ecconnect 4. Click Uninstall. 5. Click Finish to close the Uninstall assistant. The ecconnect application is now uninstalled. InterTrade November 8 th,

Online Backup Manager v7 Office 365 Exchange Online Backup & Restore Guide for Windows

Online Backup Manager v7 Office 365 Exchange Online Backup & Restore Guide for Windows Copyright Notice The use and copying of this product is subject to a license agreement. Any other use is prohibited.