Data File Templates

This topic describes how to create a new Data File Template. Data File Templates can also be created from the New Item screen (see Create a New Item: Data File Template for more details).

To create a new Data File Template through the Data File Template screen:

1. In the Tool Ribbon, click + new Data File Template.

2. A "New Item" pop-up window is displayed. To select the folder where you want to save this new Data File Template, click the folder name in the Navigation Tree on the left side of this pop-up. The "Where?" field is updated with the selected folder name.

3. In the "Name" field, enter a name for your new Data File Template. This name must be unique within the selected folder.

4. From the "Data Source" drop-down menu, select the source table for this Data File Template.

Note: You can never modify this source table after the Data File Template is created.

5. Click save new item. The Workspace is refreshed to show a blank Data File Template details screen.

6. If you want your output file to contain a header row, place a check mark in the "Header" check box. If not, then uncheck this check box (the "Header" check box is checked by default).

7. The next step is to define the columns that make up your Data File Template. Messaging offers two methods for defining these columns:

   Add One Column at a TimeAdd One Column at a Time

   1. Click add new column. The "Data File Column" pop-up window is displayed.

   2. The "Data Source" drop-down menu is populated with the following sections:

      • Custom Column: This section allows you to define a custom column "on-the-fly," rather than selecting an existing column. From this section, you can pick either:

      • • Dynamic Block: Select this option if you want to use logic, or business rules, within a Dynamic Block to determine the value in this custom column. If you select this option, the system displays the "Browse Dynamic Blocks" pop-up window so you can select the desired Dynamic Block.  

        • Static value: Select this option if you want to provide a static value that the system will use to populate this custom column.  

      • Data Source Fields: This section contains all of the fields on the source table.  

      • Table Joins: This section contains all of the system joins that have been defined for the source table. If you select one of these joins, you'll be able to pick a field from the joined table.

      • Campaign Fields: This section contains system-generated campaign fields, such as the Campaign ID.

      • Metadata Fields: This section contains all of the Metadata fields defined for this account.

      • System Fields: This section contains system-generated fields, such as the Primary Key ID (PKID).

   3. By default, the "Header" field is populated with the name of the selected field. This value will appear within the header row for this column. Optionally, you can override this value and enter a different Header value. Note: If you selected either of the Custom Column options, the "Header" field is blank, and you'll need to provide a Header name.

   4. The "Value" field is disabled unless you selected "Static value," in which case you'll need to enter the desired value here.

   5. Optionally, enter a default value in the "Default" field. Note: the "Default" field is not displayed if you selected either of the Custom Column options.

   6. Optionally, select a formatting mask from the "Formatter" drop-down menu. The formatting mask is used to control the appearance of the value in this field. For example, you can format date fields as "mm/dd/yyyy." The system includes formatting masks for dollar amounts, dates, numbers, and URLs. You can also use a formatting mask to truncate or encode the field value. Note: the "Formatter" menu is not displayed if you selected either of the Custom Column options.

   7. Click save column. The system closes the "Data File Column" pop-up window. The new field is added to the end of the Data File Template.

    

   Add Multiple ColumnsAdd Multiple Columns

   1. Click add multiple column. The "Add Multiple Data File Columns" pop-up window is displayed.

   2. The "Select Fields" list box is populated with all of the fields on the source table, and all of the Metadata fields defined for this system. From this list box, select one or more fields (use Shift + Click or Control + Click to select multiple fields).

   3. Click add columns. The system closes the "Add Multiple Data File Columns" pop-up window. The new fields are added to the end of the Data File Template.

   Note: When you use the "Add Multiple Columns" feature, the system applies certain default settings to each new field. The system will automatically use the field name as the header, the "default" value will be blank, and the system will not apply a formatting option. If you need to modify any of these settings for a specific field, click the edit button (pen icon) for that field.

    

8. By default, new fields are added at the end of the Data File Template. If you need to rearrange the field sequence, click on the grey section to the left of the field, and drag it to its new location. You can also reorder the fields using the "Col #" text field. Next to the desired field, type in a new column position. The system highlights this column in green to indicate that its position has been modified. Repeat this process as needed, then click Edit > Actions > Save in the Tool Ribbon to apply the changes.  

9. If you need to remove a field, click the remove button ("X" icon). The field is grayed-out to indicate that it's been marked for deletion. To complete the removal, click Edit > Actions > Save in the Tool Ribbon.

10. If you need to edit the properties for a field, click the edit button (pen icon). The "Data File Column" pop-up window is displayed. Make any necessary changes, then click save column.

