--- title: Setup Assistant reference description: The Setup Assistant walks you through the steps you need to perform to set up the Security Incident Response base system. This section provides additional information on the complicated steps for which you may require more explanation.You can create a process definition to define the way security incidents transition from one state to the next. Process definitions give service desks and end users help tracking the problem throughout its life cycle.Security Incident Response Process Definition replaces state flows and provides end users and service desks with the status of a problem. A process definition helps track the problem through its life cycle. Security Incident Response is a Service Management \(SM\) application, which has its own set of states. Invalid states are reported as part of Process Selection.Security Incident Response Process Selection lists processes with invalid states for security incidents and response tasks.You can select the process definition to use for the appropriate states for your company security incidents and response tasks.Create a custom Process Definition script for the appropriate states for your company security incidents and response tasks.The Process Definition script include provides methods for defining a process definition.An administrator can correct the security incident or task to valid states, either manually or using a script. Available states vary based on the current state of the incident.Set up a security incident group and assign the appropriate roles and users to the group.Security incident calculator groups are used to group calculators.Security incident calculators allow you to calculate the severity of a security incident based on pre-defined formulas. You can define your own security incident calculators, as needed.Security incident calculators are used to update record values when pre-defined conditions are met. The calculators are grouped based on the criteria used to determine how the records are updated.The risk score is calculated as an arithmetic mean that represents the risk based on the priority of a security incident, the type of security incident \(Denial of Service, Spear Phishing, or Malicious code activity\), and the number of sources that triggered a failed reputation score on an indicator.The risk score weights used to calculate risk scores in security incidents can be removed or updated on an individual basis. They can also be removed or updated for all security incidents. The ability to remove them from security incidents is useful when changing weight values.You can define a Service Level Agreement \(SLA\) for Security Incident Response.You can repair SLA records to ensure that SLA timing and duration information is accurate.A runbook is an association between a published knowledge article and a specific task. While you are performing the task, a knowledge article in the runbook automatically opens, providing information pertinent to the task.When your employees receive emails that appear to be phishing attacks, they can report them to you using a phishing email address. The suspicious email is validated using rules defined by your organization. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/security-management/security-incident-response/setup-assistant-reference.html release: australia product: Security Incident Response classification: security-incident-response topic_type: reference last_updated: "2026-03-12" reading_time_minutes: 30 breadcrumb: [Install and configure Security Incident Response, Security Incident Response setup, Security Incident Response, Enterprise security case management applications, Security Operations] --- # Setup Assistant reference The Setup Assistant walks you through the steps you need to perform to set up the Security Incident Response base system. This section provides additional information on the complicated steps for which you may require more explanation. ## Roles The Setup Assistant requires the sn\_secops\_setup.admin role for full access to setup assistant configuration. Users with the sn\_si.admin role automatically inherit this role. The following access levels are enforced through the sn\_secops\_setup.admin role: - Setup Assistant SIR Admin - Access to Security Incident Response setup configuration. - Setup Assistant VR Admin - Access to Vulnerability Response setup configuration. - Setup Assistant VR/SIR Admin - Access to combined Vulnerability Response and Security Incident Response setup configuration. - Setup Assistant System Admin - Access to system-level setup assistant operations. ## Setup status The Setup Status \(sn\_secops\_setup\_status\) table tracks the completion state of each setup step. The key and complete fields on this table are enforced as strict read-only and can't be modified through client-side mechanisms. ## Create a Security Incident Response process definition You can create a process definition to define the way security incidents transition from one state to the next. Process definitions give service desks and end users help tracking the problem throughout its life cycle. ### Before you begin Role required: sn\_si.admin ### Procedure 1. Navigate to **All** > **Security Incident** > **Administration** > **Process Definition**. 2. Click **New**. 3. Fill in the fields, as appropriate. |Field|Description| |-----|-----------| |Name|Name of the record which describes the process encoded in the script include file. The name is displayed as a choice in the **Process Definition Selector** list.| |Script include|The name \(including the `sn_si`. prefix\) of the script include containing the definition of the process. The script must be in the Security Incident \(`sn_si`\) application scope. See [Create a custom Security Incident Response process definition script include](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/security-incident-response/setup-assistant-reference.md) for more information. If this field does not contain a valid script include name, the default ProcessDefinition\_NIST\_Stateful definition is used.| |Description|Helpful information about the script include.| |Order|Determines the position in the process definition list.| |Active|When checked, it makes this process definition selectable from the **Process Definition Selector** page.| 4. Click **Submit.** **Related topics** [Security Incident Response Process Selection]() [Understanding Security Incident Response process definition]() ### Understanding Security Incident Response process definition Security Incident Response Process Definition replaces state flows and provides end users and service desks with the status of a problem. A process definition helps track the problem through its life cycle. Security Incident Response is a Service Management \(SM\) application, which has its own set of states. Invalid states are reported as part of Process Selection. #### Security Incident Response Process Definition The default process definition \(NIST Stateful\) defines the following incident states: **Note:** Available states vary based on the current state of the incident. |State|Description| |-----|-----------| |Draft|The request initiator adds information about the security incident, but it isn’t yet ready to be worked on.| |Analysis|The incident has been assigned and the issue is being analyzed.| |Contain|The issue has been identified and the security staff is working to contain it and perform damage control. These actions can include taking servers offline, disconnecting equipment from the internet, and verifying that backups exist.| |Eradicate|The issue has been contained and the security staff is taking steps to fix the issue.| |Recover|The issue is resolved and the operational readiness of the affected systems is being verified.| |Review|The security incident is complete and all systems are back to normal function, however, a post incident review is still needed.| |Closed|The incident is complete but before a security incident can be closed, you must fill out the information on the **Closure Information** tab.| #### Security Incident task process definitions The following process definitions are used for security incident tasks. |State|Description| |-----|-----------| |Ready|The task is ready to be worked on after it’s assigned to an agent.| |Assigned|The task is assigned to an agent.| |Work In Progress|The assigned agent is working on the task.| |Complete|The task is complete.| |Canceled|The task was canceled.| NIST supports the following two models: - **NIST Stateful** This process definition enables analysts to move from one state to another in a sequential order without skipping any step. For example, if the Analyst starts with the **Draft** state, then the sequential order of this process definition is **Draft**>**Analysis**>**Contain**>**Eradicate**>**Recover**. So, the NIST Stateful process definition is unidirectional and enables analysts only to progress only to the forward states. Here’s another example, if the Analyst starts with the Analysis state, then the sequential order of this process definition is **Analysis**>**Contain**>**Eradicate**>**Recover**. - **NIST Open** This process definition enables analysts to move from one state to another, either forward or backward. For example, if the Analyst starts with the **Analysis** state, then the order of the process definition can either be **Analysis**>**Contain**>**Eradicate**>**Recover** or **Analysis**>**Draft**. So, the NIST Open process definition is bidirectional and enables analysts to move to the forward or backward states depending on their requirements. #### Security Incident Response Process Selection Security Incident Response Process Selection lists processes with invalid states for security incidents and response tasks. An administrator can correct the incident or task to valid states either manually or by using a script. An empty related list \(no incidents; no tasks\) indicates that every active task is in a valid state. Available states vary based on the current state of the incident. For more information, see [Correct an invalid security incident or task state with process definition](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/security-incident-response/setup-assistant-reference.md). ##### Select a Security Incident Response process definition You can select the process definition to use for the appropriate states for your company security incidents and response tasks. ###### Before you begin Role required: admin and sn\_si.admin ###### About this task ###### Procedure 1. Navigate to **All** > **Security Incident Response** > **Administration** > **Process Selection**. 2. Select the search icon to list the available process definitions. \[Omitted image "ProcessorSelector.png"\] Alt text: Process definition selector 3. Select a process definition. 4. Select **Update**. #### Create a custom Security Incident Response process definition script include Create a custom Process Definition script for the appropriate states for your company security incidents and response tasks. ##### Before you begin Role required: sn\_si.admin ##### About this task The sn\_si.ProcessDefinition main script include controls process definitions. **Process Definition** determines which definition is in use \(using **Process Selection**\). It calls the appropriate script include file to determine the initial states and transitions for both security incidents and response tasks. ##### Procedure 1. Navigate to **All** > **System Definition** > **Script Includes**. 2. Select **New.** 3. Fill in the fields, as appropriate.
| Field | Description |
|---|---|
| Name | Name of this script include. |
| API Name | Created based on the name of the script include. |
| Client callable | Makes the script include available to client scripts, list and report filters, reference qualifiers, or, if specified, as part of the URL. |
| Application | Security Incident |
| Accessible from | Choose **This application scope only** . |
| Active | When checked, it makes this script include selectable from the **Process Definition** page. |
| Description | Helpful information about the script include. |
| Script | Defines the server-side script to run when called from other scripts.The script must define a single JavaScript class or a global function. The class or function name must match the Name field. For information on script contents, see [Process Definition script include](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/security-incident-response/setup-assistant-reference.md). |
Security Incident Response Task is in draft
"}, {label:"Ready", condition:"state=10^EQ", description:"Security Incident Response Task is ready to be assigned
"}, {label:"Assigned", condition:"state=16^EQ", description:"Security Incident Response Task is assigned
"}, {label:"Work in Progress", condition:"state=18^EQ", description:"Work has started on this Security Incident Response Task
"}, {label:"Closed", condition:"state=3^ORstate=4^ORstate=7^EQ", description:"Security Incident Response Task is complete
"}, ], ``` The TASK\_PF array is a collection of labels, conditions, and descriptions used to determine the text displayed in the process formatter bar \(including order and activity\). In the example, the text 'Ready' is the second item displayed. It is highlighted when the task satisfied the condition 'state=10^EQ'. When the pointer hovers over the text, the description 'Security Incident Response Task is ready to be assigned' is displayed. **Note:** States can be combined to a single formatter state. In the example, both the 'Close Complete' and the 'Canceled' states show up as 'Closed' in the top bar. ###### Method calls The following methods must be present in the script include as they are used by sn\_si.ProcessDefinition: |Return type|Method summary|Description| |-----------|--------------|-----------| |String|getInitialIncidentState: function\(\)|return the initial incident state numerical value| |String|getInitialTaskState: function\(\):|return the initial task state numerical value| |Array of string|getIncidentStates: function\(\):|return the incident state's array| |Array of string|getTaskStates: function\(\):|return the task state's array| |Array of objects|getIncidentProcessFlows: function\(\):|return the incident process flow definition array| |Array of objects|getTaskProcessFlows: function\(\):|return the task process flow definition array| The next set of methods are called whenever an incident or a task is updated and allows actions to be taken on specific change transitions. |Return type|Method summary|Description| |-----------|--------------|-----------| |void|performIncidentStateChange: function\(current, previous\)|In the examples, this method is used to set SM-related values and ensure that an incident advances out of 'Draft' once someone is assigned to it.| |void|performTaskStateChange: function\(current, previous\)|In the example, this method is used to update timestamps \(on assignment and closing\) and advance the task from 'Ready' to 'Assigned' once the assigned\_to field is filled.| The same actions performed by these two methods can be accomplished using a business rule. By defining them in the script include, switching process definitions is made easier. #### Correct an invalid security incident or task state with process definition An administrator can correct the security incident or task to valid states, either manually or using a script. Available states vary based on the current state of the incident. ##### Before you begin Role required: admin ##### About this task After you have switched process definitions, the new definition may not support some of the old states. To correct the orphan incident or task states, you can [change your process definition](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/security-incident-response/setup-assistant-reference.md), [edit your script include](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/security-incident-response/setup-assistant-reference.md), or manually open each incident or task to update the state. Generally, updating the state \(which can be done in bulk\) is the easiest solution. To change states in bulk, do the following: ##### Procedure 1. Navigate to **All** > **Security Incident** > **Administration** > **Process Selection**. 2. Highlight the **State** field for the incidents or tasks you want to change. 3. Double-click the **State** field in the first record, select the new **State,** and select the green check mark \(\[Omitted image "GreenCheckMarkIcon.png"\] Alt text: Green check mark\) to complete the change. \[Omitted image "CorrectedDefinition.png"\] Alt text: Corrected definition example 4. Select **Update**. ## Create a security incident group Set up a security incident group and assign the appropriate roles and users to the group. ### Before you begin Roles required: - If you have the user\_admin role, you can create security incident assignment groups. - If you have the sn\_si.admin role, you can create and edit security incident assignment groups. ### About this task Users in a group inherit the roles of the group, so you do not have to assign roles to each user separately. It is a good practice to create as many groups as needed in your organization. It is also a good practice to create one group for administrators and assign the admin role to this group only. ### Procedure 1. Navigate to **All** > **User Administration** > **Groups** or **Security Incident** > **Setup** > **Groups**. 2. Select **New**. 3. On the form, fill in the fields. **Note:** For more information, see [Create a user group](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/t_CreateAGroup.md). 4. Make sure that you select the **security incident** type for this group. 1. If the **Type** field is not visible, configure the form to add it. 2. Select the lock icon beside the **Type** field. 3. Select the reference lookup icon \(\[Omitted image "SearchIcon.png"\] Alt text: lookup icon\) 4. Search for and select the **security incident** type. 5. Select and hold \(or right-click\) the form header and select **Save**. 6. In the **Roles** related list, add the roles that each member of this group receives. For example, if you're making a group for Security Incident Response team members, add sn\_si.analyst. If you're making a group for Security Incident Response administrators, add sn\_si.admin. 7. In the **Group Members** related list, add users to this group. 8. Select **Update**. ## Create a security incident calculator group Security incident calculator groups are used to group calculators. ### Before you begin Role required: sn\_si.admin ### Procedure 1. Navigate to **All** > **Security Incident** > **Setup** > **Security Incident Calculator Groups**. 2. Click **New**. 3. Fill in the fields on the form, as appropriate. |Field|Description| |-----|-----------| |Name|The name of the security incident calculator.| |Application|The application that contains this record.| |Order|The order in which the security incident calculator is run. A calculator with an order entry of 100 runs before a calculator with an order entry of 200.| |Description|A description of this calculator group.| |Created by|Enter the name of the user who created| 4. Click **Submit**. ### Create a security incident calculator Security incident calculators allow you to calculate the severity of a security incident based on pre-defined formulas. You can define your own security incident calculators, as needed. #### Before you begin Role required: sn\_si.admin #### Procedure 1. Navigate to **All** > **Security Incident** > **Setup** > **Security Incident Calculator Groups**. 2. Click the name of the group for which you want to create a calculator, or you can [create a calculator group](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/security-incident-response/setup-assistant-reference.md). 3. Click **New**. 4. Fill in the fields on the form, as appropriate.| Field | Description |
|---|---|
| Name | The name of the security incident calculator. |
| Calculator Group | Name of the group to which this calculator belongs. **Note:** Creating or changing the calculator group becomes available after you have entered a **Name** and **Table**. |
| Table | Select the table to be used for this calculator. When you add calculators to tables other than Vulnerability \[sn\_vul\_vulnerability\] and Vulnerable Item \[sn\_vul\_vulnerable\_item\], you must add business rules and UI Actions to those tables. To see examples: - Navigate to **System Definition** > **Business Rules**, and locate the **Calculate Severity** business rule on the Vulnerable Item \[sn\_vul\_vulnerable\_item\] table. - Navigate to **System UI** > **UI Actions**, and locate the **Calculate Severity** UI action on the Vulnerable Item \[sn\_vul\_vulnerable\_item\] table. Also, the vulnerability admin role must be granted full read, write \(or save\_as\_template\) capabilities on any table used by a calculator to properly see the values to apply to the template. |
| Application | The scoped application to which the calculator belongs. |
| Order | The order in which the security incident calculator runs. A calculator with an order entry of 100 runs before a calculator with an order entry of 200. |
| Active | Turn the calculator on or off. |
| Description | A description of this calculator. |
| Field | Description |
|---|---|
| Use filter group | Select this check box to use a predefined filter group or [create a new filter group](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/create-filter-group.md) to define the calculator criteria. |
| Filter group | Select the filter group to use for defining a calculator. This field appears only if you selected the **Use filter groups** check box. |
| Use advanced condition | Select this check box to indicate that a script condition is used to determine when this calculator is applied. When you select the check box, an **Advanced condition** scripting field appears.If you selected the **Use filter group** check box, this field is hidden. **Note:** Before you define advanced conditions and write scripts for determining when the security incident calculators are applied, return to the Security Incident Calculators list. Explore the calculator records shipped with the base system. |
| Condition | Defines basic filter conditions for determining whether the calculator is used. If you selected either of the **Use filter group** or **Use advanced conditions** check boxes, this field is hidden. |
| Field | Description |
|---|---|
| Use script values | Select this check box to define field values with a script. |
| Script values | Defines what values to apply the calculations to.This field appears only if you selected the **Use script values** check box. |
| Template | Right-click the form header and select **Save**. Select the fields and values you want to use for the calculator. |
| Security Incident Calculator Group Name | Calculators included in group | Description |
|---|---|---|
| Business Impact | Aggregate from Severity Calculators | This calculator delegates to the Security Criticality Calculator that determines criticality by weighing the values of other fields. |
| Severity | Business Impacted | This severity calculator defines its selection criteria using a simple condition builder. |
| Critical service affected | This severity calculator defines its selection criteria using an advanced condition. If the configuration item in the security incident is associated with a highly critical business service, the **Risk score**, **Business Impact**, and **Priority** fields are elevated as defined by the calculator. | |
| Critical service changes | This severity calculator defines its selection criteria using an advanced condition. If the security incident meets the conditions, a script runs to define what levels the fields are elevated to. If the configuration item in the security incident is associated with a most critical or somewhat critical business service, the **Risk score**, **Business Impact**, and **Priority** fields are elevated as defined by the calculator. | |
| Multi-Attack Vectors | This severity calculator defines its selection criteria using a simple condition builder. If the configuration item in the security incident is associated with web, email, and impersonation attack vectors, the **Risk score**, **Business Impact**, and **Priority** fields are elevated as defined by the calculator. | |
| Set priority with category and services | This severity calculator defines its selection criteria using an advanced condition builder.The security incident priority is set to **1 - Critical** when the following conditions are met: - The security incident has associated affected services and one of them is critical. - The security incident category is one of the following: - Denial of Service - Spear Phishing - Malicious code activity **Note:** This calculator is available in the base system when you have the Starter Security Operation pricing tier. | |
| Set priority with observables | This severity calculator defines its selection criteria using an advanced condition builder.The security incident priority is set to**1 - Critical** when the following conditions are met: - The security incident has associated affected services and one of them is critical. - The security incident category is one of the following: - Denial of Service - Spear Phishing - Malicious code activity - One of the associated observables or indicators has a sighting count that exceeds two sightings with active indicators \(that is, the observables or indicators are confirmed as being bad from multiple sources\). **Note:** This calculator is available in the base system when you have the Advanced Security Operation pricing tier and you activate the Threat Feeds plugin. | |
| User criticality | Get user criticality | This severity calculator defines its selection criteria using a simple condition builder. This severity calculator causes user business criticality to change to **1 - Critical** when the **Department** field is changed to **Finance**. |
| Get user group criticality | This severity calculator defines its selection criteria using an advanced condition builder. This severity calculator provides example of a calculator that runs on data in a related list. |
| Field | Description |
|---|---|
| Knowledge article | Select a knowledge article to include in the runbook. |
| Active | Check the box to make the runbook available from the **Filter Navigator**. |
| Use filter group | Select this check box to use a predefined filter group or [create a new filter group](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/security-management/create-filter-group.md) to define the runbook criteria. |
| Filter group | Select the filter group to use for defining a runbook. This field appears only if the **Use filter groups** check box is selected. |
| Table | Select either Security Incident \[sn\_si\_incident\] or Security Incident Response Task \[sn\_si\_task\].If you selected the **Use filter group** check box and selected a filter group, this field defaults to the table associated with the selected filter group. |
| Condition | Set the conditions that connect this runbook to the incident or task.If you selected the **Use filter group** check box and selected a filter group, the **Condition** fields are not displayed. |