Command line switches are all optional, and it doesn't matter the order you put them in. Switches are separated by a semi colon (;).
Command Line Options
- Command line switches are optional parameters that allow you to customize the execution of commands in a command-line interface. They provide additional functionalities or settings to the main command and can be used in any order without affecting the outcome. Switches are typically separated by a semi-colon (;) to clearly define each parameter. By utilizing command line switches, users can tailor their command executions to meet specific requirements or preferences.
When manually testing command-line options, you must use an Elevated Command Prompt.
Examples:
Single Schedules and Data-Driven Schedules
- To execute a Single Schedule and Data-Driven Schedules:
"C:\Program Files (x86)\ChristianSteven\ATRS\atrs.exe" -s schedulename=myschedulename
- To do the above without any messages showing:
atrs.exe -s schedulename:myschedule;showmsg=no
- To ignore the email address in the schedule and send to a specified email address:
atrs.exe -s schedulename:myschedule;showmsg:no;sendto:billt@mycompany.com
Packages Schedules and Data-Driven Packages
- To execute a Package:
"C:\Program Files (x86)\ChristianSteven\ATRS\atrs.exe" -p schedulename=myschedulename
- To do the above without any messages showing:
atrs.exe -p schedulename:myschedule;showmsg=no
- To ignore the email address in the schedule and send to a specified email address:
atrs.exe -p schedulename:myschedule;showmsg:no;sendto:billt@mycompany.com
Event-Based Schedules
- To execute an Event-Based Schedule:
"C:\Program Files (x86)\ChristianSteven\ATRS\atrs.exe" -e schedulename=myschedulename
- To do the above without any messages showing:
atrs.exe -e schedulename:myschedule;showmsg=no
- To ignore the email address in the schedule and send to a specified email address:
atrs.exe -e schedulename:myschedule;showmsg:no;sendto:billt@mycompany.com
Event-Based Packages:
- To execute an Event-Based Packages:
"C:\Program Files (x86)\ChristianSteven\ATRS\atrs.exe" -ep schedulename=myschedulename
- To do the above without any messages showing:
atrs.exe -ep schedulename:myschedule;showmsg=no
- To ignore the email address in the schedule and send to a specified email address:
atrs.exe -ep schedulename:myschedule;showmsg:no;sendto:billt@mycompany.com
Automation Schedule:
- To execute an Automation Schedule:
"C:\Program Files (x86)\ChristianSteven\ATRS\atrs.exe" -a schedulename=myschedulename
- To do the above without any messages showing:
atrs.exe -a schedulename:myschedule;showmsg=no
- To ignore the email address in the schedule and send to a specified email address:
atrs.exe -a schedulename:myschedule;showmsg:no;sendto:billt@mycompany.com
Creating a schedule by command line:
Run atrs.exe with the switch of -x e.g. \ATRS\atrs.exe -x
- And then the following parameters:
ScheduleName : name of schedule
ReportPath : path of Tableau report
FolderName : folder to store schedule
ATRSUser :atrs login userid
ATRSPassword : atrs login password
UserID : Tableau report database userid
Password : Tableau report database password
Frequency : schedule frequency {Daily,Weekly,Monthly,Yearly,Weekdays,Custom:[calendarname]}
RunAt : time schedule executes
Description : schedule description
Keyword : schedule keywords
StartDate :start date for schedule
EndDate : end date for schedule
Repeat : 1 or 0 if schedule is to repeat
RepeatInterval : repeat interval
RepeatUntil : repeat until time
Status : 1 or 0
UseLogin : 1 or 0
UseSavedData : 1 or 0
Destination : schedule destination {Email,Disk,Fax,Printer,Ftp}
DestinationName : name of destination
SendTo : email send to or fax number
CC : email cc
Bcc : email bcc
Subject : email subject
Message : email message
Extras : extra attachments
MailFormat : text or html
SMTPServer : specify SMTP server
OutputPath : disk output path
FTPServer : specify FTP server
FTPUserName : FTP userid
FTPPassword : FTP password
FTPPath : path for FTP server
Format : schedule output format
Zip : 1 or 0
Embed : 1 or 0
Parameter: [parametername]:[parametervalue]
Separate out the switches using a semi-colon(;)
e.g. atrs.exe -x schedulename:myschedule;reportpath:c:\myreports;foldername:Bills Reports
and so on.
Invoking ATRS From Another Server
To invoke ATRS from another server and/or run schedules with your own enterprise management or scheduling system, use
Windows:
PsExec: https://docs.microsoft.com/en-us/sysinternals/downloads/psexec