Basic walkthrough |
Scenario: Suppose that you need a template to get a listing of all of your organization's markers (defined locations) that are in Ohio. Because you are only reading the information (which TDE calls "retrieve"), you do not need to work with external input files.
This walk-through gives an overview of the tasks you would need to complete in order to create this integration.
Note |
---|
Only built-in template capabilities are covered here; far more sophisticated data processing is possible through template scripting. |
This topic contains the following sections:
The first step to creating your integration is to determine what data you need to retrieve from which logical Tables; usually, you only need a subset of all of the columns that are available. Start by analyzing which table you need to work with, and then which of the columns in that table you need to export.
For this scenario, you would identify the Marker table, and then you would make note of which columns you want to export:
Now you can now open your favorite text editor and begin drafting the contents of the template. The template itself follows the simple text format of an INI configuration file: a collection of name/value pairs, which are grouped into a few sections.
You begin by writing the [Template] section, which declares four required items: the template version, the target table, the template name, the template type ("intent"):
[Template] TemplateVersion = 1.0 TableID = Marker-1.0 TemplateName = GetMarkerByState Intent = Retrieve
Tips
The [Filter] section lets you restrict which items TDE retrieves for you. You can filter by these criteria:
Between(lower, upper)
Contains(value)
ContainsAny([array of values])
Equals(value)
GreaterThan(value)
In([array of values])
NotEquals(value)
[Filter] Region = Equals("Ohio")
To finish your template, add each of the columns you want to export to the one-to-one mappings of fields to columns:
[Output] CityName = Input.City Label = Input.Tag # Tag is the TDE column; Label is your output field Number = Input.StreetNumber State = Input.Region Street = Input.StreetName Zip = Input.PostalCode
Finally, rearrange the Output columns in the order you want them to appear in the export file. Now your final template looks like this:
[Template] TemplateVersion = 1.0 TableID = Marker-1.0 TemplateName = GetMarkerByState Intent = Retrieve [Output] Label = Input.Tag Number = Input.StreetNumber Street = Input.StreetName CityName = Input.City State = Input.Region Zip = Input.PostalCode [Filter] Region = Equals("Ohio")
Tips
TDE integration offers a web service that you can call directly (via REST) to POST data into the Verizon Connect Platform.
When you are ready to upload your template to Verizon Connect, follow this process:
Tips