Sign in

Viewing transfer status -- Native UI and Classic Web UI

  • Updated

Transfer logs contain information about the transfer of individual files; they are not action logs reporting the status of actions. When processing multiple files, each file transfer is logged individually when the actual file transfer begins. The log record is updated when the transfer is completed. If other action commands fail before the file transfer begins, the file transfer is not logged.

Use the Transfer Report to view the status of transfers that have already occurred.

  1. To view the Transfer Report, do one of the following:
    1. In the web UI, click Transfers. In the native UI, select Tools > Transfer Report or click Transfers in the toolbar.
      Note: In the web UI, if you click the Transfers button, by default, the web UI displays the entire transfer report without displaying the filtering criteria dialog box. To display the filtering criteria in the web UI, click Filter.
    2. Right-click a folder, host, and mailbox and then select Transfer Report from the context menu. If you use this method, the folder, host or mailbox you right-click will be preseleted as part of your filtering criteria.
    The Transfer Report Filter dialog box is displayed.
  2. Specify criteria for the transfers you want to display. See Transfer Status Filter.
    Alternatively, click Open to choose a previously saved filter criteria file to populate the fields in the dialog box.
  3. Select a format for the report. Choose either Table or Report. If you choose Report, you can select Include details to populate the report with detailed information about the transfers.
  4. Optionally, click Save As to save any filter criteria you specified to an XML file.
    You can use this XML file to later recall these settings using Open… or with the VLStatc -f command-line option to use the filter for reports generated to a file or to an email address.
  5. Click Continue to display the report.
Note: In the web UI, if you click the Transfers button, by default, the web UI displays the entire transfer report without displaying the filtering criteria dialog box. To display the filtering criteria in the web UI, click Filter.

Transfer Status Filter

Use the Transfer Status Filter panel to select the items you want to view. By default, it displays the current day's transfers.

Specify values in the From and To fields to select the range of times. You can either use the menus, or manually enter dates (YYYY/MM/DD) and times (HH:MM) into the fields. There are four possible tabs that can be present on this panel:  General, Tracking,VersaLexes, and Advanced.

Filters can be saved and cleared as needed.

Transfer Status Filter - General Tab

Use the General tab to specify filter criteria based on specific trading partner connections, folder names, and hosts\mailboxes.

Include Trading Partner(s)
Select the check boxes for all the trading partners you want to include in the report.
Click All to select all the trading partners in the list.
Click None to clear all selected trading partners.
Include Folder(s)
Select the check boxes for all the folders you want to include in the report.
Click All to select all the folders in the list.
Click None to clear all selected folders.
Include Host(s)
Select the check boxes for all the hosts you want to include in the report.
Select the Show Mailboxes check box to include mailboxes within each of the hosts in the list.
Note: Transfers associated with host-based actions are displayed only if Show Mailboxes is unchecked and the associated host is selected.
Click All to select all the hosts in the list.
Click None to clear all selected hosts.

The Username(s) filter is shown if you have configured and enabled an LDAP server. You can enter a comma or semi-colon separated list of LDAP usernames. If you set this field, all but local FTP, HTTP, and SSH FTP LDAP mailboxes are excluded and only transfers for the specified users are included.

Transfer Status Filter - Tracking Tab

In addition to specifying a date range, and any filter selections made on the other tabs, if one of the file tracking features is enabled, you can also filter based on certain tracking criteria. You have the option to filter by either EDI, XML or text data. For the Reference 1 and Reference 2 filters, you can use the special % character at the beginning and/or end of the search value to perform wild-carded searches. When fields on the tracking tab are dimmed, it could indicate that the either the feature is not licensed or it is not enabled.

The […] buttons are present when Trading Partners are available for selection. These buttons allow the user to display the Trading Partners and configured Interchange Identifiers/Qualifiers. See Managing Trading Partners.

If you select a Trading Partner Alias along with Use All Interchange Identifiers/Qualifiers, a trading partner alias variable is used. This matches any of the Interchange Identifiers/Qualifiers configured for the Trading Partner. If you select Use All Interchange Identifiers/Qualifiers, you can select a specific Interchange Identifier/Qualifier pair to use. Once you have made your selections and click OK, the selection is placed in the appropriate fields depending on which button was selected.

Transfer Status Filter - VersaLexes Tab

You can filter by specifying a date range or any filter selections on the other tabs. If logging transfers to a database and synchronizing hosts across multiple instances of Cleo Harmony, Cleo VLTrader, or Cleo LexiCom software, you can also filter based on which instance performed the transfer. By default, all synchronizing instances of the Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application are included. Also, if you specify numbers in the Options > Transfers > Additional Serial Numbers field, those numbers are displayed. The All and None buttons allow you to select all or none of the instances of Cleo Harmony, Cleo VLTrader, or Cleo LexiCom application.

Transfer Status Filter - Advanced Tab

You can filter based on transport, status, direction, and run type, in addition to specifying a date range and any filter selections made on the other tabs. The All and None buttons allow you to select all/none of the criteria for the particular section for which the button applies. 

Transfer Table Standard View

The Transfer Report panel shows the status of the items that match the filter selected. The File Type column is displayed only if file tracking is enabled. This column displays EDI (EDI-X12, EDIFACT, or TRADACOMS), XML or Text, depending on the file tracking options and the file transferred. The Run Type column is only available when database transfer logging is being used. If are employing Cleo VLNavigator user groups, you can add columns, remove columns, and set the order of the columns per user group. See User Group File Transfer Report Tab.

Initially, the table is sorted by the Start Time of the transfer. Click any of the column headers to sort the table in ascending or descending order based on the contents of the selected column.

Note: A transfer could have a status of Delete Error or Delete Resolved. These are special statuses associated with a monitoring feature of the VersaLex application. See Monitoring source deletion for more information.

Click the buttons at the bottom of the table to change filter settings and refresh the table, find entries in the table, refresh the table with the current filter, generate an HTML report, and export the table to a CSV file. 

Tool-tip snapshots

Tool-tip snapshots are only available under the following conditions:

  • Configure > Options > Transfers > Transfer Logging is set to Database.
  • For remote hosts, the sentbox and receivedbox are configured. 
  • For local users hosts, the archive sentbox and receivedbox are configured. 
  • Configure > Options > Other > Disable Date/Time Portion of Filenames in Sent/Received Box is unchecked (off).

To get a small snapshot of a file's contents, hold your mouse over the cell of the filename. The beginning of the file (up to 250 characters) will be displayed within the tool-tip help. If the file's contents cannot be displayed for any reason (for example, the file contains binary data), the tool-tip text will indicate the reason for non-display. Unlike other tool-tip help where the text is displayed for a maximum time period (usually a few seconds), this particular help is displayed as long as your mouse is over the filename. 

You can select a range of rows, or multiple ranges, using the Shift and Ctrl keys. When selecting multiple rows, hold down the Shift/Ctrl key while right-clicking to display the menu. Release the Shift/Ctrl keys prior to clicking a specific menu selection.
Note: For the web UI, it is particularly important to release the Shift and Ctrl keys prior to making the menu selection, as leaving either depressed could bring up another browser tab.

Right-click menu options

Right-clicking on a row (or rows) displays a menu. The menu selections vary based on the characteristics of the selected rows.

You can select a range of rows, or multiple ranges, using the Shift and Ctrl keys. When selecting multiple rows, hold down the Shift or Ctrl key while right-clicking to obtain the menu. Then, release the Shift and Ctrl keys prior to clicking a specific menu selection.
Note: For the web UI, it is particularly important to release the Shift and Ctrl keys prior to making the menu selection, as leaving either depressed could bring up another browser tab.

Viewing detailed information

If any single transfer (row) is selected, then View Information... is available. A shortcut to this option is to double-click or right-click the row. When selecting View Information... or double-clicking, the transfer details will be displayed as shown in the dialog below. If the file type is EDI, the extracted EDI headers will be included at the bottom of the display. Furthermore, if EDI functional acknowledgments are being tracked, a Show Acknowledgment(s) button allows the corresponding functional acknowledgment transfer information and EDI headers to be added to the bottom of the display.

Viewing a copy

View Copy... is only available under the following conditions:
  • Configure > Options > TransfersTransfer Logging is set to Database.
  • For remote hosts, the sentbox and receivedbox are configured. 
  • For local users hosts, the archive sentbox and receivedbox are configured. 
  • Configure > Options > Other > Disable Date/Time Portion of Filenames in Sent/Received Box is unchecked (off).

For any single transfer, when View Copy... is selected, a dialog box appears and displays the file's contents. By default, the character representation of the file is displayed. It is also possible to display the file in various dump representations such as hexadecimal or octal. This allows the display of binary data -- a useful tool when looking for specific control characters. It is not possible to change the file's contents; this display is view-only.

Viewing Resend/Rereceive Chain

If the transfer has already been resent or rereceived, the chain of transfers can be viewed. The date/time, transfer ID and status of each transfer are shown in a hierarchical display. The pointer indicates the currently selected transfer.

Resending and rereceiving

Resend and Rereceive are only available under the following conditions:
  • Configure > Options > Transfers > Transfer Logging is set to Database.
  • The sentbox or receivedbox is configured.
  • Configure > Options > Other > Disable Date/Time Portion of Filenames in Sent/Received Box is unchecked (off).
  • The send or receive applies to a remote host.

For one or more transfers, when you select Resend or Rereceive, the Resend or Rerecieve dialog box appears.

The Actions drop-down list provides the list of all actions within the mailbox. If all selected transfers belong to the same action, then that specific action will be pre-selected for you. If EDI file tracking is enabled, a list of Transactions is also displayed and a subset of transactions can be selected for resend or rereceive. After selecting the desired action and optionally transactions, click Resend or Rereceive to initiate the new transfer operation. The selected files will be located within the sentbox or receivedbox and run through the specified action. In the case of rereceive, an actual protocol transfer does not occur, but the file is re-streamed into the appropriate inbox directory and any execute/email on properties are invoked. The progress of the repeat operation is displayed within the dialog as shown below:

Emailing a Copy

