GENWiki

Premier IT Outsourcing and Support Services within the UK

User Tools

Site Tools


ccm:data_import

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
ccm:data_import [2020/09/11 08:52]
genadmin [Filenames]
ccm:data_import [2020/09/11 08:59] (current)
genadmin
Line 1: Line 1:
 Our Import tool is fairly flexible but does have some specific requirements when supplying data to us. Please read the information below in its entirety. Our Import tool is fairly flexible but does have some specific requirements when supplying data to us. Please read the information below in its entirety.
  
-File format can be either CSV (where the separator need not be a comma) or XML with UTF-8 / ASCII encoding. +File format should be CSV with UTF-8 / ASCII encoding. 
-All lines within a CSV must have the same number of delimiters, and likewise all rows in an XML File must have the same number of attribute/value pairs. For CSV there should be a header row at row 1 (First Row) defining the column names for the rest of the file.+All lines within a CSV must have the same number of delimiters, There should NOT be a header row at the top of the file and if one is included it will be stripped.  
 + 
 +The actual names of the columns are for readability only but the column order must remain consistent. If you have not followed the standard format and subsequently wish to change the order and/or add/remove columns then this must first be communicated so we can make changes to the import process. 
 + 
 +Where a data element would contain the separator for CSV, a comma, it should be removed and not supplied.  
 + 
 +Some characters are prohibited regardless of quoting or escaping and those are defined below under Prohibited Characters
  
-The actual names of the columns are for readability only but the column order must remain consistent. If you wish to change the order and/or add/remove columns then this must first be communicated so we can make changes to the import process. Where a data element would contain either the separator for CSV or a reserved character for XML then it should be enclosed in double quotes (") or escaped respectively. Some characters are prohibited regardless of quoting or escaping and those are defined below under Prohibited Characters 
 The column data is defined below. Where data is not mandatory it can be optionally supplied, but if supplied must be valid. The column data is defined below. Where data is not mandatory it can be optionally supplied, but if supplied must be valid.
  
Line 57: Line 62:
  
 The Transfer Filename format should be identified and defined clearly so our import process knows what its looking to import. A good example would be vendorname_YYYYMMDD.csv. The Transfer Filename format should be identified and defined clearly so our import process knows what its looking to import. A good example would be vendorname_YYYYMMDD.csv.
 +
 +The FOLDER into which you upload the files is critical in determining the destination of the data on our systems so you must ensure data is loaded to the correct folder. 
  
 If you will be supplying multiple varying files then an example would be vendorname_filetype_YYYYMMDD.csv If you will be supplying multiple varying files then an example would be vendorname_filetype_YYYYMMDD.csv
Line 66: Line 73:
 When you have constructed a file in the format above and wish to begin the process of supply then the following should be observed. When you have constructed a file in the format above and wish to begin the process of supply then the following should be observed.
  
-The Transfer Method should be identified and defined. We can accept files provided to SFTP and we will setup a specific SFTP service for each data vendor.+The Transfer Method should be identified and defined. We can accept files provided to Secure FTP and we will setup a specific Secure FTP service for each data vendor. Our servers support SFTP, FTP, FTPS and WebDAV.
  
 The Transfer Schedule should be identified so we know how often to check for new data. The Transfer Schedule should be identified so we know how often to check for new data.
Line 74: Line 81:
 ===== Testing Phase ===== ===== Testing Phase =====
  
-A sample file should be supplied to the agreed SFTP using the agreed filename.+A sample file should be supplied to the agreed Secure FTP using the agreed filename.
  
 We will then code our import process to read this file and setup the mapping between columns and our database. We will validate each column as supplied and feedback. We will then code our import process to read this file and setup the mapping between columns and our database. We will validate each column as supplied and feedback.
  
-We will produce a data return based on this test file (if required) and deliver this to the SFTP where it can be collected and validated by the data vendor.+Import Notifications and Fallout can be advised by FTP or email and this will be setup as required.  
 + 
 +We will produce a data return based on this test file (if required) and deliver this to the Secure FTP where it can be collected and validated by the data vendor.
  
 The above process should be repeated as many times as necessary to ensure that both parties are confident that the process is correct. The above process should be repeated as many times as necessary to ensure that both parties are confident that the process is correct.
Line 84: Line 93:
 ===== Production Phase ===== ===== Production Phase =====
  
-Once testing is complete then we can begin live operations on a date mutually agreed upon. All test files/data should be purged from the SFTP and system before this date.+Once testing is complete then we can begin live operations on a date mutually agreed upon. All test files/data should be purged from the Secure FTP and system before this date.
  
 During the first week of live operation, log files should be examined to ensure no post testing issues have arisen. During the first week of live operation, log files should be examined to ensure no post testing issues have arisen.
/data/webs/external/dokuwiki/data/pages/ccm/data_import.txt · Last modified: 2020/09/11 08:59 by genadmin