Difference between revisions of "Unison:Address Object Tutorial"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with "{{MelissaDQNav |IntroductionCollapse= }} {{CustomTOC}} The following steps will guide you in the basic usage of Address Object in MelissaDQ. ==Login== You must first enter...")
 
Line 11: Line 11:
You must first enter your login credentials at the login page.
You must first enter your login credentials at the login page.


[[File:.png|link=]]
[[File:MDQ_Login.png|link=]]




Line 17: Line 17:
To start a new project, first click '''Projects''', then click '''New'''. Enter a name for your project here. This name can be changed later.
To start a new project, first click '''Projects''', then click '''New'''. Enter a name for your project here. This name can be changed later.


[[File:.png|link=]]
[[File:MDQ_Projects_Menu.png|link=]]
 
[[File:MDQ_Projects_NameProject.png|link=]]




Line 23: Line 25:
Then select a source for your new project. In this instance I'll use a file as a source.
Then select a source for your new project. In this instance I'll use a file as a source.


[[File:.png|link=]]
[[File:MDQ_Projects_SourceSelect.png|link=]]


After clicking '''File''', navigate to your desired file to upload it.
After clicking '''File''', navigate to your desired file to upload it.
Line 30: Line 32:
Once the file is uploaded, the '''Input File Preview''' window will open. Here you can preview how your file will be used. You can change the delimiter, enclosure, select if your file includes a header row, and specify which fields to use.
Once the file is uploaded, the '''Input File Preview''' window will open. Here you can preview how your file will be used. You can change the delimiter, enclosure, select if your file includes a header row, and specify which fields to use.


[[File:.png|link=]]
[[File:MDQ_Projects_InputFilePreview.png|link=]]


