Overview
Full Match job details can be viewed by clicking on a Match job name in the grid on the Match jobs page. The details displayed on the Match job Details page include the Last Execution Results, Match Outputs, basic Match job details, Match Review Results (if applicable), Match Lookup settings (if applicable), and associated Users.
Run a Match Job
Match jobs must be manually run and cannot be set to run automatically on a predetermined schedule. Basic results for the run of the Match job display on the header card at the top of the page, and additional details can be found in the Last Run Results card.
To run a Match job:
Verify you’re in the Match module of the Syniti Knowledge Platform.
Or
Select Match from the Home menu to navigate to the Match module of the Syniti Knowledge Platform.
Click on the link in the Name column of a Match job to navigate to the Match job Overview page.
Click the Run button at the top right corner of the Match job Overview page.
On the Import or Run Match Job dialog that displays, click the Run button to run the Match job or the Import and run button to import new table data and re-run the Match job.
Last Execution Results
The Last Execution Results card displays the results of the most recent run of the job. These results include:
Records Total—The total number of records present in the job.
Records Processed—The total number of records successfully processed by the job run.
Records Failed—The total number of records that failed to process with the job run.
Export a Match Job
The configuration details of a Match job can be exported for any Match job. This allows you to easily reuse common Match job settings by importing the resulting configuration file to create a new Match job.
To export a Match job:
Verify you’re in the Match module of the Syniti Knowledge Platform.
Or
Select Match from the Home menu to navigate to the Match module of the Syniti Knowledge Platform.
Click on the link in the Name column of a Match job to navigate to the Match job Overview page.
Click the More actions (…) button at the top right corner of the Match job Overview page.
Choose Export Job Configuration from the More actions menu. All configuration details for the Match job are exported as a ZIP file.
Refer to Import a Match Job for more details on importing Match jobs.
Review a Match Job
After a Match job has been run and if the Match Review Enabled option was turned on at the creation of the Match job, the results of the run are ready to be reviewed. The Match Review Results card displays the number of matched groups ready for review and the number of groups that have been reviewed and approved. Click the Go to Match review button on this card to review all results of the job run.
Refer to Reviewing Match Results for more details on the Match job review process.
Match Lookup
The Match Lookup feature provides a REST API that can be integrated into the user system(s) to allow users to perform interactive searches to determine if a given entity already exists in the data. Data can then be updated using Create, Update, and Delete (CRUD) methods. Objects are passed to and from the REST API in JSON format.
The Match Lookup feature is set on the Edit Match Job page. Refer to Match Job Settings for details.
To initiate the Match lookup, click the Initiate Match Lookup button on the Match Lookup card. This prepares the tables and indices required to support the lookup queries. The status on this card updates as the lookup runs.
Important!
If the Match lookup settings are edited after the initial Match lookup is initiated, you will need to initiate the Match lookup again. If the Initiate Match lookup button is not selected again after changing the settings, the previously generated keys will be used for the lookup.
Refer to Initiating Match Lookup for more details on utilizing this feature.
Details
The Details card displays an overview of creation and modification dates, as well as users who created and/or modified the job. This helps determine the business reason behind changes made to a job.
Note
This is not a full audit trail. Only the most recent modification date and user are displayed.
Match Outputs
The Match Outputs card displays the total number of groups, pairs, and records for the Match job. Use the Export icon to export the data for each respective output, or use the Export All icon at the top of the card to export the data for all outputs.
Match Job History
Match job history details can be viewed by clicking on the History tab of the Match Job Details page. These details include the status and record count of each job run. Record count references the number of records processed in the job run.
The job history grid can be filtered using the Filtered By panel. The following filter options are available:
Status— The current state of the job
Error— There was an error running the job and no results are available.
No Connection— There is an API Connection failure and the job cannot be run.
Pending— The job is queued to run.
Running— The job is actively running. Results are not yet available.
Success— The job was successfully processed and results are available.
Reset a Match Job
The Match job can be reset at any time following its initial execution. Resetting the job clears all stored data as if it has not been run before, and updates the job status to Reset. All associated tables are deleted, allowing for adjustments to table column mappings as needed.
To reset a Match job:
Verify you’re in the Match module of the Syniti Knowledge Platform.
Or
Select Match from the Home menu to navigate to the Match module of the Syniti Knowledge Platform.
Click on the link in the Name column of a Match job to navigate to the Match job Overview page.
Click the More options icon at the top right corner of the Match job Overview page and select the Reset Job Results menu option.
Click Continue on the Reset Job Results dialog that displays.
Note
Resetting a Match job causes any previously generated results for the job to be lost. This action cannot be reversed and the job must be run again to regenerate results.