Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
auto-import_data_feature [2019/09/24 18:10]
admin
auto-import_data_feature [2019/09/24 18:21] (current)
admin
Line 1: Line 1:
-====== ​  ​====== +The Auto-Import Feature in Control allows users to tie Control into other programs, such as web lead programs and external contact management. The SSLIP monitors a folder and when a file is placed into it uses Control'​s built-in import and mapping capabilities to try and import the data.
- +
-The Auto-Import Feature in Control allows users to tie Control into other programs, such as web lead programs and external contact management. The SSLIP monitors a folder and when a file is placed into it it uses Control'​s built in import and mapping capabilities to try and import the data.+
  
 The basic steps in the auto-import process are: The basic steps in the auto-import process are:
Line 14: Line 12:
  
 **Note**: The Auto-Import feature was released with Control 4.1. Map files created with earlier versions will not work with the auto-import feature. To update them, open the map files in Control and resave them. This will add the additional information needed for the Auto-Import feature to work. **Note**: The Auto-Import feature was released with Control 4.1. Map files created with earlier versions will not work with the auto-import feature. To update them, open the map files in Control and resave them. This will add the additional information needed for the Auto-Import feature to work.
 +\\ 
 +\\
 ===== Setting up the Folder Structure ===== ===== Setting up the Folder Structure =====
  
Line 26: Line 25:
  
 Under the **ImportHotFolder\Import**,​ create four additional folders: Under the **ImportHotFolder\Import**,​ create four additional folders:
- 
-{{http:​www.ecyrious.comcontrolimagesauto-import_folder_path.jpg?​nolink&​|www.ecyrious.comcontrolimagesauto-import_folder_path.jpg}} 
  
   * **C:​\Program Files\Cyrious\SSLIP\HotFolders\ImportHotFolder\Import\Maps**<​html><​div style="​margin-left:​ 20px;">​ This folder is where the map files (created in the next step) are stored. You can have multiple map files for different import sources as long as you keep the naming unique. </​div></​html>​   * **C:​\Program Files\Cyrious\SSLIP\HotFolders\ImportHotFolder\Import\Maps**<​html><​div style="​margin-left:​ 20px;">​ This folder is where the map files (created in the next step) are stored. You can have multiple map files for different import sources as long as you keep the naming unique. </​div></​html>​
Line 34: Line 31:
   * **C:​\Program Files\Cyrious\SSLIP\HotFolders\ImportHotFolder\Import\Failed**<​html><​div style="​margin-left:​ 20px;">​ Upon a failed import, the SSLIP will move the import file from the Import folder into the failed folder. An error message containing the problem will be placed in the llogs folder. </​div></​html>​   * **C:​\Program Files\Cyrious\SSLIP\HotFolders\ImportHotFolder\Import\Failed**<​html><​div style="​margin-left:​ 20px;">​ Upon a failed import, the SSLIP will move the import file from the Import folder into the failed folder. An error message containing the problem will be placed in the llogs folder. </​div></​html>​
 Copy the map file you created above to the Maps folder. During the auto-import process, the SSLIP will automatically look for all map files in the Maps folder. Copy the map file you created above to the Maps folder. During the auto-import process, the SSLIP will automatically look for all map files in the Maps folder.
 +\\ 
 +\\
 ===== Creating a Map File ===== ===== Creating a Map File =====
  
Line 43: Line 41:
 The map file name will need to match the import file so that the auto-import can associate the mapping. (This allows you to have multiple map files working simultaneously.) The mapping file name will be The map file name will need to match the import file so that the auto-import can associate the mapping. (This allows you to have multiple map files working simultaneously.) The mapping file name will be
  
-<​html><​div style="​margin-left:​ 20px;"> ​**.map**  ​</​div></​html>​+<​html><​div style="​margin-left:​ 20px;"> ​[[mapfile.map]] </​div></​html>​
  
 For customers, you might name the file Customer.map. If however, you have two different sources for customer imports, you might use more descriptive names like WebCustomers.map and POSCustomers.map. Under the importing data section, you will see that you must name the import file properly so the SSLIP will find the corresponding map file. For customers, you might name the file Customer.map. If however, you have two different sources for customer imports, you might use more descriptive names like WebCustomers.map and POSCustomers.map. Under the importing data section, you will see that you must name the import file properly so the SSLIP will find the corresponding map file.
