Script Function: Returns the current time of day at the beginning of the scriptA particular Automation Engine object type. processing.
SYS_TIME([Time Format], [TimeZone])
Syntax |
Description/Format |
---|---|
Time Format |
Format for the retrieved time. |
TimeZone |
Name of a TimeZone objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task or keyword UTC. |
Return code |
---|
Current time in the specified format |
This script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… determines the current day's date. A TimeZone, entered as a parameter, is included.
Time Format is optional. It is used to determine the format in which the function should return values. If you do not specify a Time Format, the default format "HHMMSS" is used.
TimeZone is also optional. If the script function is called without this parameter, the object's TimeZone is used, or that of the clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type. if none has been defined for the object itself. If a non-defined TimeZone is entered, the default value (client's TimeZone) is used. Instead of a TimeZone, the keyword UTC may be used. The date is returned in UTC (Coordinated Universal Time).
The current time is determined at the beginning of the script processing
and kept. This ensures the consistency of the script. If you use the script
function repeatedly within a script, the same time will always be returned.
This is especially important when the script processing for a specified
time period is interrupted with a :WAIT statement.
In order to transfer the current date to a Variable object of the type
"Time Stamp" with the script statement :PUT_VAR,
the date formats "YYMMDD" (Default), "YYYYMMDD" or
"YYYY-MM-DD" must be used. This format is not stored when the
variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. is stored on the Windows platform. The display of the date is
now based on the regional options in the control panel of Windows.
The time can only be saved together with the date in a variable of the
type "Time stamp". Only the following combinations of date and
time format are allowed: "YYMMDD HHMMSS" (Default), "YYYY-MM-DD"
and "YYYYMMDD HHMMSS".
The first example determines the current time of day and gives the value to a script variable. A TimeZone is used which has been defined for Central European Time. The result is written out in the activation protocol.
:SET &TIME# = SYS_TIME("HH:MM:SS","TZ.MEZ")
:PRINT &TIME#
In the second example, a special term is used and transferred with a script variable. Only the seconds of the current time of day are determined.
:SET &FORMAT# = "SS"
:SET &TIME# = SYS_TIME(&FORMAT#)
If the function is used without the specification of Time Format and TimeZone, the syntax is as in the following example.
:IF SYS_TIME()
= "120000"
!...
:ENDIF
In the third example, the current date and time are determined and saved in a Variable object of the type "Time Stamp". For date and time format, the following default values apply.
:SET &DATE# = SYS_DATE()
:SET &TIME# = SYS_TIME()
:PUT_VAR ENTRY
DATE, , "&DATE# &TIME#"
See also:
Script element | Description |
---|---|
SYS_TIME_PHYSICAL | Determines the current time of day. |
SYS_TIMESTAMP_PHYSICAL | Provides current date and time. |
Script Elements - Date and Time
About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |