• Retrieve - Retrieve data from the TDE table into a file.
• Create - Create data in the TDE table.
• Update - Update data in the TDE table.
• CreateOrUpdate - Update data in the TDE table if the row exists, create it if it doesn't.
• Delete - Delete data from the TDE table.

Tip
"Input" template intents are those that use an input file: Create, Update, CreateOrUpdate, and Delete.

• Defaults to ascending order:

  OrderBy = Input.Time

• Sorts input data into descending order:

  OrderBy = Input.Time DESC

• Sorts input data into a mix of ascending and descending order:

  OrderBy = Input.UnitId ASC, Input.StartTime DESC, Input.EndTime DESC

• CompleteSuccessful - (default) Commit valid rows and reject invalid rows. That is, the operation can succeed partially.
• CompleteAll - (currently unsupported) All rows must succeed in order to commit changes. That is, the entire operation succeeds or fails as a whole.

• CSV - (default) The input data is in CSV (comma-separated value) form.

  Tip
  You can use the Delimiter entry to specify a different delimiter character.

  Note
  In CSV files, stray spaces before the first quote of delimited fields can corrupt the parsing of those values.

• FixedWidth - The input data is a fixed-width text file. To import using fixed-width format, you must include a [Columns] section to specify the column widths.
• XPath - The input data is XML. Use the ElementName attribute to specify which node to input. If you do not specify an ElementName, the string "TableEntry" is used. If your template maps to an element that is not present in your input data, then the element will be ignored. See the [Output] section for more details on how to access your data from the template.

  Note
  If your input file contains any namespaces, you must define these in the [Namespaces] section.

• JSON - The input data is JSON. Each record of the output is a node specified by the ElementName. If you do not specify an ElementName, the string "TableEntry" is used. If your template maps to an element that is not present in your input data or is set to null, the element will be ignored. See the [Output] section for more details on how to access your data from the template.

  Note
  If your input is a JSON array, the ElementName must be specified, and it must be blank, like "ElementName="

(defaults to false) Indicates whether TDE considers case when processing templates. If set to true, template syntax is considered case sensitive.

For example, if your template is for a table with a DriverId column, you must specify Input.DriverId for driver Id input. If you specify case inconsistently, for example Input.driverid, input.driverid, or input.DriverId, TDE returns a "Table column not found" error code.

Setting this option turns on stricter validation of template syntax which can be useful for tables that have custom properties with case differences, for example CustomProp1 and customProp1. If the CaseSensitiveFields option is set to false, TDE cannot reliably retrieve the correct value. If the CaseSensitiveFields option is enabled, CustomProp1 references the value in that property instead of the one specified by customProp1.

• Defaults to ascending order:

  OrderBy = Input.Time

• Returns results in descending order:

  OrderBy = Input.Time DESC

• Returns results in a mix of ascending and descending order:

  OrderBy = Input.UnitId ASC, Input.StartTime DESC, Input.EndTime DESC

• For CSV output: When set to true, a header line is generated. When false, no header line is included.

• For JSON output: When set to true, the table name is the key to the result array. When false, no table name key is included, and the result is an array of JSON objects.

• CSV - (default) Export to CSV (comma-separated value).

  Tip
  You can use the Delimiter entry to specify a different delimiter character.

• FixedWidth - Export a fixed-width text file. To export to fixed-width format, you must include a [Columns] section to specify the column widths.
• XML - Export to XML format. When exporting to XML, the values are returned as attributes of the XML object. You can use ElementName to specify the XML element that is used for each record that is exported. If you do not specify an ElementName, the string "TableEntry" is used, as shown here:
  XML

  Copy

  <TableEntry id="87979363" Number="5186" Street="W 142nd St" CityName="Hawthorne" State="California"  Zip="90250" Radius="500" />

• XPath - Export to XML using the XPath provided to describe the document. When exporting to XPath, by default values are returned as elements, although in the [Output] section you can specify that specific values should be returned as attributes using XPath syntax. The root element is given by the TemplateName, and each record of the output is inserted at the node indicated by ElementName. If you do not specify an ElementName, the string "TableEntry" is used, as shown here:
  XPath

  Copy

  <TableEntry>
  <id>87979363</id>
  <Number>5186</Number>
  <Street>W 142nd St</Street>
  <CityName>Hawthorne</CityName>
  <State>California</State>
  <Zip>90250</Zip>
  <Radius>500</Radius>
  </TableEntry>

• JSON - Export to JSON format. When exporting to JSON format, the root element is given by the TemplateName, and each record of the output is inserted as a property indicated by ElementName. If you do not specify an ElementName, the string "TableEntry" is used, as shown here:
  JSON

  Copy

  {
    "TableEntry":{
      "id":"87979363",
      "Number":"5186",
      "Street":"W 142nd St",
      "CityName":"Hawthorne",
      "State":"California",
      "Zip":"90250",
      "Radius":"500"
    }
  }

(only applies to CSV and FixedWidth formats) By default, TDE inserts Windows-style line breaks (\r\n) after each row of data retrieved for CSV and FixedWidth formatted outputs. However, you can use the Newline entry to override the default line break style or add characters at the end of the line.

Line break examples:

• Newline = \r\n - (default) Inserts Windows-style line breaks.
• Newline = \r - Inserts Mac-style line breaks.
• Newline = \n - Inserts Unix-style line breaks.

If you use the Newline entry to insert additional characters at the end of each line, we recommend ending the character string with \r\n (or your preferred line break style) to break the line following your character string. For example, Newline = |\r\n inserts a pipe followed by a Windows-style line break after each row of data.

(defaults to false) Setting StructuredData to true allows some data types to be output in a standard structure for JSON and XPATH formats. When set to false, TDE outputs the structured data types below as follows:

• The Location data type outputs as a space separated Latitude and Longitude pair.
• The Address data type outputs as a | (pipe) delimited string.
• The Set and Array data types output as a comma delimited string.
• The Map data type also outputs as a comma delimited string, but only when you retrieve an individual item within the map object by key.

Tip
To retrieve a complete Map object (instead retrieving an item in the map by key), then StructuredData must be set to true.

In the example outputs below, AccessDays is a Set. In the first example, the output is for a template in which StructuredData is set to false; therefore, the AccessDays data is output as a comma-delimited string.

{
  "RetrieveUserAccessDaysTemplate": {
    "TableEntry": [
      {
        "Id": "123456",
        "AccessDays": "Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday"
      },
      {
        "Id": "345678",
        "AccessDays": "Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday"
      }
    ]
  }
}

When StructuredData is set to true, the AccessDays data is output in a standard structure.

{
  "RetrieveUserAccessDaysTemplate": {
    "TableEntry": [
      {
        "Id": "123456",
        "AccessDays": [
          "Sunday",
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday",
          "Saturday"
        ]
      },
      {
        "Id": "345678",
        "AccessDays": [
          "Sunday",
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday",
          "Saturday"
        ]
      }
    ]
  }
}

See the Accessing subfields page for another example.

(defaults to false) Indicates whether TDE considers case when processing templates. If set to true, template syntax is considered case sensitive.

For example, if your template is for a table with a DriverId column, you must specify Input.DriverId for driver Id input. If you specify case inconsistently, for example Input.driverid, input.driverid, or input.DriverId, TDE returns a "Table column not found" error code.

Setting this option turns on stricter validation of template syntax which can be useful for tables that have custom properties with case differences, for example CustomProp1 and customProp1. If the CaseSensitiveFields option is set to false, TDE cannot reliably retrieve the correct value. If the CaseSensitiveFields option is enabled, CustomProp1 references the value in that property instead of the one specified by customProp1.