Photos and Images EDI Import
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 or Manual methods etc. This article will detail an example setup.
Setup a Rule
1. To setup a rule, first go to Photos Import Setting page by navigating to on TMS web portal. go to Import/Export > Import > Photos, the Photos Import Setting page will display as shown below.
2. To create a new Image/Photo Import rule, click Add Import Rule. After doing this you will then see the below pop-up appear:
3. On Create a new import rule screen, fill the details as describe below.
a. Rule Name: This is simply the name of the EDI rule. The name should be reflective of what the rule does. For this example, we are going to call the rule "Image upload via Email".
b. Import Framework: This is the method by which your images will be imported into your account. You can choose the import framework with the help of drop and down button.
In this example we will use Import Framework as an Email.
4. Once done, click on Create to add a new import rule. Your rule will now appear in orange in the list of imports. Now, click on this newly added rule on the left and the settings for it will appear on the right of the page as shown below.
5. On rule detail page, you can configure the details as describe below.
a. Rule Name: This will be populated already but you can change if needed. We are going to leave the rule name as is for this example.
b. Import Framework: Chosen when creating the rule initially, however, if needed, you can update.
1. If selecting Transvirtual Email Account as we have for this example, you will need to click on the Settings next to this line and then click on Generate, a unique email to link this rule will generate as below.
2. Now, click on Update to save the changes.
c. Import File Type: This is the file that will be imported to generate images and attach to connotes in your account. For this example, we will set as Image Only meaning just an image will be imported.
d. Customer (Optional): This field allows you to assign a customer meaning any imports done via this rule will have that customer listed. This field is not typically required because generally your rule would be for multiple consignments with varying customers. This field would only be used if importing images against connotes for just one customer. For this example, we will leave blank.
e. Agent/Supplier (Optional): Allows you the ability to nominate an agent to assign the images to. Handy if your images are always from the same agent. For this example, we are going to leave blank.
f. Date Format String (Optional): Allows you the ability to nominate the Date Format that imported data will be in. For this example, we are going to leave blank.
g. Date Time Format String (Optional) = Allows you the ability to nominate the Date Time Format that imported data will be in. For this example, we are going to leave blank.
h. Time Zone: Allows you to set what time zone will be listed against the import. Typically, this is fine to leave as your current time zone but can be adjusted to suit. For this example, we are going to leave set to Sydney time.
i. Enable Import: Used to activate or de-activate an EDI rule.
j. Memo: A section you can add any notes if required.
k. Email EDI Errors: Entering an email address here means that email address will be sent a message if any imports done via this rule fail.
l. Once done, the setup would look similar to the below:
Once you made the changes, do not forgot to click on Update to save the changes.
j. To activate the rule, click on Enable Import toggle and then click on Update to save the change:
k. The rule is now active and can be used to import images into your account.
- This type of import can be used to import both image and PDF files!
- When importing any file, especially PDF files, it is advised to name the file per the consignment number you wish it to attach. For example, any images you wish to attach to consignment TEST123 should be named TEST123.pdf or TEST123.png (depending on the file extension/type).
- This is a requirement for PDF type files as PDF files can't be read in the same way as image files. The system will use the filename to attach to the relevant consignment.
- When importing any file, especially PDF files, it is advised to name the file per the consignment number you wish it to attach. For example, any images you wish to attach to consignment TEST123 should be named TEST123.pdf or TEST123.png (depending on the file extension/type).
- This is a requirement for PDF type files as PDF files can't be read in the same way as image files. The system will use the filename to attach to the relevant consignment.
Edit the Rule Details
1. If you wish to edit the rule detail, simply click on the rule which you want to edit and the follow the step 5 as describe in above paragraph.
Delete the Rule
1. To delete a rule, go to Photos Import Settings page and find the applicable rule from the rule list which you want to delete. Now, click on the delete icon of the applicable rule, a confirmation pop-up will display as shown below.
2. Click on Yes, the rule will be removed from the list.
Extra Information - What Next?
1. Once you have configured your Import rule, you then need to send the data to your account via this import rule. The example above was setup using an import method of email which means that to import any image files into your account, you will need to attach the relevant files to an email and send to the email address linked to the import rule.
2. Much like with PODs, images should be grayscale, 100-200 dpi and of a good quality; no shadows obstructing numbers, and the image can't be too small or taken from too far away.
3. You can send multiple images in the one email, but each image file should only contain one image on one page (single page, single image).
If the import fails, what happens?
Much like with POD Imports, if the Image import fails the failed image will be added to an open Image Batch were ideally a staff member would manually process these and assign to the relevant consignment number (where applicable). Click here for a link to POD Import which provides further information on this.
Related Articles
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. ...General Import Information
Introduction to Imports The import framework within TransVirtual allows you to import your data in a number of ways. This framework will expand as technology develops. There are 6 import frameworks as below. Remote FTP TransVirtual Hosted FTP Server ...EDI Exports - General Information
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 ...Proof of Delivery - Import
In Transvirtual you can setup EDI (Electronic Data Interchange) Import rules that allow you to upload of PODs and link them to a specific consignment. This functionality is useful when an external system send you PODs directly to your Transvirtual ...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 ...