> For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonoransoftware.com/cms/integration-capabilities/in-game-integration-resources/core/core-submodules/job-sync.md).

# Job Sync

This resource is a in-game way of automatically syncing jobs and ranks to match roster information in the Sonoran CMS system/community.

{% hint style="warning" %}
At this time, the Job Sync module only works with [QBCore and Qbox servers](/cms/integration-capabilities/fivem-game-panel/qbcore-and-qbox-panel.md).
{% endhint %}

## Installation / Configuration

{% hint style="info" %}
With core version `v1.4.2` the Job Sync resource was converted to a core module and no longer requires manual installation just configuration.
{% endhint %}

### 1. Configure Job Sync Module

Locate the whitelist module within your `[sonorancms]/sonorancms/server/modules` and open the `jobsync_config.json` file

<figure><img src="/files/ViBIoMHSfCjB5EYgwaNI" alt=""><figcaption><p>Sonoran CMS - In-Game Integration - JobSync Config</p></figcaption></figure>

### 2. Set Rank Mappings for Job Sync

| Config Option | Description                                                            |
| ------------- | ---------------------------------------------------------------------- |
| rank\_mapping | \["9dd1fea1-2360-4be2-923b-71b0c87944d0"] = {job = 'police', rank = 2} |

Here you must follow the format shown above to specify rank mappings, the first value ("ranks") is the Rank UUID, followed by what job and rank you would like to set it to. To find the UUID for a given Rank, follow the instructions below.

## Getting Rank UUIDs

### 1. Open Department Configuration Page

![Sonoran CMS - Departments & Ranks](/files/Nsq4139MEY3axhuEE2qE)

### 2. Open "Rank Settings" Menu

![Sonoran CMS - Open Rank Settings Menu](/files/G6QfrDSgXpVm4ujYGqny)

### 3. Select "Copy Rank ID"

![Sonoran CMS - Copy Rank ID](/files/UzmzIuqJZmEvl4bIik2w)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sonoransoftware.com/cms/integration-capabilities/in-game-integration-resources/core/core-submodules/job-sync.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
