> For the complete documentation index, see [llms.txt](https://docs.sharinpix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sharinpix.com/fieldknot/integrations/microsoft/fieldknot-setup-guide.md).

# FieldKnot setup guide

Before FieldKnot can be used, it has to be connected to SharinPix with a **SharinPix Secret URL**. This guide covers that one-time setup, then explains how to manage workers and jobs in FieldKnot and how field workers complete their jobs in the SharinPix mobile app.

## Before you begin

Make sure that:

* The FieldKnot solution is installed from the Microsoft Marketplace in your Microsoft Dynamics 365 organization.
* You have access to the **FieldKnot Setting** app in that organization.
* Your field workers have the SharinPix mobile app on their smartphones. See [Install the SharinPix mobile app](#install-the-sharinpix-mobile-app).

## Connect FieldKnot to SharinPix

### Step 1: Request your SharinPix Secret URL

Email <info@sharinpix.com> to say that you have installed the FieldKnot solution in your Microsoft Dynamics 365 organization. SharinPix will reply with your Secret URL.

{% hint style="warning" %}
Treat the Secret URL like a password. Don't share it outside your IT or admin team.
{% endhint %}

### Step 2: Enter the Secret URL in FieldKnot Setting

1. In Dynamics 365, open the **App Launcher** (the grid icon in the top-left corner).
2. Select **FieldKnot Setting**.

   <figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FhfnQOgaJ8A6lrlRJiqQR%2Ffigure-01-app-launcher-fieldknot-setting.png?alt=media&amp;token=68ef2a6f-db4d-4a1d-ada7-ba6653d877fb" alt=""><figcaption></figcaption></figure>
3. In the left navigation, under **Setting**, select **Secret URL Setting**.
4. Paste the Secret URL from SharinPix into the text box.
5. Select **Save**. The status next to **SharinPix Secret URL** changes to **Configured**.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2F9yU93uqW3i1Z5QGCb2XE%2Ffigure-02-secret-url-configured.png?alt=media&amp;token=a52a32ab-74bb-4824-8e38-d451c2971ca5" alt=""><figcaption></figcaption></figure>

To replace the Secret URL later, for example if SharinPix issues you a new one, return to this page, paste the new URL and select **Save**. The new URL overwrites the existing secret.

### Step 3: Open the FieldKnot app

1. Open the **App Launcher**.
2. Select **FieldKnot**.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FoEJBey0AjBFLU5hzaavD%2Ffigure-03-app-launcher-fieldknot.png?alt=media&amp;token=442f83d9-81b1-4e6c-b918-762d711dfd14" alt=""><figcaption></figcaption></figure>

The app opens with **Workers** and **Jobs** in the left navigation.

## Manage workers

Workers are the people who carry out jobs in the field. The **Workers** page lists all active workers with their SharinPix Worker Name, linked Contact and Owner.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FsBV5cKGCoZE2uv9S6DPK%2Ffigure-04-workers-page.png?alt=media&amp;token=78b4a9ce-ff46-4b21-a1d7-38e98809055c" alt=""><figcaption></figcaption></figure>

### Create a worker

1. In the left navigation, select **Workers**.
2. Select **New**.
3. Enter the **SharinPix Worker Name** (required).
4. Optionally, select a **Contact** to link the worker to an existing Dynamics 365 contact.
5. Check that **Owner** is set, then select **Save**.

Once saved, the worker record also shows:

* **Link**: the worker's personal SharinPix link, which opens the SharinPix app with that worker's jobs.
* **UUID**: a read-only identifier for the worker in SharinPix.

{% hint style="warning" %}
The worker link contains an access token. Share it only with the worker it belongs to.
{% endhint %}

### Assign jobs to a worker

A worker can have several jobs. In the **Active Jobs** section of the worker record, select **New Job** to create a job for that worker, or **Add Existing Job** to assign a job that already exists.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FmyFCyPXNmtWpwQi5PaWf%2Ffigure-05-worker-record.png?alt=media&amp;token=aaf72c6e-74d9-4315-863e-e8161a4271b2" alt=""><figcaption></figcaption></figure>

## Manage jobs

The **Jobs** page lists all active jobs with their SharinPix Job Name, Due Date, Job Template Name and Created On date. To create a job, select **Jobs** in the left navigation, then select **New**.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2F7QjHL54QM9GaKLLHGkkp%2Ffigure-06-jobs-page.png?alt=media&amp;token=3ac3243a-8fda-4507-9254-bc6e26b686d5" alt=""><figcaption></figcaption></figure>

### View a job record

Open a job from the **Jobs** page or from the **Active Jobs** section of a worker record. The **General** tab has two areas:

* **Job details** (left): SharinPix Job Name (required), Description, Due Date, SharinPix Worker (the worker assigned to the job) and Job Template Name.
* **SharinPix panel** (right): the job name and due date, plus a **Line Items** tab and an **Activity** tab. The Line Items tab lists each line item with its status, such as *Not Started* or *In Progress*. Use the search box to find a specific line item.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FsHA1Ayhz4fm6DqbqQxR2%2Ffigure-07-job-record.png?alt=media&amp;token=3726c182-91a8-400f-9dd2-2fa4f98fd0cb" alt=""><figcaption></figcaption></figure>

### View job line items

Line items are the individual items that make up a job, such as pieces of equipment to inspect. To see them, open the **Job Line Items** tab on the job record. The list shows each line item's Name and Created On date.

Select **New Job Line Item** to create one, or **Add Existing Job Line Item** to add one that already exists.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FnULRYSBHtvChmciWydmO%2Ffigure-08-job-line-items.png?alt=media&amp;token=8360226f-2912-41a7-a48e-5b1be69ca90c" alt=""><figcaption></figcaption></figure>

## Install the SharinPix mobile app

Each worker needs the SharinPix mobile app on their smartphone. They use it to open their assigned jobs and capture photos, and everything they record is synced back to Dynamics 365. Without the app, workers can't open their personal SharinPix link or complete jobs in the field.

Ask each worker to download the free app for their device:

* **Android (Google Play):** [SharinPix on Google Play](https://play.google.com/store/apps/details?id=com.sharinpix.SharinPix\&hl=en)
* **iPhone (App Store):** [SharinPix on the App Store](https://apps.apple.com/us/app/sharinpix/id1199668730)

After installing the app, the worker opens the personal SharinPix link from their worker record (see [Create a worker](#create-a-worker)). The link opens the app with that worker's jobs.

## Complete jobs in the SharinPix mobile app

Field workers carry out their jobs in the SharinPix mobile app. When a worker opens their personal link, the app shows the FieldKnot workspace with every job assigned to them. Everything they record, including forms, photos and comments, is synced back to the job in Dynamics 365.

### Open a job

The home screen lists the worker's assigned jobs. Use the search box to find a job, and tap the sync icon at the top to refresh the list. Tap a job to open it. Each job shows its due date and two tabs:

* **Line Items**: the items to complete for the job, each with its status (for example, *Not Started* or *In Progress*).
* **Activity**: a history of everything recorded on the job, such as completed forms, comments and photos.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2F0Jg97hRRTwcYUiFe0td6%2Ffigure-09-mobile-job-list-and-line-items.png?alt=media&amp;token=38a556c7-ba5e-4d99-a71c-66f2a0cc45c2" alt=""><figcaption></figcaption></figure>

### Complete an inspection form

Tap a line item to open its form. Each line item has its own form, for example an HVAC Asset Inspection for an air handling unit or a Lift Safety Inspection for a lift.

1. Fill in the fields. Fields marked with a red asterisk (\*) are required. Tap **Now** to fill in the current date and time.
2. Go to the **Verdict** page and choose the inspection verdict. If the verdict is *Conditional*, describe the required corrective action.
3. Sign in the **Inspector signature** box, then tap **Submit**.
4. In the **Confirm Submission** message, tap **Submit**.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2F2GrF9ZtYB9hVGiLdtaXL%2Ffigure-10-inspection-form-verdict-confirm.png?alt=media&amp;token=628fd49e-cf7e-4b57-9b35-471bf6b4cc8f" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Once a form is submitted, it can no longer be changed.
{% endhint %}

### Capture photos

Some forms ask for photo evidence, such as the **Cabin photos** field in the Lift Safety Inspection form.

1. Tap the photo field to open the SharinPix camera.
2. Take one or more photos.
3. Tap the green check mark to return to the form.

The photos appear as thumbnails in the form. To remove one, tap the red bin icon on its thumbnail.

Workers can also use the **Comment** and **Capture** buttons on a job's **Activity** tab to add comments and photos directly to the job.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FayOpZR0Mxko1ktyBKEQ0%2Ffigure-11-lift-form-photos.png?alt=media&amp;token=04015865-19f4-4d8a-b7f0-4976c903d785" alt=""><figcaption></figcaption></figure>

### Track progress

When a worker submits a form, the line item's status changes from *Not Started* to *In Progress*, and the form is added to the job's **Activity** tab. Tap **View response** to open a read-only copy of the submitted form, with the date and time it was submitted.

The same line item statuses appear in the SharinPix panel of the job record in Dynamics 365.

<figure><img src="https://3252278260-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpygnwrMbmZIgsaWw1seA%2Fuploads%2FyxcKQDaFhkmB3YfeR8Qh%2Ffigure-12-progress-activity-response.png?alt=media&amp;token=521174d2-929e-4ad3-b017-df7ca89bdded" alt=""><figcaption></figcaption></figure>

## Get support

If you need help setting up or using FieldKnot or the SharinPix mobile app, email <support@sharinpix.com>. To help the team respond quickly, include your organization name, a short description of the issue and any relevant screenshots.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sharinpix.com/fieldknot/integrations/microsoft/fieldknot-setup-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
