# Ethos Integration Settings

The **Ellucian Ethos Integration Settings** allow administrators to configure the connection between ProcessMaker and Ellucian Ethos. Admin access is required, and this setup must be completed before the API Monitor can begin monitoring configured Ethos APIs.

***

## Establish Connection to Ethos

Follow these steps to define the base configuration for your Ethos integration.

1. Login using the provided URL and Admin credentials.<br>

   <figure><img src="/files/EqPIELQIwPjEkcNrPism" alt=""><figcaption></figcaption></figure>
2. In the **Workspace Name** setting, enter the name of your workspace. This is used internally to identify the integration environment.
3. In the **Ellucian Ethos Integration Base URL** setting, enter the URL for accessing Ellucian Ethos APIs.&#x20;
4. In the **Ellucian Ethos Integration API Key** setting, enter the API key used to authenticate requests to the Ethos API. This should be generated from your Ellucian Ethos environment and kept secure.
5. From the **Time Zone** setting, select the appropriate time zone for your institution. This ensures that all scheduled checks and timestamped logs align with your local time.
6. Click **Save Setup** to save the changes.&#x20;

{% hint style="warning" %}
**Note:**

* Only users with Admin privileges can access or update these settings.
* The **API Key** field is masked for security. Click the eye icon to view or verify it if needed.
  {% endhint %}

***

## **Configure Endpoints**

To begin monitoring your Ethos APIs, define the specific endpoints (resources) you want to track. Follow these steps to add and configure each API resource, including its version, optional filters, and status. Once configured, these endpoints will be monitored\
&#x20;based on your scheduled checks.

1. Login using the provided URL and Admin credentials.
2. Click the **Designer** option from the top menu.
3. From the **Assets** panel, hover over the **Collections** icon, and then select **View All Collections**.

   ![](https://cdn.document360.io/2d311614-fcb7-4424-8b4c-d4d3091eebeb/Images/Documentation/View%20Collections%20\(Fall%202024\).png)
4. Find the Collection named `api-check-services`.<br>

   <figure><img src="/files/z5PynoGAcVvYuzS9CTrX" alt=""><figcaption></figcaption></figure>
5. Click on the **Records** icon <img src="/files/6GRUnKSHaiKY0mrvEsz9" alt="" data-size="line"> to view this Collection.<br>

   <figure><img src="/files/h2POi77CZ3D3xebjfAiu" alt=""><figcaption></figcaption></figure>
6. Click **+Record** to add a new record to the Collection. <br>

   <figure><img src="/files/ZYBatjWucq693A03p6F5" alt=""><figcaption></figcaption></figure>
7. In the **Resource** field, enter the name of the Ethos API endpoint to monitor (e.g., `institution-jobs`).
8. In the **Version** field, enter the API version to use (e.g., `v1.0`). This should match the version defined in your Ethos environment.
9. Optionally, use the **Criteria** field to filter based on specific query parameters.
10. Optionally, in the **Filter** field, define any custom filter to apply. If no filter is needed, enter  `none`.
11. Use the toggle labeled **Enabled** to activate or deactivate this API endpoint.
12. Once all fields are configured, click the **Save** button to apply the settings.
13. Repeat these steps to add additional endpoints.&#x20;
14. &#x20;**Setup** to save the changes.&#x20;

{% hint style="warning" %}
**Note:** Only users with Admin privileges can access or update these endpoints.
{% endhint %}


---

# 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/higher-ed/ethos-api-monitor/ethos-integration-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.
