Equipment Transactions Export (EDI)

Equipment Transactions Export (EDI)

Equipment Transactions Export (EDI)

Overview

In Transvirtual, you can set up Equipment Transactions EDI (Electronic Data Interchange) export rules that send Equipment Transaction information to a location via FTP, email, or other methods.

This article details how to set up a common example to send Equipment Transaction detail via email to a sender and receiver at the time a Delivery/Load has been completed. To see the page, go to Import/Export > Data Export > Equipment Transactions.

There are two ways to record the equipment transaction: via the web portal or via the mobile app.

Step-by-Step Instructions

Create/Add a New Rule

  1. To create a new rule, go to the Export Equipment Transactions page, which displays a screen similar to the one shown below.

  2. On the Export Equipment Transactions page, click the New Rule button as shown above. A pop-up titled Create a New Export Rule displays.

  3. Manually enter the Rule Name for the rule and select the Export Framework using the drop-down, then click Create.

    Note: this example uses "Sample Email Export 01" as the rule name and Email as the Export Framework.

  4. Once the rule is created, it displays on the Export Rules list, highlighted in orange.

    Note: orange indicates that the rule is not yet active.

  5. Click on the new rule to display its details on the right side of the page, as shown above. From here, you can add or update the rule's details.
  6. Before updating the rule details, set up the data filter first. Data filters determine when an EDI rule will and won't apply to a consignment.

Data Filter

  1. To see the Data Filter tab, on the rule detail screen scroll to the bottom of the page, where the Data Filter section displays.
  2. In the Data Filter section, select the details for Select Field, Logic, and Select Value, then click Add Rule. The rule detail displays on the Data Filter screen, as shown below.

    Note: this example uses Equipment Name in Select Field, Equal in Logic, and Pallet in the Select Value field.

Once the data filter is configured, update the rule as described below.

Update/Edit the Rule

  1. Click on the newly added rule to display the rule details on the right side, as shown below.

  2. Update the details as follows:
    1. Rule Name: the name given to the rule. It can be changed at any point but should reflect what the rule is used for. This example leaves the rule name as set at initial creation.
    2. Trigger Period: this field may be blank initially. When the rule is enabled, it defaults to Every 2 Mins unless another selection is made. This section specifies how often the EDI rule runs. Click the Settings button next to this field to select when the rule runs.

      Select a time period and click Update to save the changes.

      Note: this example sets the trigger period to Every 2 Mins, meaning any applicable POD data is exported as soon as it becomes available.

    3. Limit Exports: specifies whether the EDI rule should be triggered more than once for the same event. The number of times the same export occurs can be limited. This example selects Not Required.
    4. Export Framework: specifies how the information is exported from Transvirtual. This example selects Email. Click the Settings button to update the export framework setting; a pop-up to edit the email settings displays.

      Export Framework Settings

      Once the export framework setting is selected, a screen similar to the one below displays.

      On the Edit Email Settings screen, update or add the basic details related to the email as follows:

      1. Send to Consignment Sender Email: enable the toggle to send the email to the sender's email ID.
      2. Send to Consignment Receiver Email: enable the toggle to send the email to a receiver's email ID.
      3. Send to Consignment Creator: enable the toggle to send an email to the consignment creator.
      4. Email To: manually enter the email address in the Email To field.

        Note: the Email To field should typically be used for internal staff unless the Data Filter for this EDI rule is limited to a particular customer. Any emails listed in the Email To section receive all emails generated by this EDI rule, so only internal staff emails should be listed here. This example leaves this field blank because the emails are sent to a customer contact.

      5. Email Subject: enter the email subject in this field.

        Note: this example uses "Your consignment has a new Equipment Transaction" as the email subject.

      6. Once the above steps are complete, the Email Details page looks similar to the example below.

      Once the basic details are complete, click the Body tab and add a message. This example uses the following.

      • It is advisable to use the Validate button at the bottom. This button checks that all the data is correct.
      • After using the Validate button and entering @Model.ConsignmentNumber correctly, a white screen displays showing an example of what the email will look like.
      • Click the OK button on this window to return to the main email settings window.
    5. Export File Type: select the export file type using the drop-down. This example uses None.

      Note: this example only sends the images and signatures for the relevant consignment PODs, so the email contains only the images and signatures as attachments.

    6. Enable Export: to enable this new rule, set the toggle to Yes, then click Update to save the rule.
    7. Once the above steps are complete, the rule's colour changes to white, indicating that the rule is enabled.

      Note: the Link to Rule ID and Rule ID Errors fields are not mandatory, so this example leaves them blank.

Delete the Rule

To delete a rule, click the delete icon. A confirmation dialog displays; click Yes and the rule is deleted from the database, as shown below.

  1. How to record an equipment transaction on the Scanning page via the mobile app.
  2. How to record an equipment transaction on the Delivery page via the mobile app.
  3. How to record an equipment transaction on the Scanning page via the mobile app.
  4. How to record an equipment transaction on the Search page via the mobile app.