---
title: ServiceNow for HR Access Requirements
excerpt: ''
deprecated: false
hidden: false
metadata:
  title: ''
  description: ''
  robots: index
next:
  description: ''
---
This document outlines the access required for Moveworks/ServiceNow HR Integration for ticketing.

## Roles Required:

Moveworks requires the following role:

`sn_hr_sp.admin`- Used to ingest HR Record Producer Form Details (destination table, scripts, etc.)

## Table + Attributes Required:

Moveworks also requires a custom role that grants access to the following Table APIs.

Moveworks may read the following fields, exact field names may vary based on customization done to your ServiceNow instance. If you have a custom field that is used in place of one of the out of the box fields specified below, please include access to that field when integrating with Moveworks.

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Table/ API
      </th>

      <th>
        Attributes Used
      </th>

      <th>
        HTTP Methods Used & Use Case
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `/api/now/table/sn_hr_core_case`
      </td>

      <td>
        Outlined below
      </td>

      <td>
        * **POST**: Create Case, **PUT**: Update Case
        * **GET**: Retrieve Case Details
      </td>
    </tr>

    <tr>
      <td>
        `/api/now/v2/table/sc_item_produced_record`
      </td>

      <td>
        sys\_id, record\_key, sys\_updated\_by, task, sys\_created\_on, sys\_mod\_count, producer, record\_table, sys\_updated\_on, sys\_tags, sys\_created\_by
      </td>

      <td>
        * **GET**: Retrieve Ticket Status
      </td>
    </tr>

    <tr>
      <td>
        `/api/now/v2/table/sys_journal_field`
      </td>

      <td>
        sys\_id, sys\_created\_on, name, element\_id, sys\_tags, value, sys\_created\_by, element
      </td>

      <td>
        * **GET**: Retrieve Ticket Comments & Work Notes
      </td>
    </tr>

    <tr>
      <td>
        `/api/now/v2/table/sys_user`
      </td>

      <td>
        sys\_id, other directory attributes
      </td>

      <td>
        * **GET**: Retrieve Users
      </td>
    </tr>

    <tr>
      <td>
        `/api/now/v2/table/kb_knowledge`
      </td>

      <td>
        all
      </td>

      <td>
        * **GET**: Retrieve Knowledge articles
      </td>
    </tr>
  </tbody>
</Table>

### Update Set Installation

**[Click here](/docs/servicenow-update-sets) to download and install the Moveworks ServiceNow update sets.**

The Moveworks bot can respect user criteria for knowledge articles and catalog items.

To set this up, please install the Moveworks update sets into your ServiceNow non-production and production instances.

After installing the update sets, a new role called `moveworks_user` is added to your instance. **This role will need to be assigned to the Moveworks service account.**

For more information on what the update sets contain, see [this document](/docs/update-set-modules).

## Detailed Reasons for Attribute on HR Case Table:

The following attributes should be granted if they exist. If they do not exist, you can omit granting the access.

| Field Name          | Access Level | Business Justification                                                          |
| :------------------ | :----------- | :------------------------------------------------------------------------------ |
| active              | READ         | Used to only read active tickets when presenting back a user’s ticket statuses. |
| close\_notes        | READ         | Used to notify users on ticket updates when ticket is resolved                  |
| closed\_at          | READ         | Used when querying & filtering tickets                                          |
| closed\_by          | READ         | Used when querying & filtering tickets                                          |
| comments            | READ         | Used to notify users on ticket updates                                          |
| description         | READ         | Used when querying & filtering tickets                                          |
| details             | READ         | Used when querying & filtering tickets                                          |
| due\_date           | READ         | Used when querying & filtering tickets                                          |
| location            | READ         | Used when querying & filtering tickets                                          |
| number              | READ         | Used when querying tickets                                                      |
| opened\_at          | READ         | Used when querying & filtering tickets                                          |
| opened\_by          | READ         | Used when querying tickets                                                      |
| opened\_for         | READ         | Used when querying tickets                                                      |
| parent              | READ         | Used when querying tickets                                                      |
| priority            | READ         | Used for Filtering our high priority tickets                                    |
| reassignment\_count | READ         | Used for Ticket Triage                                                          |
| state               | READ         | Used when querying tickets                                                      |
| sys\_id             | READ         | Used when querying tickets                                                      |
| sys\_updated\_by    | READ         | Used when querying tickets                                                      |
| sys\_updated\_on    | READ         | Used when querying tickets                                                      |
| sys\_class\_name    | READ         | Used to query the correct type of tickets                                       |
| watch\_list         | READ         | Used for watcher ticket notifications                                           |
| impact              | WRITE        | Used when creating tickets                                                      |
| urgency             | WRITE        | Used when creating tickets                                                      |
| contact\_type       | WRITE        | Used when creating tickets                                                      |
| assignment\_group   | WRITE        | Used when creating tickets                                                      |
| short\_description  | WRITE        | Used when creating tickets                                                      |
| description         | WRITE        | Used when creating tickets                                                      |
| opened\_for         | WRITE        | Used when creating tickets                                                      |
| caller              | WRITE        | Used when creating tickets                                                      |
| service\_offering   | WRITE        | Used when creating tickets                                                      |
| subject\_person     | WRITE        | Used when creating tickets, and showing ticket status.                          |

### Standard Fields for Ticket Actions  (Create, Comment, etc.), Support, and Debugging

Optional Fields Based on if they are used in your ServiceNow environment

* task\_effective\_number - READ
* skip\_auto\_assign - READ
* skip\_automatic\_user\_acceptance\_state - READ
* universal\_request - READ
* transferred\_from - READ
* time\_worked - READ