​

Intro

Geocoder is a premium app that allows you to add geocoded data to any DataSet in your Domo instance. Select a DataSet, specify the address column, then set the update interval and method. The DataSet is then geocoded, and the results are written to a new DataSet.

---

Landing page

• Job list
• Usage meter

Create a new job Job Details view Overview tab

• Edit a job
• Delete a job
• Schedule tab
• History tab

Output DataSet

---

​

Landing Page

When you open the app, the landing page displays. The landing page includes a list of Geocoder jobs, a search bar, a usage meter, and controls to create a new job and refresh. When you select Refresh, the entire list of jobs refreshes with the latest details and statuses. See Creating a New Job for instructions for creating a new job.

​

Job List

The job list displays information about each existing job. This information includes the job’s name, creator, rows, input DataSet, output DataSet, last status update, and status. The following actions can be performed in the job list:

• Search for a job — Enter keywords into the search bar to filter the list by name.
• Change order of list — Select the F ilter Menu at the top of the list to change the sort order of the list.
• View/edit a job — Select a job in the list to view its details and make edits.

​

Usage Meter

On the landing page, the usage meter displays the limit of monthly individual geocoding requests and how many requests have been made in the current month. Each job creates multiple requests. If the monthly limit is reached, jobs continue running and the excess bill is calculated at the end of the period. Below the usage meter, you can see when your package limit resets. If you need to upgrade your limit, contact your Customer Success Manager (CSM).

​

Create a New Job

1. Select New Job at the bottom right corner of the landing page. The Save New Job modal displays.

2. Enter a custom name to identify this job in the Job name field.
3. In the Dataset field, search for the target DataSet by name. Then select the DataSet from the list of results.
4. In the Address column field, search for and select a column from within the target DataSet. The data in this column is what is geocoded when the job runs.

5. Select an update interval from the list of options. The options are detailed below.

• Manual — If you select Manual, you must run the job manually. It never runs automatically.
• Every hour — This option automatically runs the job every hour. If you want to restrict the window of time in which the job runs, select the Active hours checkbox to configure the start and end times. a
  
• Every day — This option automatically runs the job once a day, seven days a week. Use the Start between menu to select the time at which you want the job to run.

• Every weekday — This option automatically runs the job once a day, but only Monday through Friday. The same Start between criteria applies as with the Every day option above.
• Every week — This option automatically runs the job once a week. Use the On this day menu to select the day of the week on which you want the job to run. The same Start between criteria applies as with the Every day option above.
  
• Every month — This option automatically runs the job once a month on the same day(s) every month. The On this day menu allows you to select whether the job should run on the 1st, on the 1st and 15th, or on the last day of the month. The same Start between criteria applies as with the Every day option above.
  

6. Select an option from the Update method list. The options are described below:
   • Replace — If you select Replace, every time you run a job the data that was recorded in the output DataSet is deleted and the entire DataSet is replaced with new data.
   • Append — If you select Append, the whole input DataSet runs and any new rows are added to the end of the output DataSet.
     
7. Select Save to create the new job.

​

Job Details View

When you select a job from the list on the landing page, the job Details view displays. If the job has executed at least one time, the job Details view displays a link to the output DataSet for the job. Select Back to return to the landing page. In the job Details view, you can select Run Now to manually run the current job. Running the job adds an entry to its history, which you can view in the History tab. Select Delete Job to delete the current job. Admins can select Claim Ownership to claim ownership of the current job. This action is not reversible. A dialog displays to confirm the change of ownership. Select Cancel to cancel this action or Claim to proceed.

​

Overview Tab

In the Overview tab of the job Details view, a label indicates the last time the current job ran successfully. A full historical log of all the executions for the current job can be accessed in the History tab.

​

Edit a Job

In the Overview tab of the job Details view, the job owner can edit the job name, change the input DataSet, and update the address column. An app admin can view all jobs but needs to claim ownership of a job before being able to edit it.

​

Delete a Job

In the job Details view for a job, the job owner can delete the job by selecting Delete Job. An app admin can view all jobs but needs to claim ownership of a job before being able to delete it.

​

Schedule Tab

In the Schedule tab of the job Details view, you can edit the update interval for the job.

​

History Tab

In the History tab of the job Details view, you can access a historical log of the last 100 executions of the current job. You can view the following details for each entry:

• Started on
• Completed on
• Result
• Message

​

Output DataSet

The output DataSet appends the following columns of geocoded data to the original input DataSet:

Column	Description
_DCG_Status	The possible result of the geocoding process. Possible values include: OK ACCESS_NOT_CONFIGURED MAX_ELEMENTS_EXCEEDED NOT_FOUND ZERO_RESULTS OVER_DAILY_LIMIT OVER_QUERY_LIMIT REQUEST_DENIED INVALID_REQUEST UNKNOWN_ERROR
_DCG_Message	The resulting message of the geocoding process.
_DCG_From Cache	This field indicates whether we use the DOMO database result instead of the provider endpoint. TRUE for local results and FALSE for provider results.
_DCG_Place Id	Contains the unique ID for each result; a feature may have a commonly used identifier, either a unique string or number.
_DCG_Latitude	Contains the geocoded latitude. This field is typically one of the most important for normal address lookups.
_DCG_Longitude	Contains the geocoded longitude. This field is typically one of the most important for normal address lookups.
_DCG_Location Type	A list of feature types describing the feature. Most features have only one type, but if the feature has multiple types (for example, Vatican City is a country, region, and place), all applicable types are listed.
_DCG_Formatted Address	The house number for the returned address feature.
_DCG_Landmark	Specifies whether the feature is in the poi.landmark data type. This data type is deprecated, and this property is present on all poi features for backwards compatibility reasons but is always TRUE .
_DCG_Text	A string representing the feature in the requested language, if specified.
_DCG_Category	Comma-separated categories for the returned poi feature. Points of interest can include restaurants, stores, concert venues, parks, museums, and more.
_DCG_Neighborhood	Colloquial sub-city features often referred to in local parlance. Unlike locality features, these typically lack official status and may lack universally agreed-upon boundaries.
_DCG_Region	Top-level sub-national administrative features, such as states in the United States or provinces in Canada or China.
_DCG_Country	Limits results to one or more countries. Permitted values are country names separated by commas.
_DCG_Country Short Code	Limits results to one or more countries. Permitted values are ISO 3166 alpha 2 country codes separated by commas.
_DCG_Postcode	Postal codes used in country-specific national addressing systems.
_DCG_Place	Typically, these are cities, villages, municipalities, and so on. They’re usually features used in postal addressing, and are suitable for display in ambient end-user applications where current-location context is needed (for example, in weather displays).
_DCG_Place Name	Contains a detailed description of the place. Typically includes the city’s name and country, depending on the feature type.