Data Integration Module (DIM) Sample Project Walkthrough Guide (CSV Output)

Data Integration Module (DIM) Sample Project Walkthrough Guide (CSV Output)

Overview

This document walks through the setup of a CSV output Sample Project in the Field2Base Data Integration Module (DIM) software. 



Reference Files & Folder Setup 

Note: This document assumes you have already installed the latest version of the DIM software and are ready to setup your first DIM Project. 

Files to Download 

1. Save the Form in the Local Folder for use in this walkthrough. 
  • Save the Sample Form to the My Forms folder (or My Documents if Forms Designer is not installed) 
Note: This document assumes you have Administrative privileges to create new folders on the PC running the DIM otherwise you will not be able to proceed on from this step. 
2.  Create a new folder on your hard drive for outputting the resulting CSV files generated by this walkthrough: 
  • Create a folder named “Form Output” on the Local (C:) Drive


Load the Sample Form 

The first step in the process is to load the Sample Form into the DIM’s Forms folder. 

  • Go to the F2B Data Integration Module Program Folder in the Start Menu  
  • Open the DIM Project Manager 
  • Go to the File menu 
  • Select Load Forms 



  • Select the Form using the Windows Explorer Browser 


Create the Sample Data Integration Module Project 

The next step is to actually create the Sample Project from the Sample Form provided. 

  • The Project Manager will open with No Project Loaded 


  • Open the File Menu 
  • Select “New” 


Load the eForm for the Sample Project 

  • The Open Form screen will appear 
  • Select the “Customer_Introduction_Sample.eform” 


  • Click the Open Button 

 


Set the Initial Transform Type for the Project 

  • The Initial Transform Type Selection screen will open 
  • Select the CSV option 
  • Click the OK button 

 


Set the CSV Transformation Type for the Sample Project 

1. The CSV Transformation Type screen will open 
2. Click the Browse button 
3. Select the Forms Output folder created earlier (C:\Forms Output)

4. Type in “output.csv” in the Output Filename entry box 

5. Click the Enable Column Headers checkbox 
6. Type in the following lines in the entry box for Column Headers: 
  1. Name
  2. Contact
  3. Industry
  4. Description
  5. Tablets
  6. Use
  7. Notes
7. Click the OK button



Setting up Mappings in the Project 

Using the Project Manager, you will need to map each Region to the correct column. 

1. Select Row 1 in the Data Transformations section on the right side of the screen


2. Select the Name Column in the Mapped Values section in the center of the screen 


3. Drag and Drop the CompanyName Region onto the Drag and Drop Region Here section


4. Repeat the Column-Region mapping using the following pairs: 
  1. Contact column – CompanyContact Region
  2. Industry column – CompanyIndustry Region
  3. Description column – CompanyDescription Region
  4. Tablets column – NumberOfTablets Region
  5. Use column – F2BUse Region
  6. Notes column – Notes Region 
5. At the conclusion, you should see a resulting output like below:


6. Open the File Menu 
7. Click Save 
 


Enabling the Project for Processing 

Once the Region assignment is complete, the Project needs to be enabled so that the DIM service will download Jobs and start processing. 

1. Click on the Project Disabled button near the File Menu


2. Open the File Menu 
3. Click Save 

You will now see it set to Project Enabled and doing so will load the Project into use when the DIM service is started (or restarted if the service is already running). 

 

4. Start (or restart) the DIM Service using the Administrator Utility. 

  • Go to the F2B Data Integration Module Program Folder in the Start Menu 
  • Select the DIM Admin 
  • Go to the Service tab 
  • Click the Start button 

 

NOTE: If you already have the DIM service running already, you will need to restart the DIM service and you will choose the Restart button instead. 


Create a Condition in an Additional Transformation (optional)

This section describes how to create an additional Transformation to show how to set up a Condition within a Project. 

The Condition will be set on the Number of Tablets entered in the Form. If there are more than 25 Tablets, then the Job’s Form Data will be outputted to a second CSV file. 

This CSV Transformation will not use Column Headers so that the difference can be illustrated. 

1. Click on the CSV button in the Data Transformation Menu 
 

2. The CSV Transformation Type screen will open 
3. Click the Browse button 
4. Select the Forms Output folder created earlier (C:\Forms Output) 
 

5. Type in “largeorders.csv” in the Output Filename entry box 
 

6. Type “3” in the Number of Columns entry box 
7. Click the OK button 
 

8. Select Row 1 in the 2nd CSV block shown in the Data Transformations section on the right side of the screen 
 

9. Select Column 1 in the Mapped Values section in the center of the screen 


10. Drag and Drop the CompanyName Region onto the Drag and Drop Region Here section 


11. Repeat this Column-Region mapping using the following pairs:
  1. Column 2 – Industry Region
  2. Column 3 – NumberOfTablets Region 
12. Select the Condition entry box below the Mapping section in the center of the screen 

13. Drag and Drop the NumberOfTablets Region onto the Drag and Drop Here section
 

14. Click on the Condition entry box again after the “{Page1@NumberOfTablets}” 
15. Type in “> 25” 


16. Click on the Save option in the Quick Access Menu 

The Conditional has now been applied for this Transformation and will only generate a CSV file when the Number of Tablets is over 25 once the service has been restarted. 


    • Popular Articles

    • Forms Designer Quick Start Guide

      Overview Field2Base Forms Designer is the proprietary software application that allows your existing paper forms to be quickly converted to a smart E-form available to your end users via our mobile and web-based Mobile Forms applications. This ...
    • Portal 11.28.2023 Release Notes

      Overview Our release notes offer brief descriptions of product enhancements and bug fixes. We include links to the current articles for any affected features. Those articles will be updated shortly after the Portal release to include new ...
    • Integration Service Configuration Guide

      How To Configure Integration Services To Allow Read/Write Access on a Network Path All of our Integration Products, including the DIM, DUU, and EDM have respective Windows Services responsible for communicating with our server. Occassionally, ...
    • Data Integration Module (DIM) Migration Guide

      Overview This article provides the information necessary to migrate the Field2Base Data Integration Module (DIM) over from one server to another. Please refer to the DIM Install Guide for the initial installation of the Field2Base DIM. Once that's ...
    • How to Check the Version of Integration Products Running on a Windows 10 Machine

      Right-click on the Start menu button. Click on Apps & Features. In the Apps & Features search bar type in the Integration Product you are looking for, eg. F2B Data Integration Module, F2B Data Upload, or F2B Enterprise Dispatch Module. Click to ...