> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/es/automatizacion/runbooks/runbook-references/org/devices/notify-users-about-stale-devices_scheduled.md).

# Notificar a los usuarios sobre dispositivos obsoletos programado

Enviar un correo a los usuarios sobre dispositivos que no han usado desde hace tiempo

{% hint style="info" %}
Este es un runbook programado. Está diseñado para ejecutarse según una programación recurrente en lugar de activarse para un único objeto. Véase [Programación](/es/automatizacion/runbooks/scheduling.md) para obtener detalles sobre cómo configurar las programaciones del runbook.
{% endhint %}

### Descripción

Encuentra dispositivos de Intune que no han estado activos durante un número dado de días. Cada usuario principal recibe un correo electrónico con la lista de sus dispositivos inactivos y qué hacer con ellos. Los usuarios pueden incluirse o excluirse por grupo. Los correos electrónicos pueden redirigirse: todos a una dirección de anulación para pruebas, o los de cuentas que coinciden con un patrón de nombre a un destinatario dedicado. Los dispositivos inactivos sin usuario principal pueden agruparse en un único correo electrónico combinado.

### Casos de uso comunes

* Recordatorios automatizados a los usuarios sobre dispositivos inactivos para fomentar comprobaciones regulares de los dispositivos
* Gestión proactiva del ciclo de vida del dispositivo alertando a los usuarios antes de que los dispositivos se retiren
* Seguridad y cumplimiento al garantizar que los usuarios conozcan todos los dispositivos registrados a su nombre
* Notificaciones escalonadas mediante el `MaxDays` parámetro, por ejemplo, un primer recordatorio a los 30 días y un aviso final a los 60 días
* Filtrado del ámbito de usuarios para dirigirse a departamentos específicos o excluir cuentas de servicio
* Gestión centralizada de dispositivos sin usuario principal o pertenecientes a cuentas de Device Enrollment Manager (por ejemplo `DEM-*`) mediante destinatarios dedicados

### Configuración relacionada con el envío de correo electrónico

El envío de un informe por correo electrónico es opcional y solo ocurre cuando se proporciona un destinatario (`EmailTo`) se proporciona. La dirección del remitente se toma de la `RJReport.EmailSender` configuración del Tenant.

Este runbook envía correos electrónicos usando la API de Microsoft Graph. Para enviar correos electrónicos a través de la API de Graph, debe configurar una dirección de correo electrónico existente en la personalización del runbook.

Consulte la [documentación de configuración de informes de RealmJoin](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings) para obtener detalles sobre todas las configuraciones disponibles.

#### Marca del correo electrónico

El correo electrónico del informe tiene en cuenta la opción opcional `RJReport.Branding.*` del Tenant:

* **Imagen de encabezado y pie de página** – URL HTTPS públicas, PNG/JPEG/GIF, máx. 200 KB cada una
* **Enlace del pie de página** – destino de la imagen del pie de página
* **Color de acento y de texto** – valores hexadecimales de 6 dígitos, p. ej. `#0052cc`

Cuando estas configuraciones no están definidas, se usan los gráficos y colores predeterminados de RealmJoin. Una imagen que no se puede descargar o validar, o un valor de color no válido, nunca impide el correo electrónico del informe; en su lugar se usa el valor predeterminado correspondiente.

