@servicenow/sdk - v4.7.0
Preparing search index...
@servicenow/sdk/core
sysauto
Variable sysauto
Const
sysauto
:
{
allowWebServiceAccess
:
true
;
extends
:
"sys_metadata"
;
extensible
:
true
;
label
:
"Scheduled Job"
;
name
:
"sysauto"
;
schema
:
{
active
:
Typed
<
boolean
,
{
default
:
true
;
label
:
"Active"
}
>
;
advanced
:
Typed
<
boolean
,
{
label
:
"Advanced"
}
>
;
business_calendar
:
Typed
<
|
string
|
Record
<
"business_calendar"
>
|
ExplicitKey
<
"business_calendar"
>
|
TableBrand
<
"business_calendar"
>
,
{
attributes
:
{
encode_utf8
:
false
}
;
label
:
"Business Calendar"
;
referenceQual
:
"is_legacy_schedule=false"
;
referenceTable
:
"business_calendar"
;
}
,
>
;
condition
:
Typed
<
string
|
number
,
{
columnType
:
"script_plain"
;
label
:
[
{
hint
:
"Execute this job only if script evaluates to true"
;
label
:
"Condition"
;
language
:
"en"
;
plural
:
"Conditions"
;
}
,
]
;
maxLength
:
8000
;
}
,
>
;
conditional
:
Typed
<
boolean
,
{
label
:
[
{
hint
:
"Specify conditions under which this job is executed"
;
label
:
"Conditional"
;
language
:
"en"
;
plural
:
"Conditionals"
;
}
,
]
;
}
,
>
;
entered_run_end
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
attributes
:
{
time_zone_value
:
"UTC"
}
;
label
:
[
{
hint
:
"Specify when the job should stop running. Jobs with Ending values in the past are marked inactive"
;
label
:
"Ending"
;
language
:
"en"
;
plural
:
"Endings"
;
}
,
]
;
}
,
>
;
entered_run_start
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
attributes
:
{
time_zone_value
:
"UTC"
}
;
label
:
[
{
hint
:
"A recurring job will not start until Starting date/time is reached."
;
label
:
"Starting"
;
language
:
"en"
;
plural
:
"Startings"
;
}
,
]
;
}
,
>
;
entered_time
:
Typed
<
string
|
number
,
{
attributes
:
{
user_time_format
:
true
}
;
columnType
:
"glide_utc_time"
;
label
:
"Time"
;
}
,
>
;
max_drift
:
Typed
<
string
|
Duration
,
{
label
:
"Max drift"
;
maxLength
:
40
}
>
;
name
:
Typed
<
string
,
{
attributes
:
{
no_truncate
:
true
}
;
label
:
"Name"
;
maxLength
:
100
}
,
>
;
offset
:
Typed
<
string
|
Duration
,
{
label
:
"Offset"
;
maxLength
:
40
}
>
;
offset_type
:
Typed
<
1
|
2
,
{
choices
:
{
"1"
:
{
label
:
"Future"
;
sequence
:
1
}
;
"2"
:
{
label
:
"Past"
;
sequence
:
2
}
;
}
;
default
:
"0"
;
dropdown
:
"dropdown_with_none"
;
label
:
"Offset type"
;
}
,
>
;
repeat_every
:
Typed
<
number
,
{
label
:
[
{
hint
:
"For recurring trigger types, repeat only every Nth occurrence. For example, if a daily job is expected to run every 3rd day, this field would be set to 3"
;
label
:
"Repeat every"
;
language
:
"en"
;
plural
:
"Repeat everies"
;
}
,
]
;
}
,
>
;
run_as
:
Typed
<
|
string
|
Record
<
"sys_user"
>
|
ExplicitKey
<
"sys_user"
>
|
TableBrand
<
"sys_user"
>
,
{
attributes
:
{
encode_utf8
:
false
}
;
cascadeRule
:
"restrict"
;
default
:
"javascript:gs.getUserID()"
;
label
:
[
{
hint
:
"Scheduled job will run with credentials of specified user (optional)"
;
label
:
"Run as"
;
language
:
"en"
;
plural
:
"Run as"
;
}
,
]
;
referenceTable
:
"sys_user"
;
}
,
>
;
run_as_tz
:
Typed
<
string
,
{
dropdown
:
"dropdown_with_none"
;
dynamicValueDefinitions
:
{
field
:
"time_zone"
;
table
:
"sys_user"
;
type
:
"choices_from_other_table"
;
}
;
label
:
"Run as tz"
;
}
,
>
;
run_dayofmonth
:
Typed
<
|
1
|
2
|
3
|
4
|
5
|
6
|
7
|
8
|
9
|
10
|
11
|
12
|
13
|
14
|
15
|
16
|
17
|
18
|
19
|
20
|
21
|
22
|
23
|
24
|
25
|
26
|
27
|
28
|
29
|
30
|
31
,
{
choices
:
{
"1"
:
{
label
:
"1"
;
sequence
:
1
}
;
"10"
:
{
label
:
"10"
;
sequence
:
10
}
;
"11"
:
{
label
:
"11"
;
sequence
:
11
}
;
"12"
:
{
label
:
"12"
;
sequence
:
12
}
;
"13"
:
{
label
:
"13"
;
sequence
:
13
}
;
"14"
:
{
label
:
"14"
;
sequence
:
14
}
;
"15"
:
{
label
:
"15"
;
sequence
:
15
}
;
"16"
:
{
label
:
"16"
;
sequence
:
16
}
;
"17"
:
{
label
:
"17"
;
sequence
:
17
}
;
"18"
:
{
label
:
"18"
;
sequence
:
18
}
;
"19"
:
{
label
:
"19"
;
sequence
:
19
}
;
"2"
:
{
label
:
"2"
;
sequence
:
2
}
;
"20"
:
{
label
:
"20"
;
sequence
:
20
}
;
"21"
:
{
label
:
"21"
;
sequence
:
21
}
;
"22"
:
{
label
:
"22"
;
sequence
:
22
}
;
"23"
:
{
label
:
"23"
;
sequence
:
23
}
;
"24"
:
{
label
:
"24"
;
sequence
:
24
}
;
"25"
:
{
label
:
"25"
;
sequence
:
25
}
;
"26"
:
{
label
:
"26"
;
sequence
:
26
}
;
"27"
:
{
label
:
"27"
;
sequence
:
27
}
;
"28"
:
{
label
:
"28"
;
sequence
:
28
}
;
"29"
:
{
label
:
"29"
;
sequence
:
29
}
;
"3"
:
{
label
:
"3"
;
sequence
:
3
}
;
"30"
:
{
label
:
"30"
;
sequence
:
30
}
;
"31"
:
{
label
:
"31"
;
sequence
:
31
}
;
"4"
:
{
label
:
"4"
;
sequence
:
4
}
;
"5"
:
{
label
:
"5"
;
sequence
:
5
}
;
"6"
:
{
label
:
"6"
;
sequence
:
6
}
;
"7"
:
{
label
:
"7"
;
sequence
:
7
}
;
"8"
:
{
label
:
"8"
;
sequence
:
8
}
;
"9"
:
{
label
:
"9"
;
sequence
:
9
}
;
}
;
default
:
"1"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Day"
;
}
,
>
;
run_dayofweek
:
Typed
<
DayOfWeekValue
,
{
label
:
"Day"
}
>
;
run_daysofweek
:
Typed
<
string
,
{
label
:
[
{
hint
:
"Specify days of week to run the job"
;
label
:
"Run days of week"
;
language
:
"en"
;
plural
:
"Run days of weeks"
;
}
,
]
;
}
,
>
;
run_end
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
label
:
[
{
hint
:
"Specify when the job should stop running. Jobs with ending values in the past are marked inactive"
;
label
:
"Ending"
;
language
:
"en"
;
plural
:
"Endings"
;
}
,
]
;
}
,
>
;
run_month
:
Typed
<
string
|
number
,
{
columnType
:
"month_of_year"
;
label
:
"Month"
}
,
>
;
run_period
:
Typed
<
string
|
Duration
,
{
label
:
"Repeat Interval"
;
maxLength
:
40
}
,
>
;
run_start
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
default
:
"javascript:gs.nowDateTime()"
;
label
:
"Starting"
}
,
>
;
run_time
:
Typed
<
string
|
TimeOfDay
,
{
label
:
"Time"
;
maxLength
:
40
}
>
;
run_type
:
Typed
<
|
"once"
|
"weekly"
|
"monthly"
|
"daily"
|
"day_and_month_in_year"
|
"day_week_month_year"
|
"periodically"
|
"on_demand"
|
"week_in_month"
|
"business_calendar_start"
|
"business_calendar_end"
,
{
choices
:
{
business_calendar_end
:
{
hint
:
"Refers to Business Calendar entry spans"
;
label
:
"Business Calendar: Entry End"
;
sequence
:
51
;
}
;
business_calendar_start
:
{
hint
:
"Refers to Business Calendar entry spans"
;
label
:
"Business Calendar: Entry Start"
;
sequence
:
50
;
}
;
daily
:
{
label
:
"Daily"
;
sequence
:
0
}
;
day_and_month_in_year
:
{
label
:
"Day and Month in Year"
;
sequence
:
1
}
;
day_week_month_year
:
{
label
:
"Day in Week in Month in Year"
;
sequence
:
4
;
}
;
monthly
:
{
label
:
"Monthly"
;
sequence
:
3
}
;
on_demand
:
{
label
:
"On Demand"
;
sequence
:
7
}
;
once
:
{
label
:
"Once"
;
sequence
:
6
}
;
periodically
:
{
label
:
"Periodically"
;
sequence
:
5
}
;
week_in_month
:
{
label
:
"Week in Month"
;
sequence
:
8
}
;
weekly
:
{
label
:
"Weekly"
;
sequence
:
2
}
;
}
;
default
:
"daily"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Run"
;
}
,
>
;
run_weekinmonth
:
Typed
<
1
|
2
|
3
|
4
|
5
|
6
,
{
choices
:
{
"1"
:
{
label
:
"First"
}
;
"2"
:
{
label
:
"Second"
}
;
"3"
:
{
label
:
"Third"
}
;
"4"
:
{
label
:
"Fourth"
}
;
"5"
:
{
label
:
"Fifth"
}
;
"6"
:
{
label
:
"Sixth"
}
;
}
;
columnType
:
"week_of_month"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Run week in month"
;
}
,
>
;
sys_id
:
Typed
<
string
,
{
label
:
[
{
label
:
"Sys ID"
;
language
:
"en"
;
plural
:
"Sys IDs"
}
]
;
primary
:
true
;
}
,
>
;
time_zone
:
Typed
<
"floating"
,
{
attributes
:
{
choice_script
:
"new GlideTimeZoneUtil().process('sysauto')"
;
}
;
choices
:
{
floating
:
{
label
:
"Use System Time Zone"
}
}
;
dropdown
:
"dropdown_with_none"
;
label
:
"Time zone"
;
script
:
"new GlideTimeZoneUtil().process('sysauto')"
;
}
,
>
;
upgrade_safe
:
Typed
<
boolean
,
{
default
:
false
;
label
:
"Upgrade safe"
}
>
;
}
;
textIndex
:
true
;
}
= ...
Type Declaration
Readonly
allowWebServiceAccess
:
true
Readonly
extends
:
"sys_metadata"
Readonly
extensible
:
true
Readonly
label
:
"Scheduled Job"
Readonly
name
:
"sysauto"
Readonly
schema
:
{
active
:
Typed
<
boolean
,
{
default
:
true
;
label
:
"Active"
}
>
;
advanced
:
Typed
<
boolean
,
{
label
:
"Advanced"
}
>
;
business_calendar
:
Typed
<
|
string
|
Record
<
"business_calendar"
>
|
ExplicitKey
<
"business_calendar"
>
|
TableBrand
<
"business_calendar"
>
,
{
attributes
:
{
encode_utf8
:
false
}
;
label
:
"Business Calendar"
;
referenceQual
:
"is_legacy_schedule=false"
;
referenceTable
:
"business_calendar"
;
}
,
>
;
condition
:
Typed
<
string
|
number
,
{
columnType
:
"script_plain"
;
label
:
[
{
hint
:
"Execute this job only if script evaluates to true"
;
label
:
"Condition"
;
language
:
"en"
;
plural
:
"Conditions"
;
}
,
]
;
maxLength
:
8000
;
}
,
>
;
conditional
:
Typed
<
boolean
,
{
label
:
[
{
hint
:
"Specify conditions under which this job is executed"
;
label
:
"Conditional"
;
language
:
"en"
;
plural
:
"Conditionals"
;
}
,
]
;
}
,
>
;
entered_run_end
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
attributes
:
{
time_zone_value
:
"UTC"
}
;
label
:
[
{
hint
:
"Specify when the job should stop running. Jobs with Ending values in the past are marked inactive"
;
label
:
"Ending"
;
language
:
"en"
;
plural
:
"Endings"
;
}
,
]
;
}
,
>
;
entered_run_start
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
attributes
:
{
time_zone_value
:
"UTC"
}
;
label
:
[
{
hint
:
"A recurring job will not start until Starting date/time is reached."
;
label
:
"Starting"
;
language
:
"en"
;
plural
:
"Startings"
;
}
,
]
;
}
,
>
;
entered_time
:
Typed
<
string
|
number
,
{
attributes
:
{
user_time_format
:
true
}
;
columnType
:
"glide_utc_time"
;
label
:
"Time"
;
}
,
>
;
max_drift
:
Typed
<
string
|
Duration
,
{
label
:
"Max drift"
;
maxLength
:
40
}
>
;
name
:
Typed
<
string
,
{
attributes
:
{
no_truncate
:
true
}
;
label
:
"Name"
;
maxLength
:
100
}
,
>
;
offset
:
Typed
<
string
|
Duration
,
{
label
:
"Offset"
;
maxLength
:
40
}
>
;
offset_type
:
Typed
<
1
|
2
,
{
choices
:
{
"1"
:
{
label
:
"Future"
;
sequence
:
1
}
;
"2"
:
{
label
:
"Past"
;
sequence
:
2
}
;
}
;
default
:
"0"
;
dropdown
:
"dropdown_with_none"
;
label
:
"Offset type"
;
}
,
>
;
repeat_every
:
Typed
<
number
,
{
label
:
[
{
hint
:
"For recurring trigger types, repeat only every Nth occurrence. For example, if a daily job is expected to run every 3rd day, this field would be set to 3"
;
label
:
"Repeat every"
;
language
:
"en"
;
plural
:
"Repeat everies"
;
}
,
]
;
}
,
>
;
run_as
:
Typed
<
|
string
|
Record
<
"sys_user"
>
|
ExplicitKey
<
"sys_user"
>
|
TableBrand
<
"sys_user"
>
,
{
attributes
:
{
encode_utf8
:
false
}
;
cascadeRule
:
"restrict"
;
default
:
"javascript:gs.getUserID()"
;
label
:
[
{
hint
:
"Scheduled job will run with credentials of specified user (optional)"
;
label
:
"Run as"
;
language
:
"en"
;
plural
:
"Run as"
;
}
,
]
;
referenceTable
:
"sys_user"
;
}
,
>
;
run_as_tz
:
Typed
<
string
,
{
dropdown
:
"dropdown_with_none"
;
dynamicValueDefinitions
:
{
field
:
"time_zone"
;
table
:
"sys_user"
;
type
:
"choices_from_other_table"
;
}
;
label
:
"Run as tz"
;
}
,
>
;
run_dayofmonth
:
Typed
<
|
1
|
2
|
3
|
4
|
5
|
6
|
7
|
8
|
9
|
10
|
11
|
12
|
13
|
14
|
15
|
16
|
17
|
18
|
19
|
20
|
21
|
22
|
23
|
24
|
25
|
26
|
27
|
28
|
29
|
30
|
31
,
{
choices
:
{
"1"
:
{
label
:
"1"
;
sequence
:
1
}
;
"10"
:
{
label
:
"10"
;
sequence
:
10
}
;
"11"
:
{
label
:
"11"
;
sequence
:
11
}
;
"12"
:
{
label
:
"12"
;
sequence
:
12
}
;
"13"
:
{
label
:
"13"
;
sequence
:
13
}
;
"14"
:
{
label
:
"14"
;
sequence
:
14
}
;
"15"
:
{
label
:
"15"
;
sequence
:
15
}
;
"16"
:
{
label
:
"16"
;
sequence
:
16
}
;
"17"
:
{
label
:
"17"
;
sequence
:
17
}
;
"18"
:
{
label
:
"18"
;
sequence
:
18
}
;
"19"
:
{
label
:
"19"
;
sequence
:
19
}
;
"2"
:
{
label
:
"2"
;
sequence
:
2
}
;
"20"
:
{
label
:
"20"
;
sequence
:
20
}
;
"21"
:
{
label
:
"21"
;
sequence
:
21
}
;
"22"
:
{
label
:
"22"
;
sequence
:
22
}
;
"23"
:
{
label
:
"23"
;
sequence
:
23
}
;
"24"
:
{
label
:
"24"
;
sequence
:
24
}
;
"25"
:
{
label
:
"25"
;
sequence
:
25
}
;
"26"
:
{
label
:
"26"
;
sequence
:
26
}
;
"27"
:
{
label
:
"27"
;
sequence
:
27
}
;
"28"
:
{
label
:
"28"
;
sequence
:
28
}
;
"29"
:
{
label
:
"29"
;
sequence
:
29
}
;
"3"
:
{
label
:
"3"
;
sequence
:
3
}
;
"30"
:
{
label
:
"30"
;
sequence
:
30
}
;
"31"
:
{
label
:
"31"
;
sequence
:
31
}
;
"4"
:
{
label
:
"4"
;
sequence
:
4
}
;
"5"
:
{
label
:
"5"
;
sequence
:
5
}
;
"6"
:
{
label
:
"6"
;
sequence
:
6
}
;
"7"
:
{
label
:
"7"
;
sequence
:
7
}
;
"8"
:
{
label
:
"8"
;
sequence
:
8
}
;
"9"
:
{
label
:
"9"
;
sequence
:
9
}
;
}
;
default
:
"1"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Day"
;
}
,
>
;
run_dayofweek
:
Typed
<
DayOfWeekValue
,
{
label
:
"Day"
}
>
;
run_daysofweek
:
Typed
<
string
,
{
label
:
[
{
hint
:
"Specify days of week to run the job"
;
label
:
"Run days of week"
;
language
:
"en"
;
plural
:
"Run days of weeks"
;
}
,
]
;
}
,
>
;
run_end
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
label
:
[
{
hint
:
"Specify when the job should stop running. Jobs with ending values in the past are marked inactive"
;
label
:
"Ending"
;
language
:
"en"
;
plural
:
"Endings"
;
}
,
]
;
}
,
>
;
run_month
:
Typed
<
string
|
number
,
{
columnType
:
"month_of_year"
;
label
:
"Month"
}
,
>
;
run_period
:
Typed
<
string
|
Duration
,
{
label
:
"Repeat Interval"
;
maxLength
:
40
}
,
>
;
run_start
:
Typed
<
`
${
number
}
-
${
number
}
-
${
number
}
${
number
}
:
${
number
}
:
${
number
}
`
,
{
default
:
"javascript:gs.nowDateTime()"
;
label
:
"Starting"
}
,
>
;
run_time
:
Typed
<
string
|
TimeOfDay
,
{
label
:
"Time"
;
maxLength
:
40
}
>
;
run_type
:
Typed
<
|
"once"
|
"weekly"
|
"monthly"
|
"daily"
|
"day_and_month_in_year"
|
"day_week_month_year"
|
"periodically"
|
"on_demand"
|
"week_in_month"
|
"business_calendar_start"
|
"business_calendar_end"
,
{
choices
:
{
business_calendar_end
:
{
hint
:
"Refers to Business Calendar entry spans"
;
label
:
"Business Calendar: Entry End"
;
sequence
:
51
;
}
;
business_calendar_start
:
{
hint
:
"Refers to Business Calendar entry spans"
;
label
:
"Business Calendar: Entry Start"
;
sequence
:
50
;
}
;
daily
:
{
label
:
"Daily"
;
sequence
:
0
}
;
day_and_month_in_year
:
{
label
:
"Day and Month in Year"
;
sequence
:
1
}
;
day_week_month_year
:
{
label
:
"Day in Week in Month in Year"
;
sequence
:
4
;
}
;
monthly
:
{
label
:
"Monthly"
;
sequence
:
3
}
;
on_demand
:
{
label
:
"On Demand"
;
sequence
:
7
}
;
once
:
{
label
:
"Once"
;
sequence
:
6
}
;
periodically
:
{
label
:
"Periodically"
;
sequence
:
5
}
;
week_in_month
:
{
label
:
"Week in Month"
;
sequence
:
8
}
;
weekly
:
{
label
:
"Weekly"
;
sequence
:
2
}
;
}
;
default
:
"daily"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Run"
;
}
,
>
;
run_weekinmonth
:
Typed
<
1
|
2
|
3
|
4
|
5
|
6
,
{
choices
:
{
"1"
:
{
label
:
"First"
}
;
"2"
:
{
label
:
"Second"
}
;
"3"
:
{
label
:
"Third"
}
;
"4"
:
{
label
:
"Fourth"
}
;
"5"
:
{
label
:
"Fifth"
}
;
"6"
:
{
label
:
"Sixth"
}
;
}
;
columnType
:
"week_of_month"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Run week in month"
;
}
,
>
;
sys_id
:
Typed
<
string
,
{
label
:
[
{
label
:
"Sys ID"
;
language
:
"en"
;
plural
:
"Sys IDs"
}
]
;
primary
:
true
;
}
,
>
;
time_zone
:
Typed
<
"floating"
,
{
attributes
:
{
choice_script
:
"new GlideTimeZoneUtil().process('sysauto')"
;
}
;
choices
:
{
floating
:
{
label
:
"Use System Time Zone"
}
}
;
dropdown
:
"dropdown_with_none"
;
label
:
"Time zone"
;
script
:
"new GlideTimeZoneUtil().process('sysauto')"
;
}
,
>
;
upgrade_safe
:
Typed
<
boolean
,
{
default
:
false
;
label
:
"Upgrade safe"
}
>
;
}
Readonly
textIndex
:
true
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@servicenow/sdk - v4.7.0
Loading...