Signiant Support

12.0 Media Exchange Desktop Client User's Guide Print


Contents


Overview

Signiant Media Exchange Desktop Client extends Media Exchange by providing a very simple application that automates the delivery of content to and from your provider. Depending on the function of the channel you may be able to download content from, and/or upload content to, your provider. It's simple to setup, easy to use, and can operate in a lights-out fashion.

Downloads

When you subscribe to a channel for downloading, packages are automatically transferred to your computer as they are received in your Inbox or channel. The files are stored on your computer in the designated download folder.

Uploads

When you subscribe to a channel for uploading, you can create and automatically upload packages just by copying files into the designated upload folder on your computer. When the package is sent, the files are removed from the upload folder.

When multiple files are dropped into the upload folder, each file is sent as a separate package. When a folder containing files is dropped into the upload folder, the entire set of files in the folder is sent as a single package. Shortcuts and aliases are not supported. The actual files must be dropped into the upload folder.

Installing and Updating

Installing

To install Media Exchange, do the following:

  1. Login to Media Exchange, right-click your Inbox or a Channel and then click the Subscribe menu item.
    Note: If you're using the Signiant Transfer API, you cannot right-click a Channel or your Inbox and choose Subscribe, you must setup automatic transfers and subscriptions with the Desktop Client. Read Subscribing to a Channel from the Desktop Client for details on how to do this.

     

  2. If the Media Exchange Desktop Client is not installed on your computer, you will be redirected to the Registration page to download and install it.

    Review and accept the terms of the license agreement, then click the Download button.

     

  3. A step-by-step instruction page will be displayed to help guide you through the installation. A Windows or Mac installation will run depending on your operating system.

     

  4. Once the installation is complete, the Media Exchange Desktop Client will launch automatically.
    Note: After launching, you may have to acknowledge a warning associated with running Java.
  5. Click Close on the instructions page.

Updating

The Media Exchange Desktop Client automatically downloads product updates when they become available, and if the client is running you are alerted when an update is ready to be installed. The Desktop Client is restarted during the update, and any currently running transfers automatically resume. It is not necessary to stop your running transfers, or to schedule the update when no transfers are running. If you manually restart the Desktop Client after a product update has been downloaded, the update is applied automatically.

Subscribing to Channels

In order to use the Media Exchange Desktop Client, you must subscribe to at least one channel from your provider. You can subscribe to a maximum of 100 channels. You can have subscriptions to multiple providers, and multiple subscriptions to the same provider, but only one user can be subscribed to any one provider at a time. You can have subscriptions to receive content from a channel, contribute content to a channel, or both.

Subscribing to a Channel from Media Exchange

If you are a Signiant Media Exchange user and already have access to channels using the web client, you can easily subscribe to them for use in the Desktop Client. You can do this directly from Media Exchange.

