Regions

The Regions screen provides a variety of options for searching for Regions.

Search

The search feature allows you to search for a specified text string anywhere within a wide range of Region attributes.

1. Optionally, in the search field near the top of the Regions screen, enter the desired text string.

2. Press Enter, or click the search button (magnifying glass icon).

3. The Regions screen is refreshed to show only the Regions that meet your search criteria.

4. To remove all search criteria, click the remove button ("X" icon).

Sort

The "Sort" drop-down menu allows you to sort the Regions on a variety of different fields. To sort the list of Regions, select the desired sort option from this menu.

• Region ID (default)

• Name

• Created Date

• Updated Date

 

To create a new Region:

1. Enter the Display Name value for the new Region.

2. Click create to display the Edit Region pop-up window.

3. The "Display Name" field is populated with the value you entered above; optionally edit this value.

4. The Internal Name is automatically populated based on the Display Name value. This field is uneditable by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

5. Enter the Integration ID.

6. In the "Places" field, select a Place to assign to this Region. Repeat this step as needed to assign additional Places to this Region.

7. Optionally in the "Tags" field, assign one or more Tags to this Region.

8. Click save.

 

To view or edit the details of a Region:

1. Search, sort, or filter the Regions screen as described above.

2. Click on the desired Region record. The "Edit Region" pop-up window is displayed.

3. Make any necessary changes to the Region properties.

4. Click save.

 

To delete a Region:

1. Search, sort, or filter the Regions screen as described above.

2. Click on the desired Region record. The "Edit Region" pop-up window is displayed.

3. Click delete.

4. A confirmation dialog box is displayed; click confirm.  

 

Export definitions can optionally be saved and reused, when you need to download Region records from EDP:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Export Regions." The "Create New Export - Regions" pop-up window is displayed.

Info section

2. In the "Display Name" field, enter a name for the export file.

3. The "Internal Name" is automatically populated based on the "Display Name" value. This field is uneditable by default. To edit the Internal Name, check the "Edit Internal Name" check box. A confirmation dialog box is displayed; click ok. Edit the Internal Name value

4. In the "Description" field, enter a description of the export file.

5. Select a column separator -- comma or semicolon.

Timing section

5. Select when you want to execute the export:

• Asynchronous -- if you check this option, you'll have the ability to enter one or more recipients to receive the export by email.

• Execute now -- check this option if you want to execute the export immediately.

• Create schedule -- check this option if you want to define a schedule (either a one-off execution, or a recurring schedule).

6. If you checked "Create schedule" above, the schedule options are displayed.

Define Export ScheduleDefine Export Schedule

Notification and Transport section

If you checked "Asynchronous" above, this section is displayed.

7. In the "Success Email Recipients" text field, enter one or more email addresses for recipients to receive a "success" notification.

8. In the "Error Email Recipients" text field, enter one or more email addresses for recipients to receive an "error" notification.

Fields section

This section allows you to optionally include (or exclude) specific columns in the export file.

9. From the "Inclusion" drop-down menu, select an option:

• All -- include all columns in the export file.

• Only Selected-- in the "Fields" field, select one or more columns you want to export, in the sequence you want them appear in the export file.

• Except Selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

10. Optionally select an attachment from the "Attachments" drop-down menu.

11. Optionally, to include the URL to the attachment, check "Include Attachment URL."

Rules section

This section allows you to create custom business rules to define which order records are included in the export file.

12. To add a rule, click the plus-sign icon, and select "Add Rule."

13. From the first drop-down menu, select the desired field.

14. From the second drop-down menu, select a mathematical operator.

15. In the text field, enter the desired value.

16. If you define multiple rules, select the logical operator connecting the rules: From the "Include customers that meet" drop-down menu above the list of Rules, select either:

• All of the following (i.e., an AND operator)

• Some of the following (i.e., an OR operator)

To remove a Rule, click the delete icon next to it. To remove all Rules, click reset.

Associations section

To download records associated with the Region records:

17. Click add. A new row is displayed.

18. Check "Enabled."

19. From the "Association" drop-down menu, select a type of associated record: Parent.

20. From the "Inclusion" drop-down menu, select an option:

• All -- include all columns in the export file.

• Only Selected-- in the "Fields" field, select one or more columns you want to export, in the sequence you want them appear in the export file.

• Except Selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

