Runtime Macro Reference
Q100116: Runtime Macro Reference
This article serves as a reference guide for all of the globally available runtime macros that can be used in parameter values.
| Macro | Description |
|---|---|
| {{#DayNumber}} | The numeric value for the day of the week. Value ranges from 0 for Sunday, to 6 for Saturday. |
| {{#DayOfMonth}} | The numeric day of the month. Value ranges from 1 to 31, depending on the number of days in the month. |
| {{#DayOfWeek}} | The name of the day of the week. Values range from Sunday to Saturday. |
| {{#DayOfYear}} | The numeric value for the day of the year. Values range from 1 for January 1st, to 366 for December 31st, on a leap year. |
| {{#IsoDateTime}} | The current date and time in standardized ISO date time format. Example 2022-01-02T13:35:18 |
| {{#IsoDate}} | The current date in standardized ISO style date format. Example 2022-01-02 |
| {{#IsoTime}} | The current time in standardized ISO style time format. Example 13:35:18 |
| {{#JobServerName}} | The name of the installed JobServer service on the machine. |
| {{#JobServerUptime}} | A descriptive representation of the uptime for the JobServer service. An example might be 28d 19h 23m 49s. |
| {{#JobServerVersion}} | A descriptive representation of the JobServer service build version number. An example might look like 6.0.0.32462. |
| {{#Job}} | The name of the running job. If the job is inside of a group, then this will include the group as part of the name. Example Sales Dept / Sales to Date Report |
| {{#LongDateTime}} | A descriptive representation of the current date and time in long format. Example Sunday, January 2, 2022 01:35:18 PM |
| {{#LongDate}} | A descriptive representation of the current date in long format. Example Sunday, January 2, 2022 |
| {{#LongTime}} | A descriptive representation of the current time. Example 01:35:18 PM |
| {{#MemberDomain}} | The name of the member domain that the machine the JobServer service is running on, belongs to. If the machine is not joined to a domain, the value returned will be {None}. |
| {{#MonthNumber}} | The numeric value for the month. Values range from 1 to 12. |
| {{#Month}} | A descriptive representation of the current month. Example January |
| {{#ServerAddress}} | The IP Addresses the server has configured. Example ::1, 192.168.1.100 |
| {{#ServerName}} | The operating system name of the machine. Example WIN-FBCVKNS |
| {{#ServerUptime}} | A descriptive representation of the uptime for the machine the JobServer service is running on. Example 29d 18h 59m 17s |
| {{#ServerVersion}} | A descriptive representation of the operating system running on the machine the JobServer service is running on. Example Microsoft Windows NT 6.2.9200.0 |
| {{#ShortDateTime}} | A descriptive representation of the current date and time in short format. Example 1/2/2022 01:35 PM |
| {{#ShortDate}} | A descriptive representation of the current date in short format. Example 01-02-2022 |
| {{#ShortTime}} | A descriptive representation of the current time in short format. Example 01:35 PM |
| {{#SystemTempFileName}} | A fully qualified path and temporary filename returned by the framework. Example C:\Temp\ffff.tmp See note below for important information. |
| {{#SystemTempPath}} | The path returned by the framework for working with temporary files. Recommended to use module [Files] Generate Filename for better control and access. Example C:\Temp See note below for important information. |
| {{#Year}} | The numeric value for the current year. |
Notes
For the runtime macros, {{#SystemTempPath}} and {{#SystemTempFileName}}, the values returned for these are based on the built in functions in the .NET Framework and the Microsoft Windows API, to provide a place for working with temporary files while processing. Due to this, these usually point to a location on the Operating System boot disk. While this should not technically be a problem for most jobs and custom modules, this can potentially lead to performance and other issues if your JobServer is normally processing a large number, or very large files, with frequently occuring jobs. This is most often found in large enterprise type organizations, but it is important to watch out for. If your jobs or custom modules will frequently be using very large files while running, we highly recommend using the [Files] Generate Filename module pointing the Folder parameter to a different disk volume of your own specification. Most system configurations will provide better performance when this is on a volume different than the OS boot volume. It also gives you a greater degree of control as well as providing additional options and flexibility.