To subscribe to a channel from Media Exchange, do the following:

  1. Login to Media Exchange, right-click your Inbox or a channel, then select the Subscribe menu item.
    Note: If you're using the Signiant Transfer API, you cannot right-click a Channel or your Inbox and choose Subscribe, you must setup automatic transfers and subscriptions with the Desktop Client. Read Subscribing to a Channel from the Desktop Client below for details on how to do this.

     

  2. The Add Channel dialog will open. Enter your Media Exchange account password.

     

  3. To subscribe to all subchannels in the channel, enable Include all subchannels. A message displays alerting you that subscribing to all content in a channel and its subchannels can take some time - you have the option to download all existing packages or not.
  4. To download content, select Enable downloading of content from this channel. When this option is selected, two additional options are displayed:
    • Create unique download folders for each transfer: this creates a new folder for each transfer download. When this option is enabled, Keep older file versions is not displayed.
    • Keep older file versions: this adds a delivery ID to the file name of each file that is downloaded. This option allows you preserve older file versions.
  5. Specify your Download and Upload Folders.

    Depending on your permissions, you can receive and/or contribute to each subscribed channel. If you have permission to receive content from a channel, you must enable downloading then select a folder to download the content to. If you have permission to contribute to a channel, you must enable uploading then select a folder to upload the content from. Use the folder browser dialog to select the folder or type it directly into the field. The folder can be located on your computer or a network share.

    Note:
    • Download folders cannot be located within Upload folders. Upload Folders must be unique and cannot contain or be located within another Upload folder.
    • Windows users must specify shared network folders by their UNC path (eg. \\server\share\directory) and not by a mapped drive letter (eg. m:\directory).
    • To disable downloading or uploading, deselect the appropriate option.

    The designated upload folder is checked for new files every 30 seconds. The package will be created and uploaded once the Desktop Client determines that the files have finished copying into the upload folder and that none of the files are in use by another program or process. This is done by ensuring that no changes have been made to the file size or the last modified time of the files since the last check. Once 30 seconds have elapsed without any changes to the contents of the upload folder, the package is sent. If multiple files or folders are detected, they will be uploaded at 30 second intervals.

    Note: The recommended method for uploading large numbers of files is to place them in a folder, then drop the entire folder into your designated upload folder.
  6. Customize the display of your channel.

    The default channel and provider names are specified by your provider, but you can customize these by assigning nicknames to them. If you specify nicknames they will be displayed in the Channels list.

  7. Save the channel.

    Click OK to complete the subscription process. The channel is added as an entry in the Desktop Client's Channels list.

    Note: If this is the first time you are subscribing to your Inbox or a channel for downloads, you will be given the option to download all the existing packages.

Subscribing to a Channel from the Desktop Client

You can subscribe to channels directly from the Desktop Client. After you input the proper credentials to connect to your provider, you can browse the channels that you have access to, and add them to the Desktop Client. You can also use this method to subscribe to a channel that you don't have access to in Media Exchange. This situation can arise if you have permissions to publish to a channel but not to download from it.

To subscribe to a channel from the Desktop Client, do the following:

  1. Click Add on the Channels view toolbar to create your subscription.

    The Add Channel dialog opens.

     

  2. Select your Inbox or a channel.

    Select an existing Provider URL from the dropdown list, or enter different provider credentials, then open the Select Channel dialog. Select your Inbox or a specific channel.

    Your permissions to receive and/or contribute to each channel are set by your provider, and are indicated by corresponding arrow icons.
    Icon Description
    arrow_down.png You only have permission to receive content from this channel.
    arrow_up.png You only have permission to contribute content to this channel.
    arrow_downup.png You have permission to receive and contribute to this channel.
    lock.png You have no permission to receive or contribute to this channel.
    Click OK to return to the Add Channel dialog.
  3. To subscribe to all subchannels in the channel, enable Include all subchannels. A message displays alerting you that subscribing to all content in a channel and its subchannels can take some time.
  4. To download content, select Enable downloading of content from this channel. When this option is selected, two additional options are displayed:
    • Create unique download folders for each transfer: this creates a new folder for each transfer download. When this option is enabled, Keep older file versions is not displayed.
    • Keep older file versions: this adds a delivery ID to the file name of each file that is downloaded. This option allows you preserve older file versions.
  5. Specify your Download and Upload Folders.

    Depending on your permissions, you can receive and/or contribute to each subscribed channel. If you have permission to receive content from a channel, you must enable downloading then select a folder to download the content to. If you have permission to contribute to a channel, you must enable uploading then select a folder to upload the content from. Use the folder browser dialog to select the folder or type it directly into the field. The folder can be located on your computer or a network share.

    Note:
    • Download folders cannot be located within Upload folders. Upload Folders must be unique and cannot contain or be located within another Upload folder.
    • Windows users must specify shared network folders by their UNC path (eg. \\server\share\directory) and not by a mapped drive letter (eg. m:\directory).
    • To disable downloading or uploading, deselect the appropriate option.

    The designated upload folder is checked for new files every 30 seconds. The package will be created and uploaded once the Desktop Client determines that the files have finished copying into the upload folder and that none of the files are in use by another program or process. This is done by ensuring that no changes have been made to the file size or the last modified time of the files since the last check. Once 30 seconds have elapsed without any changes to the contents of the upload folder, the package is sent. If multiple files or folders are detected, they will be uploaded at 30 second intervals.

    Note: The recommended method for uploading large numbers of files is to place them in a folder, then drop the entire folder into your designated upload folder.
  6. Customize the display of your channel.

    The default channel and provider names are specified by your provider, but you can customize these by assigning a nickname to them. If you specify nicknames they will be displayed in the Channels list.

  7. Save the channel.

    Click OK to complete the subscription process. The channel is added as an entry in the Desktop Client's Channels list.

     

