c2 sparkplugin users guide v1.1

Upload: dung-ha

Post on 03-Jun-2018

216 views

Category:

Documents


0 download

TRANSCRIPT

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    1/7

    Digital Rapids C2 Spark Plugin 1.1 Page 1

    Transferring Files Using the C2 Spark Plugin

    This guide is for a user who wants to transfer files using a Spark client with the C2 plugin installed.

    Before transferring a file

    Other DRC C2 components that must already be installed and configured:

    By the C2 Administrator: DRC License Server, C2 Server, Openfire IM Server

    By the C2 Engine Manager: C2 Engine on the same LAN as the Spark client

    You must have a valid Spark IM username and password setup on the Openfire IM Server.You must know the IM username of your local C2 Engine.You must know the IM username of the Spark Client (or Clients) you want to transfer files to or from.

    C2 Spark Plugin Installation Notes

    Install Spark version 2.5.8. Before you login, copy the C2 Spark plugin (C2-plugin.jar) into theC:\Program Files\Spark\plugins directory.

    If you are upgrading from a previous version of the C2 Spark plugin, then launch the Spark applicationand then from the main Spark menu choose Spark > Plugins. Select the C2 Plugin and click the red X todelete the plugin, then Close to return to the main interface. From the main Spark menu choose Spark >Exit. Then copy the new C2 Spark plugin (C2-plugin.jar) into the C:\Program Files\Spark\pluginsdirectory.

    Launch the Spark application and log in. Enter the Username and Password provided by theadministrator of the Openfire IM Server. (Note: For C2 you cannot use any upper case letters for Sparkusernames.) Enter the Server host name, where the host name is the IP address or DNS name of theOpenfire IM Server.

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    2/7

    Digital Rapids C2 Spark Plugin 1.1 Page 2

    If this is the first time you are using the C2 Spark Plugin, when you launch Spark the C2 Preferenceswindow will open. If not, the from the main menu select Spark > Preferencesand scroll down to C2.

    On the Preferences dialog enter the name of the Outgoing Engine ID(the IM username of the localEngine) and Receive Engine ID. These will normally be the same, so the Receive Engine same asOutgoing Engine checkbox can normally be enabled.

    When a file is sent to a C2 Spark client the user shipping the file will see the Defaultdirectory as anoption. When Default is selected by the sender as the destination, then incoming files are delivered tothe local C2 Engines Inbox. If the Engines Inbox is accessible on the LAN from the sys tem that isrunning the Spark Client, then the file will remain in the Engines Inbox. If the Engines Inbox is notaccessible, then the file will be moved to the default Spark inbox directory (by default C:\ProgramFiles\Spark\inbox).

    If you would like your files to be delivered to a specific directory you can set up a Destination Directory

    in your C2 Preferences. Pick a directory using the browse button to the right of the panel. The usershipping the file will see the destination directories you set up as well as the Default option.

    If you would like other Spark Clients to be able to browse some of your directories remotely, so that theycan initiate a file transfer from your system to their system, then you can specify one or more RemotelyAccessible Directories. Click the browse button to the right of the selection panel. Navigate to thedirectory you would like to use and click the Select button. The directory you selected will be added to thelist of Remotely Accessible Directories. You can also restrict which users can access each one of those

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    3/7

    Digital Rapids C2 Spark Plugin 1.1 Page 3

    directories by selecting them from the list on the right. If no users are selected, then all users will be ableto access the directory.

    When you click the Closebutton at the bottom of the window your changes are saved and the dialog isclosed. If you want to exit without saving any changes click the X button in the upper right hand cornerof the dialog.

    Ship a File

    On the main Spark interface you will see your list of contacts. You can ship a file to any of those clients.

    Note that you can ship a file to a client even if they are currently offline. In that case the file will beshipped to the inbox of the Engine Manager that is used by the receiving client, and the status will changeto transferred. When the Spark client logs in the final file delivery step from the Engine Manager to theSpark client will occur.

    To send a file to a contact right click on their name and select Ship File.

    A window will open to allow you to pick the file (or fi les) you want to ship.

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    4/7

    Digital Rapids C2 Spark Plugin 1.1 Page 4

    Note the options to the right of the file selection area.

    Scheduleallows you to start transferring the file immediately, or to pick a date and time to begintransferring the file.

    Priorityis used to allocate the percent of the bandwidth that will be used to send this file (if other files arebeing sent at the same time). There are three options: Low, Normal, High

    Zip Multiple Files:If you are sending multiple files and enable the Zip multiple files option, then they will

    be zipped into one file before being sent as a zip file. Note that if you are only sending one file, it will notbe zipped, even when this option is enabled.

    Delete source file upon deliverywaits until the file status changes to Delivered (that is, after thereceiving C2 Engine Manager has confirmed delivery) and then deletes the source file on the transmittingside.

    The Remote Destination Directoryspecifies what the final delivery destination folder will be for thedelivered file. If you choose Default, the file will be delivered either to the receiving C2 Engines Inbox (ifthe Spark Client has access to that Inbox) or to the Spark inbox (by default in C:\ProgramFiles\Spark\inbox). If the user receiving a file added a Destination Directory in their C2 preferences thenthe sender will be able to specify that destination. Note that if you pick a specific Remote DestinationDirectory (not default)it will be used, even if the Spark client has access to their local C2 Engines Inbox.

    When you click the Shipbutton the file will be queued for transmission by the local C2 Engine Manager.

    Download a File

    If any of your contacts have set up Remotely Accessible Directories for you in their preferences, then youwill be able to browse those remote directories and start a file transfer from the remote directory to you.

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    5/7

    Digital Rapids C2 Spark Plugin 1.1 Page 5

    On the main Spark interface you will see your list of contacts. To pull a file from a contact right click ontheir name and select Browse Remote Files. The Browse Remote Files window will open, andanyfiles in the remote directory will be shown.

    Pick the file (or files) you want to receive, and click the Download button.

    Note that the Browse Remote Filesoption will only be available if the corresponding C2 Client is online.

    Track Shipments

    From the main Spark menu select Actions > Track Packages. You will see a list of files that you aresending and that are being sent to you. (You will not see any other files that are being handled by yourlocal C2 Engine Manager for other clients, you will just see your files.)

    You can sort by any column by clicking on that column heading.

    Choose which columns to show or hide in this window by right clicking on a column heading, selectingColumns, then checking the names of the columns you want to show.

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    6/7

    Digital Rapids C2 Spark Plugin 1.1 Page 6

    To create a log file of the Incoming Packages or Outgoing Packages data, right click on a column headingand select Export.

    You can export the data as a CSV file. Choose whether you want to export the data to the systemclipboard or to a file. Click the Export button to create the file. Note that only the columns that wereshowing at the time of the Export will be saved in the file.

  • 8/12/2019 C2 SparkPlugin Users Guide v1.1

    7/7

    Digital Rapids C2 Spark Plugin 1.1 Page 7

    Receive a File

    After you have received an incoming file, a window will open to notify you and to show you where the fileis currently located.

    In this example the file was delivered to the local C2 Engine Managers Inbox (in this case, D:\C2 Inbox),to a subfolder with the username of the client receiving the file (in this case, c2demo_client). If you clickthe Open Directory button then Windows Explorer will open to the subfolder that contains your file. If you

    click the Open File button your file will be opened using the appropriate program.

    In the File Packages window you can right click on a file you received and select the Open DeliveryDirectory option to open to the subfolder that your file was delivered tooriginally.

    If you select the Show Details option than information about that particular files delivery will be show.

    The effective data rate used to deliver your file will be dependent on the following things:

    The speed of the connection between the sending C2 Engine and the receiving C2 Engine

    The maximum bandwidth limit set in the two C2 Engine Managers

    The bandwidth being used by other files that are being sent or received simultaneously by the C2Engines, and the priorities of those transfers

    Any network congestion that causes packet loss

    If the final destination is not the inbox of the C2 Engine, then the speed of the file transferbetween the C2 Engine and the destination folder of the Spark Client