# IDP Admin Settings

## What are IDP Settings?

The intelligent document processing (IDP) settings allow ProcessMaker Administrators to connect to a ProcessMaker IDP instance. ProcessMaker Platform must be authenticated to a ProcessMaker IDP instance so that IDP connectors configured in business processes can process documents during Requests.

## View IDP Settings

<details>

<summary>Permissions</summary>

Your user account or group membership must have the "Settings: View Settings" permission to view ProcessMaker IDP server settings unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](https://processmaker.gitbook.io/idp/processmaker-administrator-and-designer/broken-reference) permissions or ask your Administrator for assistance.

</details>

Follow these steps to view the IDP settings:

1. Ensure that you are [logged on](https://docs.processmaker.com/docs/participant-basics#log-on-to-processmaker-platform) to ProcessMaker.
2. Click the **Admin** option from the top menu. The **Users** page displays.
3. Click the **Settings** icon <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FMLcMHIkBqdoZiHBYzVIR%2FSettings%20Icon.png?alt=media&#x26;token=9239210c-e46e-4ba8-b99f-8045b66c127e" alt="" data-size="line"> from the left sidebar to view all settings.
4. From the **Settings** panel on the left, expand the **Integrations** section.
5. Select **IDP** to view the following details:
   * **Setting:** The **Setting** column displays the IDP Setting name.
   * **Configuration:** The **Configuration** column displays the value of the setting and how it is configured.

<figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FEE7J4jjQSJdeRInXDiTg%2FIDP%20Settings.png?alt=media&#x26;token=23005c57-d19c-438d-8dc5-5694125b2142" alt=""><figcaption><p>IDP tab displays settings to authenticate to ProcessMaker IDP and configure folders from which to store documents</p></figcaption></figure>

{% hint style="info" %}

* Click the **Edit icon** <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FlK3GWuoV42Xl11c8XJPz%2FEdit%20Icon.png?alt=media&#x26;token=caef4ed8-4bf6-4152-9c8e-e98091de3f54" alt="" data-size="line"> to change a setting. For more information on different IDP configurations, see [Configure IDP Settings](#configure-idp-settings).
* Click the **Copy to Clipboard** icon <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2F51fbQR148ahJ2sQcSbby%2FCopy%20Icon.png?alt=media&#x26;token=ce78e56c-8101-47f3-b4f8-69357952fc95" alt="" data-size="line"> to copy the value of a setting.
* Click the **Clear** icon <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FSLwlI354b2NFlJvrbkFF%2FTrash%20Icon.png?alt=media&#x26;token=962a5b6e-bdc8-4f89-bc65-34c163aa6561" alt="" data-size="line"> to clear the value of a setting.&#x20;
  {% endhint %}

## Configure IDP Settings

<details>

<summary>Permissions</summary>

Your user account or group membership must have the "Settings: View Settings" permission to view ProcessMaker IDP server settings unless your user account has the **Make this user a Super Admin** setting selected.

See the [Settings](https://processmaker.gitbook.io/idp/processmaker-administrator-and-designer/broken-reference) permissions or ask your Administrator for assistance.

</details>

The following information is required to authenticate with ProcessMaker IDP:

* **Client ID:** The client ID is the unique key for your ProcessMaker Platform instance to authenticate IDP connectors implemented in your ProcessMaker IDP instance.
* **Client secret:** The client secret is the time-sensitive and private code that your ProcessMaker IDP instance acknowledges to authenticate IDP connectors when connecting.
* **Token URL:** The token URL references the valid authentication token that authenticates IDP connectors when during authentication.

To locate the client ID and client secret, both of which are private to your organization, contact your Customer Success Manager.&#x20;

### Authenticate with ProcessMaker IDP

Follow these steps to authenticate with ProcessMaker IDP.

1. [View your IDP settings](#view-idp-settings).
2. From the **Client ID** setting, click the **Edit** <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FlK3GWuoV42Xl11c8XJPz%2FEdit%20Icon.png?alt=media&#x26;token=caef4ed8-4bf6-4152-9c8e-e98091de3f54" alt="" data-size="line"> icon. The **Client ID** setting displays. This is a required setting.<br>

   <div align="left"><figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FtVZUUsnLStk96lBzIxIv%2FClient%20ID%20-%20IDP.png?alt=media&#x26;token=a1bb9a72-54a6-4991-9502-97655361e0c9" alt="" width="538"><figcaption></figcaption></figure></div>
3. Enter the integration key for your ProcessMaker IDP instance, and then click **Save**.
4. From the **Client Secret** setting, click the **Edit** <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FlK3GWuoV42Xl11c8XJPz%2FEdit%20Icon.png?alt=media&#x26;token=caef4ed8-4bf6-4152-9c8e-e98091de3f54" alt="" data-size="line"> icon. The **Client Secret** setting displays. This is a required setting.<br>

   <div align="left"><figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FQLnxJnI8KvrnwuvqdLIb%2FClient%20Secret%20-%20IDP.png?alt=media&#x26;token=67f9af75-7898-417a-aa7d-d9c5136482ad" alt="" width="536"><figcaption></figcaption></figure></div>
5. Enter the client secret for your ProcessMaker IDP instance, and then click **Save**.
6. From the **Host URL** setting, click the **Edit** <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FlK3GWuoV42Xl11c8XJPz%2FEdit%20Icon.png?alt=media&#x26;token=caef4ed8-4bf6-4152-9c8e-e98091de3f54" alt="" data-size="line"> icon. The **Host URL** setting displays. This is a required setting.<br>

   <div align="left"><figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2F5WDHOuhqlk4nVfd48YmU%2FHost%20URL%20-%20IDP.png?alt=media&#x26;token=2a5f2b69-3b5e-45b0-a5f7-59194fda27bd" alt="" width="537"><figcaption></figcaption></figure></div>
7. From the **Token URL** setting, click the **Edit** <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FlK3GWuoV42Xl11c8XJPz%2FEdit%20Icon.png?alt=media&#x26;token=caef4ed8-4bf6-4152-9c8e-e98091de3f54" alt="" data-size="line"> icon. The **Token URL** setting displays. This is a required setting.<br>

   <div align="left"><figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FMGXnfzNfMosf6ohARDTm%2FToken%20URL%20-%20IDP.png?alt=media&#x26;token=b0ee49e4-9248-4ff5-9b40-63f5847218a4" alt="" width="539"><figcaption></figcaption></figure></div>
8. Enter the URL that references the valid authentication token to your ProcessMaker IDP instance, and then click **Save**.
9. Click the **Authorize Account** button.

### Select IDP Folders for Saving Processed Documents

Prior to selecting the folders to store documents for intelligent document processing (IDP), ensure the following:

* [Folders (dossiers) exist in your ProcessMaker IDP instance](https://processmaker.gitbook.io/idp/idp-user/document-management/files-and-folders). If they do not exist, you can create them through a request variable in the [IDP Connector](https://processmaker.gitbook.io/idp/processmaker-administrator-and-designer/idp-connector-in-processes).
* [You have authenticated with your ProcessMaker IDP instance](#authenticate-with-processmaker-idp).&#x20;

{% hint style="warning" %}
The indicator ***Not Authorized*** will be displayed beside the folder selection setting until your [ProcessMaker IDP instance authenticates with the ProcessMaker Platform](#authenticate-with-processmaker-idp). After successful authentication, the indicator will change to ***Authorized.***
{% endhint %}

<figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FobNSuJZpJLFvvhb3td64%2Fimage.png?alt=media&#x26;token=a104b199-b07c-4372-9e93-e0b67efe1d26" alt=""><figcaption></figcaption></figure>

Follow these steps to select IDP folders for storing documents uploaded in a Process:

1. [View your IDP settings](#view-idp-settings).
2. From the **Select Available Folders** setting, click the **Edit** <img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FlK3GWuoV42Xl11c8XJPz%2FEdit%20Icon.png?alt=media&#x26;token=caef4ed8-4bf6-4152-9c8e-e98091de3f54" alt="" data-size="line"> icon. The **Select available folders** setting displays.<br>

   <div align="left"><figure><img src="https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2FacQjgyNcaKAuhCA01lcZ%2FFolders%20-%20IDP.png?alt=media&#x26;token=4b5ae202-8ddc-4d9f-84a0-633f5e0be3f9" alt="" width="537"><figcaption></figcaption></figure></div>
3. Click the drop-down menu to select one or more existing folders from which to store documents for processing. Click the Remove ![](https://3188697301-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7FFioLROF5EqDMa8cWdB%2Fuploads%2F0UNEvBUVuDGcMkIDcoaX%2FRemove%20Group%20user%20-%20Admin.png?alt=media\&token=e44946a0-4f61-4935-933c-358f7a8a548f) icon to remove an added folder.
4. Click **Save**.


---

# Agent Instructions: 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:

```
GET https://processmaker.gitbook.io/idp/processmaker-administrator-and-designer/idp-admin-settings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