Managing Transfers

Select the Transfers view to display or manage your active and completed transfers. The following actions are available on the Transfer view toolbar:

Button Description
toolbar_start_enabled.png Start/Resume Transfer
toolbar_stop_enabled.png Stop Transfer
toolbar_remove_enabled.png Remove Transfer: The record of the transfer is removed from the Transfers list.
  • When removing transfers from the list, you have the option to delete downloaded files. You can also use the Delete or Backspace keys on your keyboard to delete transfers.
  • When removing active or queued transfers from the list, or those in a cancelled or failed state, the transfer will never be retried.
toolbar_folder_down_enabled.png Open Download Folder for transfer
  • Downloaded files are stored in this folder.

The status of your transfers is displayed in the Transfers table. The following states can be displayed:

State Description
transfer_download.png Download in Progress: The package is being downloaded to your computer.
transfer_upload.png Upload in Progress: The package is being uploaded from your computer.
transfer_delivery.png Delivery in Progress: The upload is complete, and the package is being delivered to the channel or your Inbox by Media Exchange.
  • Packages that are being delivered are not affected by the Maximum Number of Active Transfers setting.
  • Your computer can be safely shut down without affecting package deliveries.
transfer_complete.png Transfer Completed: The transfer completed successfully.
transfer_stopped.png Transfer Stopped: The transfer was manually stopped. You can manually resume stopped transfers by clicking the Start/Resume button on the toolbar.
transfer_retrying.png Transfer Retrying: The transfer is automatically trying to re-establish a connection to the provider. The Media Exchange Desktop Client will retry the transfer every minute for one hour before failing the transfer. Failed transfers can be manually resumed.
transfer_download_queued.png Download Queued: The package is in a queue of transfers waiting to be downloaded.
  • When the provider reaches its limit for concurrent downloads, the transfer will be queued. The transfer resumes once the queue is available.
  • When your Desktop Client reaches the Maximum Number of Active Transfers, specified in the Preferences dialog, the next package will be queued. If you want to increase the priority of a queued download, stop the other transfers that are currently in progress.
transfer_upload_queued.png Upload Queued: The package is in a queue of transfers waiting to be uploaded.
  • When the provider reaches its limit for concurrent uploads, the transfer will be queued.The transfer resumes once the queue is available.
  • When your Desktop Client reaches the Maximum Number of Active Transfers, specified in the Preferences dialog, the next package will be queued. If you want to increase the priority of a queued upload, stop the other transfers that are currently in progress.
transfer_incomplete.png Transfer Canceled: The transfer is incomplete. You can manually resume incomplete transfers by clicking the Start/Resume button on the toolbar.
transfer_error.png Transfer Error: The transfer did not complete because of an error. You can manually resume failed transfers by clicking the Start/Resume button on the toolbar.

Transfer View Guidelines

The recommended maximum number of transfers in the Transfers view is 3.

To remove a transfer, select one or more transfers and click the Remove Transfer button on the toolbar. You have the option to delete downloaded files when removing a transfer. To remove or delete a transfer you can also use the Delete or Backspace key on your keyboard. The Delete or Backspace keys do not delete files from disk.

