Generic Adaptor (1.0) Missing Dataset Product Field Data Report

Please make sure you understand what the Connector's Data feature is, what CSV spreadsheet files are, and have read the following linked documents before proceeding on.

The Missing Data Set Product Field Data Report routine will query a specified Connector Data Set SQLite database file and generate a CSV spreadsheet file that contains a list of products that are missing data for at least one of the included fields. It will save the report's generated report spreadsheet file to a specified location on the file system, allowing it to be access by Windows users to view and modify using any spreadsheet application (such as Microsoft Excel, or Libre Office Calc). Optionally the routine can email out the report to a nominated list of email addresses, with the email containing a summary of product field counts that are missing data. In the email it will also attach the report's spreadsheet file. This allows data maintainers to receive the report, either on a scheduled or once off basis when the routine is run.

For this routine to be effective it requires product data to be be set up or imported into a Data Set via an adaptor's Products data export. The product fields that the routine looks can be managed through the use of the routine's Data Fields. The routine also allows for highly customised conditions to be set within the routine's Data Fields, allowing highly customised checks to be made with each product, such as checking that a product is a assigned to a category, image, or attachment, among many other examples. This is done by adding routine data fields for product field that needs to be checked. Either the product's existing fields can be selected, or customised SQL queries can be written, such to check if a product has any images or categories assigned to it, among many other examples.

A number of settings can be configured for the routine. This includes settings that control how the CSV spreadsheet file's data is formatted, as well as settings to control if the routine should only look at active and/or updated products. It also includes settings that control if the routine should email out the report, and details of the email.

When the routine is run, if the DEBUG logging is set to show within the Connector's message logs, then it will show a summary of counts of each field that contains missing data, as too will the email notification if it is set to be sent out.

Routine steps:

1. Get the list of the routine's active data fields that contain a value source field.
2. Build the SQL database query that will check for the different product data that is missing.
3. Check that the Data Set's SQLite database file exists.
4. Connect to the Data Set's SQLite database file and execute the SQL query to generate the report data
5. Build the spreadsheet CSV file data with the report's generated data.
6. Save the report's CSV spreadsheet file to the filesystem at the specified location and file name.
7. Output the summary of missing product field data into the Connector's message log.
8. If the routine is set to send out an email notification then generate the contents of the email message, and attach the spreadsheet CSV file to the email message.
9. Send out the email report to the recipient email address, using the SMTP settings of the adaptor that is running the routine.
10. Log the outcome of sending the email notification within the Connector's message logs.

1. Open up the Connector application.
2. In the Adaptors and Messages tab, Under the Adaptors section, click on the Settings button against a listed Generic adaptor.
3. Click on the Data Routines tab.
4. In the Routine Type drop down, select the Missing Dataset Product Field Data option, then click the Create Routine button.
5. In the Routine Code text box enter a name for the routine, then press the Save Routine button.

A new routine will be created for the adaptor and appear in the Routines drop down.

1. Click on the Settings tab of the routines.
2. For each row in the settings table, click on the Setting Value field.
3. Enter a setting value, then click to the next row. The setting will automatically save once the cursor exits the field.
4. Click on the Data Fields tab.
5. Click on the Add Field button to add a data field to the routine for each product field that needs to be checked for missing data.
   1. Within Source Field column set the value of the argument. If the value contain spaces then wrap the value with double quote characters.

Notes:

• In the Routine Settings section below describes what each of the settings does. Use this to configure the routine or read the settings documentation below.
• If a red icon appears in the routine table's Setting Value cell, then the cell does not accept the given input. You will need to change the value in the cell to be valid.

Below are the settings that can be configured for the routine.

Listed below are a majority of the messages that are generated by the routine, either through the connector logs, or in the sent email notification.