Skip to main content

Agents

Agents provide access to, and data from, external software systems. Your organization can create agents for your internal, custom systems. Here™ provides agents for major third-party systems. The following systems are supported for integrations:

  • Microsoft 365

Agents are managed on the Agents page.

Add a Microsoft 365 search agent​

You can define at most one Microsoft 365 search agent. If a Microsoft 365 agent is already defined, the option to add one is not available.

  1. On the Agents tab, click Add Search Agent. The Add Search Agent dialog box opens.

  2. Click Microsoft 365. The Agent Configuration dialog box opens.

  3. Enter the following values. These values are provided by your Microsoft Entra ID administrator, from the Microsoft Entra admin center application.

    • Application (client) ID

    • Directory (tenant) ID

  4. Click Activate. A confirmation message tells you that a Microsoft 365 agent has been activated.

Add a custom search agent​

  1. On the Agents tab, click Add Search Agent. The Add Search Agent dialog box opens.

  2. Click Custom Agent. The Agent Definition dialog box opens.

  3. Enter the following values.

    • Name: A name that is shown to users, for example, to categorize search results.

    • ID: An ID that is unique for search agents in your Here™ platform.

    • URL: The URL of the application that provides the search agent.

    • Description: An explanation of the search agent, to help users understand what it provides.

  4. Click Activate. A confirmation message tells you that a custom agent has been activated with the Name value you entered.

Give users access to a search agent​

  1. Find the search agent you want to give users access to, click its Edit menu, and click Users. The Grant Users Access dialog box opens.

  2. Use the search field to filter users and groups by name.

  3. In the All listbox, select the checkbox next to the ID of any users or groups you want to have access to the search agent. Selected users and groups are listed in the Selected listbox.

  4. When you have selected exactly the users and groups you want to access this search agent, click Grant Access.

Edit the Microsoft 365 search agent definition​

Usually, there is no need to modify the Microsoft 365 search agent definition after it is initially set up. However, you might need to change it if your organization modifies its configuration of the Microsoft system.

  1. Find the Microsoft 365 search agent, click its Edit menu, and then click Agent Definition. The Edit Agent dialog box opens. The fields in this pane vary depending on the external system accessed by the search agent.

  2. Modify the Microsoft 365 search agent values. These values are provided by your Microsoft Entra ID administrator, from the Microsoft Entra admin center application.

    • Application (client) ID

    • Directory (tenant) ID

  3. Click Save Changes.

Edit a custom search agent definition​

  1. Find the custom search agent you want to modify, click its Edit menu, and then click Agent Definition. The Edit Custom Agent dialog box opens.

  2. Modify the field values as needed. You can change the ID value, but it must be unique across all custom search agents in your platform.

  3. When you are done making changes, click Save Changes. A confirmation message tells you that the search agent has been updated.

Deactivate a search agent​

By default, search agents are activated as soon as they are created. However, you can deactivate a search agent if you need to make it unavailable to users.

_If you deactivate a search agent, you might disrupt workflows for users who rely on it. As a best practice, ensure that users are informed of the deactivation ahead of time, especially if the search agent is critical to daily operations.

  • Find the active search agent you want to deactivate, and click its Deactivate button. The status indicator next to the search agent name changes from Active to Inactive. A confirmation message tells you that the search agent has been deactivated.

Activate a search agent​

If a search agent has been deactivated, you can re-activate it.

  1. Find the inactive search agent you want to activate, and click its Activate button. The corresponding Edit Agent dialog box opens (for either custom agents or pre-defined third party agents).

  2. Make any changes to the agent definition that are needed, and click Activate. The status indicator next to the search agent name changes from Inactive to Active. A confirmation message tells you that the search agent has been activated.

Delete a search agent​

If you delete a search agent, it is permanently removed from your platform. If you want to recover it, you must re-create it. As a best practice, ensure that no users rely on the search agent before you delete it.

  1. Find the search agent you want to delete.

  2. Click the Action ⋮ menu for the search agent, and then click Delete.

  3. In the confirmation dialog box, if you are sure you want to delete the search agent, click Delete Agent. A confirmation message tells you that the agent has been deleted.

Table of Contents