Configure Tableau Parameters and Rendering

Choose the parameter values and page layout ATRS uses when it renders your Tableau report.

Before you begin

Complete Create a Schedule from a Working Template. Keep the new test copy disabled and retain its intended definition.

The example uses $AtrsDefinition, $AtrsDefinitionPath, $AtrsNewId, $AtrsBaseUrl and $AtrsHeaders from that workflow. Its reload section explains how to continue in a new session.

Choose a parameter already defined in the selected Tableau view and a value that view accepts.

1. Inspect the current settings

Retrieve the schedule using GET /api/SingleSchedule/Get. Compare its Parameters and ClientRenderingSettings with your retained definition.

2. Change the parameter and PDF layout

The following changes one known parameter, selects landscape A4 output and keeps recurrence disabled:

$AtrsDefinition.Parameters | Format-Table Name,Value,Type
$AtrsParameterName = Read-Host "Existing parameter Name"
$AtrsParameter = @($AtrsDefinition.Parameters | Where-Object { $_.Name -ceq $AtrsParameterName })
if ($AtrsParameter.Count -ne 1) { throw "Select exactly one existing parameter" }
$AtrsParameter[0].Value=Read-Host "Accepted test value"
$AtrsDefinition.ClientRenderingSettings.orientation="Landscape"
$AtrsDefinition.ClientRenderingSettings.pageSize="A4"
$AtrsDefinition.ClientRenderingSettings.applySettings=$true
$AtrsDefinition.Schedule.Enabled=$false
$AtrsDefinition | ConvertTo-Json -Depth 100 | Set-Content -LiteralPath $AtrsDefinitionPath -Encoding UTF8 -ErrorAction Stop
Invoke-RestMethod -Method Post -Uri "$AtrsBaseUrl/api/SingleSchedule/Update" -Headers $AtrsHeaders -ContentType "application/json" -Body ($AtrsDefinition | ConvertTo-Json -Depth 100) -TimeoutSec 60
$AtrsSaved = Invoke-RestMethod -Method Get -Uri "$AtrsBaseUrl/api/SingleSchedule/Get?Id=$AtrsNewId" -Headers $AtrsHeaders -TimeoutSec 30
$AtrsSaved.Parameters | Format-Table Name,Value,Type
$AtrsSaved.ClientRenderingSettings | ConvertTo-Json -Depth 30

This sends the complete definition through POST /api/SingleSchedule/Update, then retrieves saved state independently. Preserve unrelated parameters, rendering values and destination IDs.

3. Choose rendering settings for the output

Single-schedule writes use the client fields below in ClientRenderingSettings:

Supported paper-size names are A3, A4, A5, B5, Executive, Folio, Ledger, Legal, Letter, Note, Quarto and Tabloid.

ATRS converts the client settings for single-schedule writes. RenderingSettings uses different names and numeric values; changing that object alone does not perform the same edit. See the single-schedule update schema for both representations.

4. Verify the content and layout

1. Confirm the parameter value and client rendering settings in the saved response.
2. Confirm that destinations and disabled recurrence remain correct.
3. Run the Quick Start using this test copy’s ID.
4. Open the output and check parameter scope, page size, orientation, clipping and completeness.

For customer-specific reports, test two different scopes and verify each contains only the intended data. Your backend must enforce mandatory data scope independently of user-editable parameters.

If the result is wrong, restore the previous intended definition through the same update/read-back sequence and test it before allowing recurrence.

Package reports

For a package, put each Tableau report’s parameters in that member’s parameters array and its output settings in renderingSettings. Follow Create and Manage Report Packages for the complete package definition, or Create a Data-Driven Tableau Package to supply parameter values from input records.

Troubleshooting