Line 50: Line 48:
  
 C:\Program Files\Cyrious\SSLIP\HotFolders\ImportHotFolder\Import\Maps C:\Program Files\Cyrious\SSLIP\HotFolders\ImportHotFolder\Import\Maps
 +\\ 
 +\\
 ===== Setting up the SSLIP ===== ===== Setting up the SSLIP =====
  
Line 62: Line 61:
   - Save the setting.   - Save the setting.
   - Restart the SSLIP.   - Restart the SSLIP.
 +\\ 
 +\\
 ===== Importing Data ===== ===== Importing Data =====
  
 The SSLIP actively monitors the ImportHotFolder. If it finds a new file in the \Import folder, the SSLIP attempts to import the file. The processing that occurs depends upon the extension of the new file. The SSLIP actively monitors the ImportHotFolder. If it finds a new file in the \Import folder, the SSLIP attempts to import the file. The processing that occurs depends upon the extension of the new file.
 +\\ 
 +\\
 ==== TXT and CSV Files ==== ==== TXT and CSV Files ====
  
-Import files ending with .TXT are assumed to be tab-delimited files, whereas .CSV is the traditional ending for a commas-delimited ​files. (Regardless of the extentiontha actual file type must be specified by the map file).+Import files ending with .TXT are assumed to be tab-delimited files, whereas .CSV is the traditional ending for a commas-delimited ​file. (Regardless of the extensionthe actual file type must be specified by the map file).
  
 When a new TXT or CSV import file is places in the ImportHotFolder\Import folder, the SSLIP assumes the file has a corresponding map file and should be imported. The name of the file must also contain a caret and the name of the map file, as in: When a new TXT or CSV import file is places in the ImportHotFolder\Import folder, the SSLIP assumes the file has a corresponding map file and should be imported. The name of the file must also contain a caret and the name of the map file, as in:
  
-<​html><​div style="​margin-left:​ 20px;">​ ^.txt </​div></​html>​+<​html><​div style="​margin-left:​ 20px;"> ​[[xxxxxxx]]^[[mapfile]].txt </​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ ^.csv </​div></​html>​+<​html><​div style="​margin-left:​ 20px;"> ​[[xxxxxxx]]^[[mapfile]].csv </​div></​html>​
  
 where where
  
-<​html><​div style="​margin-left:​ 20px;">​ = a name given to the file </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[xxxxxxx]] ​= a name given to the file</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the name of the map file in the MAPS folder ​</​div></​html>​ +<​html><​div style="​margin-left:​ 20px;">​[[mapfile]] ​= the name of the map file in the MAPS folder (with an extension of .map)</​div></​html>​
- +
-(with an extension of .map)+
  
 +\\
 The SSLIP then looks for the map file by the name .map in the ImportHotFolder\Imports\Maps folder. If the map file can't be located, the import will fail and the SSLIP will generate a corresponding log file. If the map file is found, the appropriate files are loaded and the import begins. The SSLIP then looks for the map file by the name .map in the ImportHotFolder\Imports\Maps folder. If the map file can't be located, the import will fail and the SSLIP will generate a corresponding log file. If the map file is found, the appropriate files are loaded and the import begins.
  
 The SSLIP writes the results of the import to the Results Log. If there are any errors during the import process, the SSLIP writes these errors to the Error Log and cancels the import. The SSLIP writes the results of the import to the Results Log. If there are any errors during the import process, the SSLIP writes these errors to the Error Log and cancels the import.
 +\\ 
 +\\
 ==== XML Files ==== ==== XML Files ====
  
Line 94: Line 95:
  
 The SSLIP writes the results of the import to the Results Log. If there are any errors during the import process, the SSLIP writes these errors to the Error Log and cancels the import. The SSLIP writes the results of the import to the Results Log. If there are any errors during the import process, the SSLIP writes these errors to the Error Log and cancels the import.
 +\\ 
 +\\
 ==== TXTLINKS ==== ==== TXTLINKS ====
  
Line 101: Line 103:
 If the file ends with .TXTLINKS, the SSLIP assumes the file is a text document that contains the path to a map file and one or two import files. The contents of the files must conform to the following example: If the file ends with .TXTLINKS, the SSLIP assumes the file is a text document that contains the path to a map file and one or two import files. The contents of the files must conform to the following example:
  
-<​html><​div style="​margin-left:​ 20px;">​ \.link </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[mapfilepath]]\[[mapfile]].link</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ \.txt </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[filepathA]]\[[filenameA]].txt</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ \.txt </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[filepathB]]\[[filenameB]].txt</​div></​html>​
  
 where where
  