Once you save your choices from the preview, you'll be sent to the '''Project Configuration''' screen.
Once you save your choices from the preview, you'll be sent to the '''Project Configuration''' screen.
Line 38: Line 40:
Then select which service you want to use on your data. Here we'll use '''Address Object'''.
Then select which service you want to use on your data. Here we'll use '''Address Object'''.


[[File:.png|link=]]
[[File:MDQ_Projects_Services.png|link=]]




Line 45: Line 47:
Select which fields to use as input and how they map. Clicking on a field will open a drop-down menu with a list of available fields from your input file.
Select which fields to use as input and how they map. Clicking on a field will open a drop-down menu with a list of available fields from your input file.


[[File:.png|link=]]
[[File:MDQ_Address_Input.png|link=]]




Line 51: Line 53:
You can also control your output fields. Clicking the rollout arrow will show the default output fields. Here you can choose which fields to output, and optionally rename the fields.
You can also control your output fields. Clicking the rollout arrow will show the default output fields. Here you can choose which fields to output, and optionally rename the fields.


[[File:.png|link=]]
[[File:MDQ_Address_Output.png|link=]]




If you click the '''Settings''' icon next to the output fields this will open the '''Service Settings''' dialog. Here you can set service-specific settings.
If you click the '''Settings''' icon next to the output fields this will open the '''Service Settings''' dialog. Here you can set service-specific settings.


[[File:.png|link=]]
[[File:MDQ_Address_ServiceSettings.png|link=]]


Once you save your choices from the output fields, you'll be sent to the '''Project Configuration''' screen.
Once you save your choices from the output fields, you'll be sent to the '''Project Configuration''' screen.
Line 64: Line 66:
Now click '''Add an Output''' to select your '''Outputs'''. Here you can choose to write to file or to table. Here we'll write to a file. Enter a file name and then select your enclosure and delimiter. You can also choose your compression method, to append a timestamp, or include the header.
Now click '''Add an Output''' to select your '''Outputs'''. Here you can choose to write to file or to table. Here we'll write to a file. Enter a file name and then select your enclosure and delimiter. You can also choose your compression method, to append a timestamp, or include the header.


[[File:.png|link=]]
[[File:MDQ_Projects_OutputConfigurationWrite.png|link=]]


===Filter===
===Filter===
To get specific data from your file you can use a filter. This will filter your resulting data, using the result codes of the records to limit your results. For example, selecting the '''Full Address Matches (USPS)''' filter shows that any records with an '''AS01''' result code will be output.
To get specific data from your file you can use a filter. This will filter your resulting data, using the result codes of the records to limit your results. For example, selecting the '''Full Address Matches (USPS)''' filter shows that any records with an '''AS01''' result code will be output.


[[File:.png|link=]]
[[File:MDQ_Projects_OutputFilter.png|link=]]


===Output Fields===
===Output Fields===
Clicking the rollout arrow next to '''Output Fields''' will show the default output fields and their order. You can delete unwanted fields from your output by clicking the trashcan icon next to each field. You can also re-order your fields by drag and drop.
Clicking the rollout arrow next to '''Output Fields''' will show the default output fields and their order. You can delete unwanted fields from your output by clicking the trashcan icon next to each field. You can also re-order your fields by drag and drop.


[[File:.png|link=]]
[[File:MDQ_Projects_OutputFields.png|link=]]
 


==Run/Schedule Project==
==Run/Schedule Project==
Line 80: Line 83:


===Run Now===
===Run Now===
[[File:.png|link=]] - run button
[[File:MDQ_Projects_RunButton.png|link=]]


If you click the '''Run Now''' button on the top right corner of the '''Project Configuration''' window, your project will begin processing immediately.
If you click the '''Run Now''' button on the top right corner of the '''Project Configuration''' window, your project will begin processing immediately.


===Schedule===
===Schedule===
[[File:.png|link=]] - schedule button
[[File:MDQ_Projects_ScheduleButton.png|link=]]


To schedule your project, click the '''Schedule''' button on the top right corner of the '''Project Configuration''' window.
To schedule your project, click the '''Schedule''' button on the top right corner of the '''Project Configuration''' window.


[[File:.png|link=]] - schedule window
[[File:MDQ_Projects_Schedule.png|link=]]


In the '''Schedule Project Execution''' window, enter a description of your scheduled project, a frequency of execution, a start date, and a start time.
In the '''Schedule Project Execution''' window, enter a description of your scheduled project, a frequency of execution, a start date, and a start time.
Line 96: Line 99:
==Job Status==
==Job Status==
Once a job has started, you can check the job status to view it's state, number of rows processed, time elapsed, date started, and date completed.
Once a job has started, you can check the job status to view it's state, number of rows processed, time elapsed, date started, and date completed.
[[File:MDQ_Jobs_Menu.png|link=]]
[[File:MDQ_Jobs_Status.png|link=]]


===Output Files===
===Output Files===
When the job has completed, you can also view any output files generated. You can either view it by clicking the view button or download it by clicking the download button.
When the job has completed, you can also view any output files generated. You can either view it by clicking the view button or download it by clicking the download button.


[[File:.png|link=]] - view/download button
[[File:MDQ_Files_Main.png|link=]]




Line 106: Line 113:
A completed job will also have detailed reports. These will depend on which service you use and display generated result codes. These codes will detail the overall status of your project, changes made to the data, and any errors encountered.
A completed job will also have detailed reports. These will depend on which service you use and display generated result codes. These codes will detail the overall status of your project, changes made to the data, and any errors encountered.


[[File:.png|link=]] - detailed reports
[[File:MDQ_Reports_Main.png|link=]]
 




[[Category:MelissaDQ]]
[[Category:MelissaDQ]]

Revision as of 18:28, 21 February 2018

Template:MelissaDQNav



The following steps will guide you in the basic usage of Address Object in MelissaDQ.

Login

You must first enter your login credentials at the login page.

MDQ Login.png


New Project

To start a new project, first click Projects, then click New. Enter a name for your project here. This name can be changed later.

MDQ Projects Menu.png

MDQ Projects NameProject.png


Add Source

Then select a source for your new project. In this instance I'll use a file as a source.

MDQ Projects SourceSelect.png

After clicking File, navigate to your desired file to upload it.

Input File Preview

Once the file is uploaded, the Input File Preview window will open. Here you can preview how your file will be used. You can change the delimiter, enclosure, select if your file includes a header row, and specify which fields to use.

MDQ Projects InputFilePreview.png

Once you save your choices from the preview, you'll be sent to the Project Configuration screen.


Select Service

Then select which service you want to use on your data. Here we'll use Address Object.

MDQ Projects Services.png


Address Object

Input Fields

Select which fields to use as input and how they map. Clicking on a field will open a drop-down menu with a list of available fields from your input file.

MDQ Address Input.png


Output Fields

You can also control your output fields. Clicking the rollout arrow will show the default output fields. Here you can choose which fields to output, and optionally rename the fields.

MDQ Address Output.png


If you click the Settings icon next to the output fields this will open the Service Settings dialog. Here you can set service-specific settings.

MDQ Address ServiceSettings.png

Once you save your choices from the output fields, you'll be sent to the Project Configuration screen.


Outputs

Now click Add an Output to select your Outputs. Here you can choose to write to file or to table. Here we'll write to a file. Enter a file name and then select your enclosure and delimiter. You can also choose your compression method, to append a timestamp, or include the header.

MDQ Projects OutputConfigurationWrite.png

Filter

To get specific data from your file you can use a filter. This will filter your resulting data, using the result codes of the records to limit your results. For example, selecting the Full Address Matches (USPS) filter shows that any records with an AS01 result code will be output.

MDQ Projects OutputFilter.png

Output Fields

Clicking the rollout arrow next to Output Fields will show the default output fields and their order. You can delete unwanted fields from your output by clicking the trashcan icon next to each field. You can also re-order your fields by drag and drop.

MDQ Projects OutputFields.png


Run/Schedule Project

The project is now ready to be run or scheduled.

Run Now

MDQ Projects RunButton.png

If you click the Run Now button on the top right corner of the Project Configuration window, your project will begin processing immediately.

Schedule

MDQ Projects ScheduleButton.png

To schedule your project, click the Schedule button on the top right corner of the Project Configuration window.

MDQ Projects Schedule.png

In the Schedule Project Execution window, enter a description of your scheduled project, a frequency of execution, a start date, and a start time.


Job Status

Once a job has started, you can check the job status to view it's state, number of rows processed, time elapsed, date started, and date completed.

MDQ Jobs Menu.png

MDQ Jobs Status.png

Output Files

When the job has completed, you can also view any output files generated. You can either view it by clicking the view button or download it by clicking the download button.

MDQ Files Main.png


Detailed Reports

A completed job will also have detailed reports. These will depend on which service you use and display generated result codes. These codes will detail the overall status of your project, changes made to the data, and any errors encountered.

MDQ Reports Main.png