Managing Channels

Select the Channels view to display or manage the properties of a channel, or to view the status of your channels.

The following actions are available on the Channel view toolbar:

Button Description
toolbar_add_enabled.png Add Channel
  • Only one user can be subscribed to any one provider at a time.
  • If you modify the Provider name or Password for one channel, the change will affect all channel subscriptions from the same provider.
  • A maximum of 20 channels can be added at a time.
toolbar_edit_enabled.png Edit Channel
  • Only one user can be subscribed to any one provider at a time.
  • If you modify the Provider name or Password for one channel, the change will affect all channel subscriptions from the same provider.
toolbar_remove_enabled.png Delete Channel: The channel is removed from the Channels list and the record of all transfers to or from this channel are removed from the Transfers list.
toolbar_folder_down_enabled.png Open Download Folder for channel
  • Downloaded files are stored in timestamped folders within this folder.
toolbar_folder_up_enabled.png Open Upload Folder for channel
  • Files and folders dropped into this folder will be automatically uploaded to the channel or Inbox.

The state of your subscribed channels and the quality of the last transfer (download or upload) are displayed in the Status column. The following states can be displayed:

Success State Description
3star.png 3 Star Service: Optimal Connection. Signiant Accelerated (UDP protocol)
2star.png 2 Star Service: Improved Connection. Signiant Regular (TCP protocol)
1star.png 1 Star Service: Normal Internet Connection (HTTP protocol)
Warning State Description
error_20.png Error: Errors occurred with your Media Exchange account credentials or provider certificate. Click on the underlined error message link to resolve the issue.

An error will also be displayed if your provider has deleted the channel.

warning_20.png Warning: Network problems are affecting the connection to your provider.

A connection loss warning can result if your provider is temporarily unavailable due to maintenance or a network outage. It can also result if a firewall is blocking your provider, or if you are using a proxy server that is unavailable or misconfigured. In these cases, the desktop client will restore the connection when possible.

This warning can also result if your Media Exchange provider does not support the Desktop Client or has changed your permissions to access the channel. Please contact your provider to resolve these issues.

Managing Preferences

You can specify certain Media Exchange Desktop Client settings by clicking the Preferences button on the toolbar toolbar_options_enabled.png.

General Settings Description
Maximum number of active transfers The maximum number of packages that can be downloaded and/or uploaded at the same time [maximum value = 3].
  • Changes to this setting will not affect current transfers.
  • Specifying a value of 0 will disable transferring in the Desktop Client.
  • Transfers that are queued by your provider are active transfers, and are included in this limitation.
Do not show transfers older than X days Enable this option and use the pick list to specify the age limit in days for displayed transfers.
Remove transfer logs older than X days Enable this option and use the pick list to specify the age limit in days for displayed transfer logs.
Proxy Settings Description
No proxy Select this option if no proxy settings are specified on your computer.
Manual proxy configuration Select this option to use custom proxy settings. Choose from HTTP or SOCKS proxy types, then specify the domain name and port of the proxy server to connect to. Provide a username and password if required by your proxy server.
Note:
  • SOCKS 4 and SOCKS 5 proxies are supported.
Note: You must restart the application for changes to the proxy settings to take effect.
Authentication Settings Description
No Retries To prevent authentication and login retries, enable this option. This option is enabled by default.
Enable Retries To allow authentication and login retries, enable this option and specify the Retry Interval (in minutes) and the number of Retry Attempts.
Note: Repeated authentication failures could cause the Username account to be disabled by the authentication service.

Additional Media Exchange Desktop Client settings are specified in the Media Exchange Web Client. These include email delivery notification settings, as well as the security, speed and quality settings of your download and upload transfers. Log into your Media Exchange Web Client to specify these preferences, or ask your provider for assistance.

System Notifications

