TaskStateUtil- Global

The TaskStateUtil script include provides methods for working with task-type table state attributes.

This script include is primarily used by the Task Active State Management business rule to set the active field based on state changes. Configurations are defined in the task.state dictionary element, usually using dictionary overrides since state values vary by table.

You can call the TaskStateUtil script include in any server script to determine inactive states, default work, or default close states for a table.

The required attributes are defined on the planned_task table so all planned task types are supported. We will eventually add the attributes to other task types and eventually the base task table. You are free to do this if you want to leverage this feature now.

These attributes can be defined on the task.state dictionary element or a dictionary override for extended task tables.

Parent Topic:Server API reference

TaskStateUtil - TaskStateUtil(GlideRecord task)

Creates a TaskStateUtil object.

var stateUtil = new TaskStateUtil(current);

TaskStateUtil - ATTR_DEFAULT_WORK

The name of the attribute that identifies default work state.

TaskStateUtil - ATTR_DEFAULT_CLOSE

The name of the attribute that identifies the default close state.

TaskStateUtil - ATTR_INACTIVE_STATES

The name of the attribute that identifies inactive states.

TaskStateUtil - SYSTEM_DEFAULT_CLOSE

The value of the default close state is Closed Complete on the Task table.

TaskStateUtil - SYSTEM_DEFAULT_WORK

The value of the default work state is Work in progress on the Task table.

TaskStateUtil - SYSTEM_INACTIVE_STATES

The values of the default inactive states: Closed Complete, Closed Incomplete, Closed Skipped on the Task table.

TaskStateUtil - getDefaultCloseState

Returns the value for the default closed state.

The default closed state value is 3 if the default_close_state attribute has not been specified.

var stateUtil = new TaskStateUtil(current);
//get the close state
var defaultCloseState =  stateUtil.getDefaultCloseState();
current.state = defaultCloseState;

TaskStateUtil - getDefaultWorkState()

Returns the value for the default work state.

The default work state value is 2 if the default_work_state attribute has not been specified.

var stateUtil = new TaskStateUtil(current);
//get the work state
var defaultWorkState =  stateUtil.getDefaultWorkState();
current.state = defaultWorkState;

TaskStateUtil - getInactiveStates

Returns a list of the inactive state values.

var stateUtil = new TaskStateUtil(current);
//get the inactive state values
var inactiveStates = stateUtil.getInactiveStates();

TaskStateUtil - isStateInactive(String state)

Returns the active status of the specified state.

var stateUtil = new TaskStateUtil(current);
var previousStateInactive = stateUtil.isStateInactive(previous.state);
var currentStateInactive = stateUtil.isStateInactive(current.state);

TaskStateUtil - runMarkClosed

Decides whether the mark closed business rule should be run or not.

TaskStateUtil - runTaskCloser

Decides whether the task closer business rule should be run or not.

TaskStateUtil - runTaskReopener

Decides whether the task reopener business rule should be run or not.

TaskStateUtil - setDefaultWorkState(String defaultWorkState)

Enables the user to specify their own default work state.