Documentation
Preparing search index...
@saltcorn/data
models/workflow_step
export=
Class export=
Index
Constructors
constructor
Properties
action_
name
configuration
id?
initial_
step
name
next_
step?
only_
if?
trigger_
id
Accessors
mmname
mmnext
to
Json
Methods
delete
run
update
built
In
Action
Config
Fields
built
In
Action
Explainers
create
delete
For
Trigger
find
find
One
generate_
diagram
get
Diagram
Loop
Link
Backs
mmescape
Constructors
constructor
new
"export="
(
o
:
export=
|
WorkflowStepCfg
)
:
export=
WorkflowStep constructor
Parameters
o
:
export=
|
WorkflowStepCfg
Returns
export=
Properties
action_
name
action_name
:
string
configuration
configuration
:
any
Optional
id
id
?:
number
initial_
step
initial_step
:
boolean
name
name
:
string
Optional
next_
step
next_step
?:
string
Optional
only_
if
only_if
?:
string
trigger_
id
trigger_id
:
number
Accessors
mmname
get
mmname
()
:
string
Returns
string
mmnext
get
mmnext
()
:
undefined
|
string
Returns
undefined
|
string
to
Json
get
toJson
()
:
any
Returns
any
Methods
delete
delete
(
connect_prev_next
?:
boolean
)
:
Promise
<
void
>
Parameters
connect_prev_next
:
boolean
= false
Returns
Promise
<
void
>
run
run
(
context
:
any
,
user
:
export=
)
:
Promise
<
any
>
Parameters
context
:
any
user
:
export=
Returns
Promise
<
any
>
update
update
(
row
:
Row
)
:
Promise
<
void
>
Parameters
row
:
Row
Returns
Promise
<
void
>
Static
built
In
Action
Config
Fields
builtInActionConfigFields
(
opts
?:
any
,
)
:
Promise
<
(
|
export=
|
{
attributes
?:
undefined
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
:
{
options
:
string
[]
}
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
:
{
options
:
string
[]
}
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
?:
undefined
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
:
string
;
fieldview
:
string
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
:
any
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
:
string
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
:
boolean
;
wf_action_name
:
string
}
;
sublabel
?:
undefined
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
:
string
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
:
undefined
|
{
options
:
string
[]
}
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
:
any
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
:
any
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
[]
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
)
[]
,
>
Parameters
opts
:
any
= {}
Returns
Promise
<
(
|
export=
|
{
attributes
?:
undefined
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
:
{
options
:
string
[]
}
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
:
{
options
:
string
[]
}
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
?:
undefined
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
:
string
;
fieldview
:
string
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
:
any
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
:
string
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
:
boolean
;
wf_action_name
:
string
}
;
sublabel
?:
undefined
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
:
string
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
|
{
attributes
:
undefined
|
{
options
:
string
[]
}
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
:
any
;
}
|
{
attributes
?:
undefined
;
class
:
string
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
:
boolean
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
}
;
sublabel
:
string
;
type
:
string
;
validator
:
any
;
}
|
{
attributes
?:
undefined
;
class
?:
undefined
;
default
?:
undefined
;
fieldview
?:
undefined
;
label
:
string
;
name
:
string
;
required
?:
undefined
;
showIf
:
{
immediately_bg
?:
undefined
;
wf_action_name
:
string
[]
}
;
sublabel
:
string
;
type
:
string
;
validator
?:
undefined
;
}
)
[]
,
>
Static
built
In
Action
Explainers
builtInActionExplainers
(
opts
?:
any
)
:
any
Parameters
opts
:
any
= {}
Returns
any
Static
create
create
(
step_in
:
WorkflowStepCfg
)
:
Promise
<
export=
>
Parameters
step_in
:
WorkflowStepCfg
Returns
Promise
<
export=
>
Static
delete
For
Trigger
deleteForTrigger
(
trigger_id
:
number
)
:
Promise
<
void
>
Parameters
trigger_id
:
number
Returns
Promise
<
void
>
Static
find
find
(
where
:
Where
,
selectopts
?:
SelectOptions
)
:
Promise
<
export=
[]
>
Parameters
where
:
Where
Optional
selectopts
:
SelectOptions
Returns
Promise
<
export=
[]
>
Static
find
One
findOne
(
where
:
Where
)
:
Promise
<
export=
>
Parameters
where
:
Where
Returns
Promise
<
export=
>
Static
generate_
diagram
generate_diagram
(
steps
:
export=
[]
,
options
?:
{}
)
:
string
Parameters
steps
:
export=
[]
options
:
{}
= {}
Returns
string
Static
get
Diagram
Loop
Link
Backs
getDiagramLoopLinkBacks
(
steps
:
export=
[]
)
:
Record
<
string
,
string
>
Parameters
steps
:
export=
[]
Returns
Record
<
string
,
string
>
Static
mmescape
mmescape
(
s
:
string
)
:
string
Parameters
s
:
string
Returns
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
action_
name
configuration
id
initial_
step
name
next_
step
only_
if
trigger_
id
Accessors
mmname
mmnext
to
Json
Methods
delete
run
update
built
In
Action
Config
Fields
built
In
Action
Explainers
create
delete
For
Trigger
find
find
One
generate_
diagram
get
Diagram
Loop
Link
Backs
mmescape
Documentation
Loading...
WorkflowStep constructor