Note: Email Copy is only available under the following conditions:
  • Configure > Options > Transfers > Transfer Logging is set to Database.
  • For remote hosts, the sentbox and receivedbox are configured. 
  • For local users hosts, the archive sentbox and receivedbox are configured.
  • Configure > Options > Other > Disable Date/Time Portion of Filenames in Sent/Received Box is unchecked (off).

For one or more send or receive transfers, when Email Copy... is selected, the following dialog will be displayed. 

Complete the following information on the screen:

  1. In the To: field enter the email address of your trading partner. If the associated host is associated with a Trading Partner (see Managing Trading Partners) and the Trading Partner has Technical contacts, then a Get Partner Contacts button will be displayed. Selecting this button will fill the To: field with all the associated Technical contacts. Multiple valid email addresses may be specified, separated by colons, semi-colons, or commas.
  2. The From: field's default value is taken from the 'System Administrator Email Address' defined in the Other tab of Configure System Options. If this field contains multiple email addresses, only the first address is used. 
  3. Update the Subject: field as needed. It defaults to a string consisting of the license owner, product, and transport.
  4. Choose the Send all attached files in one zip file option if you wish to compress the size of the data emailed or if your trading partner's email client has difficulty receiving your files due to certain file extensions.
  5. Update the Message area as needed. It defaults to a descriptive message identifying the transport and time-date range.
  6. After entering the needed information, click Send. The selected files will be located within the sentbox/receivedbox, optionally zipped into an archive, and then emailed.  After the email has been successfully sent, you a dialog indicating success is displayed.

If there were any warnings or errors that were identified during emailing, you will receive notification of this as well. 

Rerunning a Failed Action

If a single, failed send is selected, Run Action will be available. If Run Action is selected, the file size and modification time are compared against those from the original transfer. If the size and/or times are different, a dialog box describing the differences is displayed.

If the file has not been modified, a dialog box appears to verify the action to be run.

Note: Use extreme caution when using Run Action for the following reasons:
  • The action may have already been run either by the scheduler, a translator, from command line, or interactively.
  • The action may send other files besides the intended file.
  • The action may be performing other operations (copying, deleting, and so on) besides the transfer of the intended file.
  • The action may contain receive commands, in which case files will be retrieved from the trading partner.

The filter for the table can be modified again by clicking Filter. The Refresh button is used to update the table display in the case of new item availability. The refresh re-reads the data based on the current filter and re-displays the table. If the Generate Report button is clicked, the filter dialog is displayed allowing the user to select the report filter criterion.

Transfer Report Generation

Clicking Generate Report displays the report generation filter. This is the same dialog as above with the added Include details check box. If Include details is selected, every transfer matching the filter is displayed in the report. If Include details is not selected, only the totals are displayed. After selecting the criteria, click Generate to generate the report.

The Include EDI option is available only if EDI logging is enabled.

The report is sorted in order of Host\Mailbox followed by the transfer time. It contains the time span of the transfer, direction, status, bytes transferred, actual transfer time, and file name. The summaries contain a total of the number of files based on the status and direction of the transfer. They also contain the number of bytes transferred and total transfer time.

Transfer EDI Table View

The EDI Transfer Report panel shows the interchanges that match the filter selected. Initially this is sorted by the Start Time of the transfer. By clicking on the column headers, the table can be sorted in ascending or descending order. If you select a row, the interchanges functional groups and/or transaction sets are then listed. If you double-click on a row in any of the tables, it will display the detailed transfer information regarding that interchange.

Right-clicking on a row will display a menu where you can choose from several actions.

If transaction rows are selected and functional acknowledgment tracking is enabled (refer to Transfers EDI Logging under Configure System Options) and the acknowledgment is still pending, then both View Information... and Manual Acknowledgment... will be available. View Information... gives the same information as double-clicking on the row. If Manual Acknowledgment... is selected and confirmed, the Ack Status is changed from pending (denoted by *) to manually acknowledged (denoted by @). Manual acknowledgment is useful for clearing pending acknowledgments that will never be received; however, a manually acknowledged transaction’s Ack Status is still updated if a functional acknowledgment is later received.  Also, right-clicking a manually acknowledged transaction will offer a menu containing Undo Manual Acknowledgment…, which allows resetting of the Ack Status back to pending.

Transfer Entries for CHECK Commands

The CHECK command is used to track certain events related to the transfer of data into and out of the VersaLex environment. See CHECK command for more information.

 If the ConditionsMet parameter is specified on CHECK command, the results of the CHECK command are logged as a "quasi-transfer" and can subsequently be reported through transfer reports. Each CHECK's quasi-transfer is given an ID, similar to a transfer ID on actual transfers. This ID is unique and starts with the word CHECK. The Transport/Check column of the transfer table will classify checks as either CHECK FILE/DIR or CHECK TRANSFER, based on the settings of the associated command. The only right-click menu item available for CHECK entries is View Information.... When View Information... is selected, a dialog such as the following will be displayed. Notice the Command: data item in this dialog. This item, which is only available if database transfer logging is enabled, is provided because the CHECK command can become quite complex if many parameters are specified.

Related articles

Comments

0 comments

Please sign in to leave a comment.