Instrucciones de configuración y requisitos de imagen: [Marca del correo electrónico](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings#email-branding-optional).

#### Información de contacto del Service Desk

La configuración opcional `RJReport.ServiceDesk_DisplayName`, `RJReport.ServiceDesk_EMail`, `RJReport.ServiceDesk_Phone` y `RJReport.ServiceDesk_PortalUrl` la configuración del tenant añade un bloque de contacto al final de cada correo de notificación. `ServiceDeskTicketUrl` también puede enlazar a un ticket.

### Selección del idioma de la plantilla de correo

Este runbook admite tres opciones de plantilla de correo electrónico:

1. **EN (inglés - predeterminado)**: Usa la plantilla integrada en inglés
2. **DE (alemán)**: Usa la plantilla integrada en alemán
3. **Custom**: Usa una plantilla personalizada de las personalizaciones del runbook

#### Uso de plantillas de correo personalizadas

Para usar una plantilla de correo personalizada (por ejemplo, en neerlandés, español o cualquier otro idioma), debes configurar el texto de la plantilla en las personalizaciones del runbook. Si falta algún parámetro de plantilla personalizada, el runbook volverá automáticamente a la plantilla en inglés.

**Ejemplo: plantilla personalizada**

```json
{
    "Runbooks": {
        "rjgit-org_devices_notify-users-about-stale-devices_scheduled": {
            "Parameters": {
                "CustomMailTemplateSubject": {
                    "Default": "Este es un asunto personalizado - Acción requerida: Dispositivos inactivos"
                },
                "CustomMailTemplateBeforeDeviceDetails": {
                    "Default": "**Esto está por encima de los Detalles del dispositivo.** \n\nEstimado usuario ..."
                },
                "CustomMailTemplateAfterDeviceDetails": {
                    "Default": "**Esto está por debajo de los Detalles del dispositivo.** \n\n## Qué debe hacer..."
                }
            }
        }
    }
}
```

**Notas importantes:**

* Usa `\n` para los saltos de línea en la configuración JSON
* Se admite el formato Markdown (##, ###, \*\*, -) en el texto de la plantilla
* Los tres parámetros de la plantilla personalizada (Subject, BeforeDeviceDetails, AfterDeviceDetails) deben configurarse
* Si falta algún parámetro, el runbook vuelve automáticamente a la plantilla en inglés (EN)
* Al usar la plantilla personalizada, selecciona "Custom - Use Template from Runbook Customizations" en el menú desplegable Mail Template

### Enrutamiento de correo electrónico

El runbook conoce tres destinos de enrutamiento independientes, comprobados en este orden de precedencia:

1. **Anulación global (pruebas):** Una dirección configurada `OverrideEmailRecipient` redirige **TODAS** envía los correos electrónicos - notificaciones de usuario, notificaciones enrutadas por patrón y el correo combinado para dispositivos sin usuario principal - a esa dirección. Ningún usuario final recibe un correo. Úselo para pruebas, pilotos o para redirigir todo a un buzón compartido o sistema de tickets. Se registra una advertencia en cada ejecución mientras la anulación esté activa.
2. **Usuarios que coinciden con el patrón:** Cuando `OverrideUserNamePattern` está establecido, las notificaciones de los usuarios cuyo UPN coincide con el patrón se envían a `UserNamePatternEmailRecipient` en lugar de al usuario. Todos los demás usuarios reciben su notificación directamente. Uso típico: cuentas de Device Enrollment Manager o kiosco (`DEM-*`, `KIOSK-*`) cuyos buzones nadie lee.
3. **Dispositivos sin usuario principal:** Cuando `SendNoPrimaryUserDevicesToOverride` está habilitado, los dispositivos inactivos sin usuario principal se agrupan en **un** correo electrónico combinado a `NoPrimaryUserEmailRecipient`. En caso contrario, estos dispositivos se omiten. Este ajuste nunca cambia cómo se enrutan las notificaciones de usuario.

Las configuraciones incompletas detienen el runbook con un error en lugar de enviar correos silenciosamente a los usuarios finales:

* `SendNoPrimaryUserDevicesToOverride` habilitado sin `NoPrimaryUserEmailRecipient` (y sin una anulación global) - error.
* `OverrideUserNamePattern` establecido sin `UserNamePatternEmailRecipient` (y sin una anulación global) - error.
* Un destinatario establecido sin su función (`NoPrimaryUserEmailRecipient` sin el interruptor, `UserNamePatternEmailRecipient` sin un patrón) - advertencia, el destinatario se ignora.

Mientras la anulación global esté activa, no es necesario configurar los destinatarios dedicados: de todos modos, todo va al destinatario de la anulación.

#### Patrón de nombre de usuario

`OverrideUserNamePattern` acepta uno o más patrones comodín (separados por comas) que se comparan con el UPN del usuario principal, por ejemplo `DEM-*` para cuentas de Device Enrollment Manager o `DEM-*,KIOSK-*` para múltiples patrones. La coincidencia no distingue entre mayúsculas y minúsculas y usa la sintaxis de comodines de PowerShell (`*`, `?`). Cuando el enrutamiento por patrón está activo, el runbook registra una advertencia indicando qué patrón se redirige a qué destinatario.

**Notas importantes:**

* Todos los parámetros de destinatario aceptan varias direcciones separadas por comas
* Los dispositivos sin usuario principal omiten el filtrado por ámbito de usuario (no tienen un usuario con el que coincidir en los grupos)
* Los usuarios que coinciden con el patrón siguen estando sujetos primero al filtrado por ámbito de usuario; los usuarios excluidos por el ámbito no generan ninguna notificación
* El correo combinado para dispositivos sin usuario principal usa una redacción administrativa (sin pasos de acción para el usuario final), independientemente de las plantillas personalizadas
* Las notificaciones redirigidas indican al usuario afectado en el asunto y el cuerpo del correo

### Ubicación

Organización → Dispositivos → Notificar a los usuarios sobre dispositivos inactivos (Programado)

**Nombre completo del runbook**

rjgit-org\_devices\_notify-users-about-stale-devices\_scheduled

### Detalles

| Propiedad          | Valor                                                                                    |
| ------------------ | ---------------------------------------------------------------------------------------- |
| Versión            | 1.7.0                                                                                    |
| Módulos requeridos | <p>RealmJoin.RunbookHelper (>= 0.8.10)<br>Microsoft.Graph.Authentication (>= 2.41.2)</p> |
| Programable        | sí                                                                                       |

### Permisos

#### Permisos de aplicación

* **Tipo**: Microsoft Graph
  * DeviceManagementManagedDevices.Read.All
    * *Lee los dispositivos administrados por Intune filtrados por lastSyncDateTime para encontrar dispositivos inactivos y sus usuarios principales*
  * Directory.Read.All
    * *Lee el nombre del tenant para el pie del correo y resuelve los identificadores de usuario para el filtrado por ámbito de grupo*
  * Group.Read.All
    * *Enumera los miembros de los grupos de inclusión/exclusión para filtrar qué usuarios principales reciben la notificación*
  * Mail.Send
    * *Envía los correos de notificación de dispositivos inactivos a cada usuario principal o al destinatario de la anulación*

### Parámetros

#### Días

Los dispositivos inactivos durante al menos este número de días se consideran inactivos.

| Propiedad                      | Valor              |
| ------------------------------ | ------------------ |
| Requerido                      | falso              |
| Valor predeterminado           | 30                 |
| Tipo                           | Int32              |
| Nombre para mostrar del portal | Días sin actividad |

#### MaxDays

Solo se incluyen los dispositivos inactivos durante como máximo este número de días. Déjelo en blanco para no establecer un límite superior.

| Propiedad                      | Valor                        |
| ------------------------------ | ---------------------------- |
| Requerido                      | falso                        |
| Valor predeterminado           |                              |
| Tipo                           | Int32                        |
| Nombre para mostrar del portal | Máximo de días sin actividad |

#### Windows

Incluye dispositivos Windows.

| Propiedad                      | Valor                          |
| ------------------------------ | ------------------------------ |
| Requerido                      | falso                          |
| Valor predeterminado           | Verdadero                      |
| Tipo                           | Booleano                       |
| Nombre para mostrar del portal | ¿Incluir dispositivos Windows? |

#### MacOS

Incluye dispositivos macOS.

| Propiedad                      | Valor                        |
| ------------------------------ | ---------------------------- |
| Requerido                      | falso                        |
| Valor predeterminado           | Verdadero                    |
| Tipo                           | Booleano                     |
| Nombre para mostrar del portal | ¿Incluir dispositivos macOS? |

#### iOS

Incluye dispositivos iOS y iPadOS.

| Propiedad                      | Valor                      |
| ------------------------------ | -------------------------- |
| Requerido                      | falso                      |
| Valor predeterminado           | Verdadero                  |
| Tipo                           | Booleano                   |
| Nombre para mostrar del portal | ¿Incluir dispositivos iOS? |

#### Android

Incluye dispositivos Android.

| Propiedad                      | Valor                          |
| ------------------------------ | ------------------------------ |
| Requerido                      | falso                          |
| Valor predeterminado           | Verdadero                      |
| Tipo                           | Booleano                       |
| Nombre para mostrar del portal | ¿Incluir dispositivos Android? |

#### EmailFrom

Dirección del remitente del correo de notificación. Se toma de la configuración del tenant RJReport.EmailSender.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### BrandingHeaderImageUrl

Imagen de encabezado del correo electrónico del informe (URL HTTPS, PNG/JPEG/GIF, máx. 200 KB). Se toma de la configuración del Tenant RJReport.Branding.HeaderImageUrl; se usa el encabezado predeterminado de RealmJoin cuando está vacío.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### BrandingFooterImageUrl

Imagen de pie de página del correo electrónico del informe (URL HTTPS, PNG/JPEG/GIF, máx. 200 KB). Se toma de la configuración del Tenant RJReport.Branding.FooterImageUrl; se usa el pie de página predeterminado de RealmJoin cuando está vacío.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### BrandingFooterLink

Enlace asociado a la imagen de pie de página del correo electrónico del informe. Se toma de la configuración del Tenant RJReport.Branding.FooterLink; realmjoin.com se usa cuando está vacío.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### BrandingAccentColor

Color de acento del correo electrónico del informe como valor hexadecimal de 6 dígitos. Se toma de la configuración del Tenant RJReport.Branding.AccentColor; se usa el valor predeterminado de RealmJoin cuando está vacío o es inválido.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### BrandingTextColor

Color de texto del correo electrónico del informe como valor hexadecimal de 6 dígitos. Se toma de la configuración del Tenant RJReport.Branding.TextColor; se usa el valor predeterminado de RealmJoin cuando está vacío o es inválido.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### ServiceDeskDisplayName

Nombre de la mesa de servicio que se muestra en el correo. Se toma de la configuración del tenant RJReport.ServiceDesk\_DisplayName.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### ServiceDeskEmail

Dirección de correo electrónico de la mesa de servicio que se muestra en el correo. Se toma de la configuración del tenant RJReport.ServiceDesk\_EMail.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### ServiceDeskPhone

Número de teléfono de la mesa de servicio que se muestra en el correo. Se toma de la configuración del tenant RJReport.ServiceDesk\_Phone.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### ServiceDeskPortalUrl

Enlace al portal de la mesa de servicio que se muestra en el correo. Se toma de la configuración del tenant RJReport.ServiceDesk\_PortalUrl.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### ServiceDeskTicketUrl

Enlace al ticket del servicio de asistencia que se muestra en el correo. Déjelo vacío si no desea enlace.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado |                                                             |
| Tipo                 | Cadena                                                      |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### UseUserScope

Indica si los usuarios se filtran por pertenencia a grupos. Se define mediante la opción "¿Filtrar usuarios por grupo?".

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado | Falso                                                       |
| Tipo                 | Booleano                                                    |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### IncludeUserGroup

Solo se notifica a los usuarios de este grupo.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           |                                                             |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Incluir usuarios del grupo                                  |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

#### ExcludeUserGroup

Los usuarios de este grupo no reciben notificación.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           |                                                             |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Excluir usuarios del grupo                                  |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

#### OverrideEmailRecipient

Envía todos los correos, incluidos los enrutados por patrón y el correo combinado, a estas direcciones en lugar de a los destinatarios normales. Para pruebas, pilotos o un sistema de tickets.

| Propiedad                      | Valor                         |
| ------------------------------ | ----------------------------- |
| Requerido                      | falso                         |
| Valor predeterminado           |                               |
| Tipo                           | Cadena                        |
| Nombre para mostrar del portal | Redirigir todos los correos a |

#### OverrideUserNamePattern

Patrones comodín para nombres de usuario, separados por comas, por ejemplo DEM-*,KIOSK-*. Los correos de los usuarios coincidentes van en su lugar a "Destinatario para usuarios que coinciden con el patrón".

| Propiedad                      | Valor                                  |
| ------------------------------ | -------------------------------------- |
| Requerido                      | falso                                  |
| Valor predeterminado           |                                        |
| Tipo                           | Cadena                                 |
| Nombre para mostrar del portal | Patrón de nombre del usuario principal |

#### UserNamePatternEmailRecipient

Direcciones que reciben los correos de los usuarios que coinciden con el patrón, separadas por comas. Requerido cuando se establece un patrón y no hay ninguna anulación activa.

| Propiedad                      | Valor                                                  |
| ------------------------------ | ------------------------------------------------------ |
| Requerido                      | falso                                                  |
| Valor predeterminado           |                                                        |
| Tipo                           | Cadena                                                 |
| Nombre para mostrar del portal | Destinatario para usuarios que coinciden con el patrón |

#### SendNoPrimaryUserDevicesToOverride

Agrupa los dispositivos inactivos que no tienen usuario principal en un único correo combinado para el "Destinatario para dispositivos sin usuario principal". Esos dispositivos ignoran el filtro de usuario.

| Propiedad            | Valor                                                       |
| -------------------- | ----------------------------------------------------------- |
| Requerido            | falso                                                       |
| Valor predeterminado | Falso                                                       |
| Tipo                 | Booleano                                                    |
| Oculto en el portal  | sí (preconfigurado mediante la personalización del runbook) |

#### NoPrimaryUserEmailRecipient

Direcciones para el correo combinado, separadas por comas. Requerido cuando el correo combinado está habilitado y no se ha establecido ninguna anulación.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           |                                                             |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Destinatario para dispositivos sin usuario principal        |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

#### MailTemplateLanguage

Inglés, alemán o la plantilla personalizada de la personalización del runbook; se usa inglés cuando la plantilla personalizada está vacía.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           | EN                                                          |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Plantilla de correo                                         |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

#### CustomMailTemplateSubject

Asunto del correo cuando se usa la plantilla personalizada.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           |                                                             |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Personalizado: asunto del correo                            |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

#### CustomMailTemplateBeforeDeviceDetails

Texto encima de la lista de dispositivos cuando se usa la plantilla personalizada. Se permite Markdown.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           |                                                             |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Personalizado: texto antes de la lista de dispositivos      |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

#### CustomMailTemplateAfterDeviceDetails

Texto debajo de la lista de dispositivos cuando se usa la plantilla personalizada. Se permite Markdown.

| Propiedad                      | Valor                                                       |
| ------------------------------ | ----------------------------------------------------------- |
| Requerido                      | falso                                                       |
| Valor predeterminado           |                                                             |
| Tipo                           | Cadena                                                      |
| Nombre para mostrar del portal | Personalizado: texto después de la lista de dispositivos    |
| Oculto en el portal            | sí (preconfigurado mediante la personalización del runbook) |

[Volver a la vista general de referencia del runbook](/es/automatizacion/runbooks/runbook-references.md)


---

# 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.realmjoin.com/es/automatizacion/runbooks/runbook-references/org/devices/notify-users-about-stale-devices_scheduled.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.
