Skip to content

Commit 17cd09e

Browse files
authored
Update universal-connector-source.md
Rephrase the text for variables to make it more user friendly.
1 parent 320d3ca commit 17cd09e

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/universal-connector-source.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -377,17 +377,17 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
377377
| clientRateLimitBurst | Integer | Yes | `1000` | The number of requests the source is allowed to burst. | `1000` |
378378
| pollingInterval | String | Yes | `"5m"` | Set how frequently to poll for new data. It must be between 5 minutes and 48 hours. | `"5m"` |
379379

380-
## Template Dynamic Values
380+
## Dynamic Values Variables
381381

382-
The source has the ability to template in dynamic text into the values of certain fields providing flexibility in crafting the HTTP requests sent to the vendor API.
382+
The source has the ability to use dynamic values, like the window start time, into the values of certain fields providing flexibility in crafting the HTTP requests sent to the vendor API.
383383

384384
The following fields values are allowed to access dynamic text from the template functions described in this section:
385385

386386
- HTTP Request Header Values
387387
- HTTP Request Parameter Values
388388
- HTTP Request Body
389389

390-
To start using the template with one of the supported config values listed above, you will need to enclose the template logic inside double curly braces `{{}}`. Any text outside these double curly braces will be treated as normal unmodified text.
390+
To start using the variables with one of the supported config values listed above, you will need to enclose the template logic inside double curly braces `{{}}`. Any text outside these double curly braces will be treated as normal unmodified text.
391391

392392
Here are some syntax examples calling functions with and without arguments:
393393

@@ -397,7 +397,7 @@ Here are some syntax examples calling functions with and without arguments:
397397
{{ .FunctionName "string argument 1" "string argument 2" }}
398398
```
399399

400-
**Available Template Functions**
400+
**Available Variables**
401401

402402
- [WindowStartUTC](#windowstartutc)
403403
- [WindowStartLocation](#windowstartlocation)
@@ -406,7 +406,7 @@ Here are some syntax examples calling functions with and without arguments:
406406

407407
### WindowStartUTC
408408

409-
This function will template in the `start timestamp` of the source window when source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
409+
This variable will get the value in the `start timestamp` of the source window when source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
410410

411411
The syntax for this function requires a timestamp format as a single argument. See the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
412412

@@ -425,7 +425,7 @@ The syntax for this function requires a timestamp format as a single argument. S
425425

426426
### WindowStartLocation
427427

428-
This function is the same as [WindowStartUTC](#windowstartutc) except it has an additional argument to specify the timezone location.
428+
This variable is the same as [WindowStartUTC](#windowstartutc) except it has an additional argument to specify the timezone location.
429429

430430
:::sumo[Best Practice]
431431
We strongly recommend you always use `WindowStartUTC` instead of `WindowStartLocation`. Most vendors support and expect UTC timestamps when using their APIs.
@@ -448,9 +448,9 @@ Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_t
448448

449449
### WindowEndUTC
450450

451-
This function will template in the `end timestamp` of the source window when source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
451+
This variable will get the value in the `end timestamp` of the source window when source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
452452

453-
The syntax for this function requires a timestamp format as a single argument. Refer to the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
453+
The syntax for this variable requires a timestamp format as a single argument. Refer to the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
454454

455455
```sh
456456
{{ .WindowEndUTC "<timestamp format>" }}
@@ -465,11 +465,11 @@ The syntax for this function requires a timestamp format as a single argument. R
465465
| `{{ .WindowEndUTC "epoch" }}` | `1709842556` |
466466
| `{{ .WindowEndUTC "epochMilli" }}` | `1709842556000` |
467467
| `lessThan:{{ .WindowEndUTC "2006-01-02T15:04:05.999Z07:00" }}` | `lessThan:2024-03-07T20:15:56.905Z` |
468-
| `lessThan:{{ .WindowEndUTC "yyyy-MM-ddTHH:mm:ss.SSSZ" }}` | `lessThan:2024-03-07T20:15:56.905Z` |
468+
| `{"startTime":"{{ .WindowEndUTC "yyyy-MM-ddTHH:mm:ss.SSSZ" }}"}` | `{"startTime":"{{ .WindowEndUTC "2024-03-07T20:15:56.905Z" }}"` |
469469

470470
### WindowEndLocation
471471

472-
This function is the same as [WindowEndUTC](#windowendutc) except it has an additional argument to specify the timezone location.
472+
This variable is the same as [WindowEndUTC](#windowendutc) except it has an additional argument to specify the timezone location.
473473

474474
:::sumo[Best Practice]
475475
We strongly recommend you always use `WindowEndUTC` instead of `WindowEndLocation`. Most vendors support and expect UTC timestamps when using their APIs.

0 commit comments

Comments
 (0)