11. Optionally, you can assign one or more tags to your Data File Template. To assign a tag, click on the "Add tag" field in the Edit > Tags section of the Tool Ribbon. The system displays a pop-up menu of all the existing tags. You can select one of these tags, or type in a new one and press Enter. You can repeat this process to add more tags. To remove a tag, click the "X" icon next to the tag label.  

12. When finished, click Save in the Tool Ribbon.

13. Optionally, to preview your Data File Template, click Edit >  Preview in the Tool Ribbon. The system displays a grid showing each column that you added to the Data File Template. The Dynamic Panel on the right-hand side of the screen lists all of the fields. To test how a value appears within a field, enter a value in the field within the Dynamic Panel, then click the refresh button (double-arrow icon). The system refreshes the preview screen, and populates that field with your test value. When finished, click Edit to return to the main edit screen.

 

To copy an existing item to use as the basis for a new item:

1. Search for the desired item (see Search for an Item for more details).

2. Click on the item name. The main item screen is displayed and populated with the details of the selected item.

3. In the Tool Ribbon, click Edit > Save As. A "Save as" dialog box is displayed.

4. Enter a name for the new item.

5. By default, the new item will be saved in the same folder location as the base item. Optionally, click the magnifying glass icon to browse to and select a different folder location.

6. Click save a copy. The system creates a copy of the selected item.

 

 

To view or edit an existing Data File Template:

1. Search for the desired Data File Template (see Search for an Item for more details on the available search methods).

2. Click on the Data File Template name. The Data File Template screen is displayed and populated with the details of the selected Data File Template.

3. Optionally, to view detailed information about the Data File Template, click the Item Details tab in the Tool Ribbon. The Item Details screen is displayed, showing who created the item, who modified it last, and what the last actions taken on the item were. On this screen, click Related Items in the Function Menu to see other items in the system that reference or utilize this Data File Template. When finished, click the Edit tab in the Tool Ribbon to return to the main edit screen.

4. Optionally, you can assign one or more tags to your Data File Template. To assign a tag, click on the Add tag field in the Tool Ribbon. The system displays a pop-up menu of all the existing tags. You can select one of these tags, or type in a new one and press Enter. You can repeat this process to add more tags. To remove a tag, click the "X" icon next to the tag label.  

5. Optionally, to rename the Data File Template, click Rename in the Tool Ribbon. A "Rename Item" dialog box is displayed. Enter a new name for the Data File Template, then click save new name.

6. Make any necessary changes to the Data File Template:

   • Add one or more new fields (see "Create a New Data File Template" above for details on how to create a new field).  

   • If you need to rearrange the field sequence, click on the grey section to the left of the field, and drag it to its new location. You can also reorder the fields using the "Col #" text field. Next to the desired field, type in a new column position. The system highlights this column in green to indicate that its position has been modified. Repeat this process as needed, then click Save in the Tool Ribbon to apply the changes.

   • If you need to remove a field, click the remove button ("X" icon). The field is grayed-out to indicate that it's been marked for deletion. To complete the removal, Save in the Tool Ribbon.

   • If you need to edit the field properties, click the edit button (pen icon). The "Data File Column" pop-up window is displayed. Make any necessary changes, then click save column.

7. To save your changes, click Save in the Tool Ribbon.

 

To delete an item:

1. Search for the desired item (see Search for an Item for more details).

2. Click on the item name. The main item screen is displayed and populated with the details of the selected item.

3. In the Tool Ribbon, click Delete. A confirmation dialog box is displayed.

4. Click delete item to confirm the deletion.

Foldered items are moved to the Recycle Bin. Non-foldered items are permanently deleted.

 

Once you've created your Data File Template, you can use it within a Campaign by assigning it as the "Content Source" for that Campaign.

To change the Campaign's primary Content Source to use a Data File Template:

1. Navigate to the desired Campaign (see Campaigns for more details).

2. Scroll down to the "Message" section, and click change. The "Choose Content Source" pop-up window is displayed.

3. Click data file template. The "Browse Data File Templates" pop-up window is displayed.

4. From the "Browse Data File Templates" pop-up window, you can click on a folder in the directory structure to see a list of all the Data File Templates stored within that Folder. Or, if you want to search across the entire system, click the double-left arrow icon near the top of the directory structure; the system collapses the directory structure and shows every Data File Template in the system. This pop-up window also allows you to search based on Tags, or by Data File Template name. When you find the desired Data File Template, click on its name.

Note: Data File Templates have to be created using the same source table as the Campaign in order for them to be available as a selection.

5. The Content section is refreshed to show the name of the selected Data File Template.