Report for Managers Job Parameters
Parameters for generating a report for Managers that create role-specific reports tailored for managers containing data about subordinate employees and send data via email.
Example:
{
"Report": 123,
"Parameters": {
"StaticParameters": "{ \"Sites\": [], \"IncludeSubSites\": true, \"ActiveOnly\": \"Active\", \"XlsHeader\": true, \"RosterFinished\": 2, \"WorksheetConfirmed\": 1, \"ChangeConfirmation\": [1, 2, 3] }",
"DynamicParameters": {
"Date": null,
"Period": {
"BaseDateOffset": null,
"Type": "Month",
"Offset": -1,
"Count": 1,
"CutBy": null
},
"TimeOffTypes": null
}
},
"SuperiorsRoleIds": [8],
"UsePrimaryRoles": true,
"Subject": "The subject of the email",
"Body": "The body content of the email",
"AttachmentName": "FileName_{Report.Period}_{CurrentDate :yyyyMMdd}.xlsx",
"Language": "CS"
}
Parameters
SectionContains both static and dynamic parameters for the report.
Example:
{
"Parameters": {
"StaticParameters": "{ \"Sites\": [], \"IncludeSubSites\": true, \"ActiveOnly\": \"Active\", \"XlsHeader\": true, \"RosterFinished\": 2, \"WorksheetConfirmed\": 1, \"ChangeConfirmation\": [1, 2, 3] }",
"DynamicParameters": {
"Date": null,
"Period": {
"BaseDateOffset": null,
"Type": "Month",
"Offset": -1,
"Count": 1,
"CutBy": null
},
"TimeOffTypes": null
}
}
}
List of superior user roles Ids of users for whom the report is intended.
Whether primary roles only are used for subordinate employees evaluation. (true or false)
Name of the attachment file with the report results. The file name can contain tokens in {}.
- Tokens:
- {CurrentDate} - Current date, {CurrentDate: yyyyMMdd} - Current date with specified format
- {CurrentTime} - Current date and time, {CurrentTime: yyyyMMdd hh:mm:ss} - Current date and time with specified format
- {Report.Period} - Reporting period
- {Report.Period.Start} - Reporting period start
- {Report.Date} - Reporting day for reports for a single day
Use Cases
Job for Manager's Organizational Reporting Scope
Use CaseSites, Roles and StaticParameters.ActiveOnly fields control which managers receive reports and whether reports include only active employees or all employees.
Generate reports only for selected sites
Useful when managers should receive reports only for their assigned operational areas.
{ "Sites": [ "Customer Support", "Back Office" ]}
Send reports only to selected manager roles
Useful when reports should not be distributed to all leadership roles.
{ "Roles": [ "Supervisor", "Manager" ]}
Include only active employees in manager reports
Useful when reports should exclude inactive or terminated employees.
{ "StaticParameters": { "ActiveOnly": "Active" }}
Include active and inactive employees in manager reports
Useful for historical or audit reporting scenarios.
{ "StaticParameters": { "ActiveOnly": "All" }}
Was this helpful?