-<​html><​div style="​margin-left:​ 20px;">​ = the path of the map file. </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[mapfilepath]] ​= the path of the map file.</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the name of the map file. </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[mapfilename]] ​= the name of the map file.</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the path of the primary import file. </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[filepathA]] ​= the path of the primary import file.</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the name of the primary import file. </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[filenameA]] ​= the name of the primary import file.</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the path of the dependent import file. </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[filepathB]] ​= the path of the dependent import file.</​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the name of the dependent import file. </​div></​html>​+<​html><​div style="​margin-left:​ 20px;">​[[filenameB]] ​= the name of the dependent import file.</​div></​html>​
  
 The map file and first import file are required. The second import file, if specified, should be the dependent import file. An absolute path (like C:​\Temp\Cust.TXT) or a UNC path (like \\Server\\Import$\Cust.TXT) is acceptable, though the TXTLINKS file itself must be located in the ImportHotFolder. The map file and first import file are required. The second import file, if specified, should be the dependent import file. An absolute path (like C:​\Temp\Cust.TXT) or a UNC path (like \\Server\\Import$\Cust.TXT) is acceptable, though the TXTLINKS file itself must be located in the ImportHotFolder.
  
 The results and errors are logged normally. The results and errors are logged normally.
 +\\ 
 +\\
 ==== Other File Types ==== ==== Other File Types ====
- 
 The SSLIP ignores any other file types found in the ImportHotFolder. The SSLIP ignores any other file types found in the ImportHotFolder.
 +\\ 
 +\\
 ===== Result Logs ===== ===== Result Logs =====
- 
 During the import process, the results Control normally displays on screen are written into a log file located in the \LOGS folder. The file name of the log file is: During the import process, the results Control normally displays on screen are written into a log file located in the \LOGS folder. The file name of the log file is:
  
Line 143: Line 145:
 <​html><​div style="​margin-left:​ 20px;">​ dd = current day (01-31) </​div></​html>​ <​html><​div style="​margin-left:​ 20px;">​ dd = current day (01-31) </​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the file name of the import file </​div></​html>​+<​html><​div style="​margin-left:​ 20px;"> ​[[filename]] ​= the file name of the import file </​div></​html>​
  
 This file should be deleted by the application which generated the import file, or by the user at least monthly. This file should be deleted by the application which generated the import file, or by the user at least monthly.
 +\\ 
 +\\
 ===== Error Logs ===== ===== Error Logs =====
- 
 Because the SSLIP is an unmanned program, user intervention is not possible Any errors in the import process are written to an error log located in the \LOGS folder. The file name of the error file is: Because the SSLIP is an unmanned program, user intervention is not possible Any errors in the import process are written to an error log located in the \LOGS folder. The file name of the error file is:
  
Line 161: Line 163:
 <​html><​div style="​margin-left:​ 20px;">​ dd = current day (01-31) </​div></​html>​ <​html><​div style="​margin-left:​ 20px;">​ dd = current day (01-31) </​div></​html>​
  
-<​html><​div style="​margin-left:​ 20px;">​ = the file name of the import file </​div></​html>​+<​html><​div style="​margin-left:​ 20px;"> ​[[filename]] ​= the file name of the import file </​div></​html>​
  
 There are no warnings within Control, and it is up to the source of the import file to handle any errors. After processing the error, this file should be deleted by the application which generated the import file, or by the user at least monthly. There are no warnings within Control, and it is up to the source of the import file to handle any errors. After processing the error, this file should be deleted by the application which generated the import file, or by the user at least monthly.
 +\\ 
 +\\
 ===== Removing the Import Files ===== ===== Removing the Import Files =====
- 
 After the import, the imported file is moved out of the ImportHotFolder. This keeps the import folder free of processed items. For TXTLINKS files, the TXTLINKS file is moved but the referenced data files are not. After the import, the imported file is moved out of the ImportHotFolder. This keeps the import folder free of processed items. For TXTLINKS files, the TXTLINKS file is moved but the referenced data files are not.
  
-If the import was successful, the file is moved into the **ImportHotFolder\Completed** ​ folder. If the import generated an error, the import is cancelled ​and the file is moved to the **ImportHotFolder\Failed** ​ folder.+If the import was successful, the file is moved into the **ImportHotFolder\Completed** ​ folder. If the import generated an error, the import is canceled ​and the file is moved to the **ImportHotFolder\Failed** ​ folder.
  
 Periodically,​ you will want to remove the old import files from these folders. Periodically,​ you will want to remove the old import files from these folders.