Consignment Export

Consignment Export

Consignment Export


In TransVirtual there is the ability to setup Consignment EDI (Electronic Data Interchange) Exports which are essentially a method of exporting data out from TransVirtual to another location via email, FTP etc. 

1. This article will run through the basics of a Consignment EDI Export and will demonstrate an example setup that is commonly used. 
2. To see the consignment page, go to Import/Export > Export > Consignments. 

                                                                  

Example Setup

A common example for this type of rule is sending an email to a customer that includes labels and consignment PDF note for a consignment that have just created. 

How to Create/Add a New Rule


1. First go to Export Consignment page, you will see a similar screen as shown below.

                                                            

2. To create a new rule, click on the New Rule button as shown above, a pop up of Create a new export rule will display as shown below.

                                                                                                

3. Now manually enter the Rule Name where you input what you want this rule to be called. 
4. Now select the Export Framework with the help of Drop and Down button and then click on the Create button as shown above.
5. Now click on Create button to add this rule.
6. Once rule is created then it will display on Export Rules tab and highlighted in orange color as shown below.

                                                                        
The Orange color shows that this rule is not yet active.
7. Now, click on the new rule and the settings for this rule will appear on the right-hand side of the page as shown below.

                  

9. Now, you can add/update the detail of the rules as applicable.

Data Filter

1. To see the data filter tab, at the bottom of the page there is a Data Filter section. The Data Filter is the driving force behind when the rule will and won't apply to a consignment.
2.. To modify the data filter, you will need to use the drop-down logic selector at the bottom of the page.
                              

3. To set a data filter, now, first select the field with the help of drop and down button.
4. Now click on the Next button, the logic section will open, select the logic with the help of drop and down button and then click on the Next button, the select value tab will open.
6. Now select the value to compare the rule with the help of drop and down button and then click on Add Rule to save the changes.
7. Once you have completed step 6, you will see that the Data Filter has text (logic) in it as shown below.
                                                

If you want to add more filter then again follow the instructions from steps 3 to 7, one more filter will display as shown below.
            

To update/Edit the Rule   

This section helps you how to update/edit the rule. 
1. Once you have the configured the Data Filter, the next step is to edit the settings at the top of the page.
2. To do update, first select the rule, and then update the detail located at right hand side of the page as shown below.

                                                                        

3. 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: How often the import will look to import new files. In thi example it will be set to the default Every 2 mins value. 
      c. Trigger Event: This setting is used to define the event or action that will result in this Export being performed. In this example we are selecting it Consignment SubEvent this will work in conjunction with the Data Filter.
      d. Single Export Only: This setting simply prevents the same export from occurring multiple times, if needed can be toggled. In this example we are setting it up to No.
      e. Export Framework: is used to specify how the information will be exported from TransVirtual. In this example we are selecting it Email. 
      f. Here you can update the import framework setting by clicking on setting button, edit email setting popup will display as shown below. 

                                                                               

            Export Framework Setting

            i. The toggles at the top of this window allow you to send the email to the email listed on the consignment against the Sender or Receiver. Here we are selecting send the email to the Customer which means we need to specify what Customer Contact to send to with the help of drop and down button.
You have the ability to customize the FTP, E-mail, Webservice and SMS using the Settings button.
Export File Type: This setting will be visible when you select the Email on Export framework.
   
      ii. The Customer Contact emails will be based on what has been setup in the relevant Customer Card under the Contact Details Tab as shown below.

                                                                        

                  For Example: If you selected 'General' as the Customer Contact field, when the export triggers against a consignment with AR1 as the customer, it will send to the email listed against the General contact which is test02@gmail.com.

      iii. The Email To field used for internal staff email addresses unless you are limiting the Data Filter to a specific customer. All emails listed in the Email To section will receive the emails this rule generates.
      iv. In this example we are going to leave this field blank because setting the Customer Contact to General means that emails will be sent to the relevant General email for the customer of the consignment that the rule has triggered against.
      v. The Email Subject field can be used to include an email subject. 
      vi. In the second section of E-mail setting i.e., Email Body, include a message which you want to send.
      vii. Once you completed the step g, then click on update button, the entered data will be saved.

g. Export File Type: Select the export file type with the help of drop and down button.
      In this example we are using export file type Basic CSV/Excel.

Export File type setting

      i. If needed then you can update the export file type setting, to do this, click on setting button of Export file type the Edit pop-up of selected filed will open as shown below.

                                                            

       ii. On Edit CSV setting page, you can update the CSV file type with the help of drop and down button.
      iii. If required, then enable the toggle button in Yes position if you want to send the consignment and consignment logo in pdf.
      iv. Once you done with the above steps click on Update button to save the changes.
i. Enable Export: To enable this new rule, click on Toggle in Yes position, and then click on Update button to save the rules. Once you completed the color of the rule will be in White color which means that this rule is enabled.

                                                 
1. The Memo and Rule ID Errors are not mandatory field so in this example we keep it blank.
2. This is a common example as lots of your customers may book in a consignment and ask that you pick it up.
3. Setting this rule up means that they can then print out and label their freight ready for when your drivers pick the freight up. 


1. If you'd like to, it may be a good idea to include your own email in the below section Email To section as shown below.     

2. The reason to do this, is so that you also receive any emails generated by this EDI rule, which then means you'll know the EDI rule has worked and also what the email will look like when received by the customer.
3. A handy way to be able to test an EDI rule if needed - you can remove your email after you are happy the EDI rule is setup as expected.

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 button, the rule will be deleted from database as shown below.

                                                                  ​



    • Related Articles

    • Customer Service Ticket EDI Export

      In Transvirtual there is the ability to create Customer Service tickets for a consignment. The purpose of these tickets is to raise any issues to the attention of your team so that they can be resolved. Transvirtual can export any created ticket ...

    • Standard Consignment Process

      This article will detail the standard process used from the point of consignment creation, up until consignment completion. If you are new to Transvirtual this article may help provide you with a better understanding of the best way to run your ...

    • Photos Export

      Photo Export In TransVirtual there is the ability to setup Photo (Image) EDI (Electronic Data Interchange) Export Rules that can send out images/photos to a location via Email, FTP, etc. 1. To see the photo page, go to Import/Export > Export > Photo. ...

    • Manifest Export

      In Transvirtual there is the ability to setup Manifest EDI (Electronic Data Interchange) Export Rules that can send out Manifest information via FTP, Email, etc 1. This article will detail how to setup a common example; emailing an agent manifest to ...

    • Runsheets Export

      Runsheets Export In TransVirtual there is the ability to create Runsheet EDI (Electronic Data Interchange) Export Rules that can send Runsheet data to a location via FTP, Email etc. 1. This article will detail how to setup a common example; ...