While it is running, the Media Exchange Desktop Client displays an icon in the notification area of the taskbar in Windows, and on the menu bar on a Mac. Clicking on this icon displays a menu from which you can Open the Desktop Client, edit its Preferences, get Help, display information About the client, or Quit the application. If a product update is available, the option to perform the Update will also be displayed in this menu. The icon is also used to display notifications that alert you to the occurrence of success and warning situations in the client.

The following notification states can be displayed:

State Description
signiant_window_icon.png Normal State

This state indicates that the Desktop Client is operating normally.

signiant_success_icon.png Successful Transfer

This state indicates that the most recent transfer was successful.

Note: The successful transfer state can be cleared by opening the Desktop Client and displaying the Transfers view.
signiant_alert_icon.png Alert State

This state indicates that a warning has occurred, or that a product update is available. Open the Desktop Client and display the Channels view for more information about the warning.

Note: A product update can be performed from within the Desktop Client or the notification icon menu.

 

signiant_error_icon.png Error State

This state indicates that an error has occurred. Open the Desktop Client and display the Channels view for more information about the error and how to resolve it.

Troubleshooting

Getting Help

Please contact your provider if you encounter any problems while using the Desktop Client.

Activity Logging

Media Exchange Desktop Client records its own activities in a log file, which you can use for troubleshooting purposes if directed to do so by your provider. The log file is located in your home folder's .signiant\log folder. The location of the home folder varies depending on the operating system you are using.

Network Configuration

Problems can result from using incorrectly configured shared network folders.

  • Users must have full read/write permissions to shared network Upload Folders and the files they contain or the files will not be uploaded. Contact your network administrator to resolve this situation.
  • Windows users must specify shared network Download and Upload Folders in the Desktop Client by their UNC path (eg. \\server\share\directory) and not by a mapped drive letter (eg. m:\directory).

Check with your Media Exchange administrator that a connection to https://activation.signiant.com has been established.

What's New

Version 2.1.2

Feature Description
Support for OS-X 10.10 The Media Exchange Desktop Client is fully supported on OS-X 10.10
Support for Java 1.8 The Media Exchange Desktop Client can be run on Java 1.8 and Java 6 is not required.
Fixed the "trusted developer" messages In previous releases, a message was displayed stating that the Media Exchange Desktop Client did not come from a trusted developer, this has been resolved.
Fixed incorrect transfer counting The incorrect transfer count problem has been resolved and only completed transfers are included in this count.
Subscription management update Users can now easily switch between Inbox subscriptions and channel subscriptions.
Online help is now available The Media Exchange Desktop Client online help is now available and fully up-to-date.
Package delays Timeouts no longer occur when downloading packages with a large number of items.

Version 2.1.1

Feature Description
Configure authentication settings Administrators can now configure authentication settings to allow or prevent authentication and login retries.

Version 2.1.0

Feature Description
Increase number of channels You can now subscribe to up to 100 channels.
Delete transfer removes files Selecting the 'delete' option (or pressing the DEL key) will give you the option to remove the file(s) associated with the transfer.
Subscribe to sub-channels When subscribing to a channel you'll now have the option to subscribe to the sub-channels that exist or are added in the future.
Channel subscription download options When subscribing to channels, you have the option to download to a time-stamped folder per transfer or a specific folder for all transferred packages.

Version 2.0.0

Feature Description
Package uploading The Desktop Client now supports the automatic uploading of packages from your computer to your subscribed channels.

Version 1.1.0

Feature Description
Proxy server support The Desktop Client now supports the usage of proxy servers in your network. Specify custom settings for the most common proxy server types. 
Download existing packages The option to download existing packages is now provided when initially subscribing to an Inbox or a channel. 

Version 1.0.0

Feature Description
Initial release Signiant Media Exchange Desktop Client extends Media Exchange by providing a very simple application that automates the downloading of content from your provider. It is simple to setup, easy to use, and works in a lights-out fashion.