21. Repeat the above steps as needed to include more associated records. To remove an association, click the delete icon next to it.

Children section

To download child records joined to the orders:

22. Click add. A new row is displayed.

23. Check "Enabled."

24. From the "Child" drop-down menu, select a child record type.

25. From the "Inclusion" drop-down menu, select an option:

• All -- include all columns in the export file.

• Only Selected-- in the "Fields" field, select one or more columns you want to export, in the sequence you want them appear in the export file.

• Except Selected -- in the "Fields" field, select one or more columns you want to exclude from the export file.

26. Repeat the above steps as needed to include more associated records. To remove an association, click the delete icon next to it.

Finish

27. When finished defining the export, click save.

 

To view or edit an Export Definition:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Regions Exports." The "Regions Export Definitions" pop-up window is displayed and populated with a list of all Region Export Definitions.

2. From the "Action" column of the desired Export Definition, click the Edit icon. The "Edit Export" pop-up window is displayed.

3. Make any necessary changes to the Export Definition properties.

4. When finished, click save.

 

To manually execute an Export Definition:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Regions Exports." The "Regions Export Definitions" pop-up window is displayed and populated with a list of all Region Export Definitions.

2. From the "Action" column of the desired Export Definition, click the Enqueue this Export icon. A confirmation dialog box is displayed.

3. Click confirm.

 

To download the last execution of an Export Definition:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Regions Exports." The "Regions Export Definitions" pop-up window is displayed and populated with a list of all Region Export Definitions.

2. In the "Action" column of the desired Export Definition, click the Download File icon. The platform downloads the file to your PC.

 

To delete an Export Definition:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Regions Exports." The "Regions Export Definitions" pop-up window is displayed and populated with a list of all Region Export Definitions.

2. From the "Action" column of the desired Export Definition, click the Delete icon. A confirmation dialog box is displayed.

3. Click confirm.

 

To import Region records:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Import Regions." The "Create New Import - Region" pop-up window is displayed.

2. From the "Import Method" drop-down menu, identify how you want the platform to handle the import records:

• Insert data, or update if duplicate: Create new records and update existing records

• Insert data, or skip if duplicate: Create new records only (don't update existing records)

• Update data, or skip insert: Update existing records only (don't create new records)

3. In the "Find Options" field, select one or more fields used to identify existing records in the database. The default field is "name."

4. If you want to import blank values, select the "Yes" radio button next to "Include Blank Values."

5. The platform supports email and phone number syntax validation on the appropriate import fields. To run this validation, select the "Yes" radio button next to "Validate Records."

6. If you account is configured with business units, select the desired Business Unit from the "Business Unit" drop-down menu.

7. To send email notifications following a successful import, enter one or more recipient email addresses in the "Success Import Email Recipients" field.

8. To send email notifications following a failed import process, enter one or more recipient email addresses in the "Failed Import Email Recipients" field.

9. To select the import file, click choose file, then browse to and select the desired file.

10. Select a column separator: Comma or Semicolon.

Child Options

10. To upload "child" records along with the order record, click add child.

11. Select the child resource from the "Resource" drop-down menu.

12. In the "Find Options" field, select one or more fields used to identify existing records in the database.

13. If you want to skip the child record when the parent record is skipped, check "Skip with Parent."

14. Repeat the above steps as needed to define additional child records. To delete a child record, click delete.

Import Options

To configure additional import options:

15. Click add options.

16. To use a lookup table, select the desired table from the "Lookup table" drop-down menu.

17. From the "Lookup column" drop-down menu, select the desired column on the lookup table.

18. Enter a value in the "Rename as" field.

19. In the "Find by columns" field, select one or more columns used to identify existing records in the database.

20. If the lookup table is required, select the "Yes" radio button next to "Required."

21. If you want to stop the import process if a duplicate record is found, select the "Yes" radio button next to "Abort on Duplicate Record."

22. Optionally enter an expression in the "Condition" field.

Finish

23. When finished, click submit.

 

To view a list of previous Region imports:

1. From the "Actions" drop-down menu in the top-right corner of the screen, select "Regions Import List." The "Regions Import List" pop-up window is displayed and populated with a list of all previous Region imports. For each import, the screen displays the following:

• Imported by

• Filename

• Result (i.e., the number of records successfully imported, the number of failed records, and the number of skipped records)

• Created at

• Duration

• Status