Equipment Transactions Export (EDI)
OVERVIEW
In Transvirtual there is the ability to setup Equipment Transactions EDI (Electronic Data Interchange) Export Rules that can send out Equipment Transaction information to a location, via FTP, Email, etc.
In Transvirtual there is the ability to setup Equipment Transactions EDI (Electronic Data Interchange) Export Rules that can send out Equipment Transaction information to a location, via FTP, Email, etc.
This article will detail how to setup a common example to send Equipment Transaction detail via email to a sender and receiver at the time of Delivery/Load/ delivery has been completed. To see the page, go to Import/Export > Data Export > Equipment Transactions.
There are two ways to record the equipment transaction, one is via web portal and another one is via Mobile app.
STEP-BY-STEP INSTRUCTIONS
CREATE / ADD NEW RULE:
1. To create a new rule, go to the Export Equipment Transactions, where you will see a similar screen as shown below.
2. On Export Equipment Transactions page, click on the New Rule button as shown above, a pop up of Create a new export rule will display as shown below.
3. Manually enter the Rule Name where you input what you want this rule to be called and select the Export Framework with the help of Drop-down button and then click on the Create as shown above.
In this example we will use Sample Email Export 01 as a Rule name and Email in Export Framework.
4. Once rule is created, it will display on Export Rules list and highlighted in Orange color as shown below.
The Orange color shows that this rule is not yet active.
5. Now, click on the new rule and the details for this rule will appear on the right side of the page as shown above. Here you can add/update the detail of the rule as applicable.
6. Before updating the rule detail, first set up the data filter. Data filters are the driving force behind how the system determines when an EDI rule will and won't apply to a consignment.
DATA FILTER:
1. To see the data filter tab, on rule detail screen, scroll down at the bottom of the page, where you will see Data Filter section.
2. On data filter section, select the details for Select Field (Screen 01), Logic (Screen 02) and Select Value (Screen 03) and then click on Add Rule, the rule detail will display on Data Filter screen (Screen 04) as shown below.
- In this example, we used Equipment Name in Select Field, Equal in Logic and Pallet in Select Value field. - Once data filter is configured, now update the rule/edit the rule as described below.
UPDATE / EDIT THE RULE:
1. Now, click on newly added rule, and you will see the rule details on the right side as shown below.
2. You can update the details as follows:
a. Rule Name: Name given to rule. Can be changed at any point but should be reflective of what the rule will be used for/does. This example will leave rule name as was set on initial creation.
b. Trigger Period: This may come up blank initially, however, when the rule is enabled, it will default to Every 2 mins if you don't make a selection for this field. This section is used to specify how often this EDI rule will run. If needed, you can click on the Settings button next to this field and can select when you want this rule to run.
- Select a time period and click on Update to save the changes.
For this example, though we are going to set as Every 2 mins; this essentially means any applicable POD data will be exported as soon as it becomes available.
c. Limit Exports: This section can be used to specify whether this EDI rule should be triggered more than once for the same event. If needed, you can limit the number of times the same export will occur. In this example we are going to select it as Not Required.
d. Export Framework: is used to specify how the information will be exported from Transvirtual. In this example we are selecting it Email, here you can update the export framework setting by clicking on setting button, a pop-up to Edit the email setting will display.
You have the ability to customize the FTP, E-mail, Webservice, Printer, Account Package and SMS using the Settings button.
Export Framework Settings
Once you click on the export framework setting, you will see a screen similar to the below.
a. On Edit the email settings, you can update/add the basic details related to email as below.
i. Send to Consignment Sender Email: Enable the toggle, if you wish to send the email to sender mail ID.
ii. Send to Consignment Receiver Email: Enable the toggle, if you wish to send the email to a receiver mail ID.
iii. Send to Consignment Creator: Enable the toggle, if you wish to send an email to consignment creator.
iv. Email To: Manually enter the email in the email to field.
The Email To field should typically be used for internal staff unless the Data Filter for this EDI rule is limited a particular customer. Any emails listed in the Email To section will receive all emails generated by this EDI rule; so, it is advisable that only internal staff emails be listed here. For this example, we are going to leave this field blank as we are sending emails to a Customer Contact. v. Email Subject: Enter the Email Subject in this field.
In this example we are using email subject as Your consignment has a new Equipment Transaction.
vi. Once you completed the above steps, the Email details page will look alike as below.
b. Once basic detail has been completed, now click on Body tab and add a message of your choosing. For this example, we are going to use the below.
- It is advisable to use the Validate at bottom. This button checks to ensure that all the data is correct.
- After using the validate button and you have typed @Model.ConsignmentNumber correctly, you will be returned with a white screen which will display an example of what email will look like.
- Click on the Ok button on this window to return to the main email settings window you were in previously.
d. Export File Type: Select the export file type with the help of drop and down button. In this example we are using None.
1. In this example, we are only wanting to send the images and signatures for the relevant consignment PODs. So, when the email sent, it will now only contain the images and signatures as attachments.
e. Enable Export: To enable this new rule, click on Toggle in Yes position, and then click on Update button to save the rules.
f. Once you completed the above steps, the color of the rule will be in White which means that this rule is enabled.
The Link to Rule ID and Rule ID Errors is not a mandatory field so in this example we keep it blank.
DELETE THE RULE:
1. If you want to delete the rule, simply click on the delete icon, a confirm dialog will pop-up, click on Yes, the rule will be deleted from database as shown below.
RELATED ARTICLES
1. To know, how to record equipment transaction on Scanning page via mobile app, click here.
2. To know, how to record equipment transaction on Delivery page via mobile app, click here.
3. To know, how to record equipment transaction on Scanning page via mobile app, click here.
Related Articles
Shared EDI Export Concepts
This article gives you basic information about Data Export. Creating a Data Export Before we can start creating the export we need to analyse the issue we are trying to solve. At its simplest you can work through a few easy questions to get you ...Customer Service Ticket Export (EDI)
SUMMARY / PURPOSE Use this article to automatically export Customer Service Ticket information from TransVirtual using EDI rules. This guide explains how to notify customers or staff when tickets are created or updated, ensuring issues are ...EQUIPMENT BALANCES
OVERVIEW The Equipment Balance Report provides comprehensive tracking of equipment transactions between your business and other locations. This report displays all transactions based on your configured Equipment Types, enabling you to: • Monitor ...Photos and Images Import (EDI)
OVERVIEW In Transvirtual there is the ability to import photos and images and attach them to relevant consignments. This is done by creating an EDI (Electronic Data Interchange) Import rules in your account that can accept information via Email, FTP ...Unknown Scans Export (EDI)
SUMMARY / PURPOSE Use this article to create and manage export rules for Unknown Scans in TransVirtual. This guide explains when to use Unknown Scan export rules, how they work, and what is required to notify customers or internal teams when unknown ...