Photos and Images Import (EDI)

Overview

Create the Import Rule

1. Navigate to Import/Export > Import > Photos. The Photos Import Setting page displays.
   
2. Click Add Import Rule to create a new Image/Photo import rule. A pop-up displays.
   
3. On the Create a new import rule screen, fill in the details:
   • Rule Name: 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".
   • Import Framework: the method by which your images will be imported into your account. You can choose the import framework using the drop-down button.
     Note: this example uses Import Framework set to Email.
4. Click Create to add the new import rule. The rule appears in orange in the list of imports. Click the newly added rule; its settings appear on the right of the page.
   

Configure the Import Rule

1. On the rule detail page, configure the following:
   • Rule Name: this is already populated, but can be changed if needed. This example leaves the rule name as is.
   • Import Framework: chosen when creating the rule, but can be updated if needed. If selecting Transvirtual Email Account, as in this example, click Settings next to this field, then click Generate. A unique email to link this rule is generated, as shown below.
     
     Click Update to save the changes.
   • Import File Type: the file that will be imported to generate images and attach them to consignments in your account. For this example, we set this to Image Only, meaning only an image will be imported.
     
   • Customer (Optional): assigns a customer so any imports done via this rule list that customer. This is not typically required, since your rule would usually cover multiple consignments with varying customers. Only use this field if importing images against consignments for a single customer. This example leaves it blank.
   • Agent/Supplier (Optional): lets you nominate an agent to assign the images to. Useful if your images always come from the same agent. This example leaves it blank.
   • Date Format String (Optional): lets you nominate the Date Format the imported data will be in. This example leaves it blank.
   • Date Time Format String (Optional): lets you nominate the Date Time Format the imported data will be in. This example leaves it blank.
   • Time Zone: sets the time zone listed against the import. This is typically fine to leave as your current time zone, but can be adjusted. This example leaves it set to Sydney time.
   • Enable Import: activates or deactivates an EDI rule.
   • Memo: a section for adding notes if required.
   • Email EDI Errors: an email address entered here is sent a message if any imports done via this rule fail.
   • Once configured, the setup looks similar to the example below.
     
     Alert: once you have made changes, remember to click Update to save them.
   • To activate the rule, click the Enable Import toggle, then click Update to save the change.
     
   • The rule is now active and can be used to import images into your account.
     Note: this type of import can be used to import both image and PDF files. When importing any file, especially PDF files, name the file per the consignment number you want it to attach to. For example, images you want to attach to consignment TEST123 should be named TEST123.pdf or TEST123.png (depending on the file extension or type). This is a requirement for PDF type files, since PDF files cannot be read in the same way as image files; the system uses the filename to attach the file to the relevant consignment.

Edit the Rule Details

Delete the Rule

1. On the Photos Import Settings page, find the rule you want to delete from the rule list. Click its delete icon. A confirmation pop-up displays.
   
2. Click Yes. The rule is removed from the list.

Important

Common Issues & Troubleshooting

Related Article