Crear y administrar plantillas de solicitud web

Licencia:

Esta funcionalidad requiere una licencia para el rol de ArcGIS Workflow Manager Server Advanced.

Las plantillas de solicitud web se pueden usar en combinación con actividades de trabajo para enviar automáticamente solicitudes web a extremos REST cuando se realicen actividades de trabajo específicas. Por ejemplo, la plantilla de solicitud web se puede configurar para recuperar datos o publicar actualizaciones en un sistema de terceros cuando se actualiza un trabajo.

Crear plantillas de solicitud web

Para crear plantillas de solicitud web, siga los pasos siguientes:

1. Acceda a la aplicación web de Workflow Manager.
2. Haga clic en la pestaña Diseño.

   Aparece la página Diseño.

   Nota:

   Si no tiene suficientes privilegios, la pestaña Diseño no estará disponible.

3. Haga clic en Plantillas .

   Nota:

   Si no tiene suficientes privilegios, el botón Plantillas no está disponible.

4. Haga clic en la pestaña Solicitud web.

   Aparece el panel Solicitud web.

   Nota:

   Si no tiene suficientes privilegios, la pestaña Solicitud web no estará disponible.

5. Haga clic en Crear nuevo en el panel Solicitud web.
6. Proporcione un nombre para la plantilla de solicitud web en el cuadro de texto Nombre.
7. Haga clic en la flecha desplegable Dirección URL y seleccione el tipo de solicitud que desea enviar.
8. Escriba la dirección URL del extremo REST en el cuadro de texto Dirección URL.
9. Si lo desea, agregue variables de ruta a la dirección URL usando la siguiente sintaxis:

   https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/

   Las variables de ruta aparecen en la sección Variables de ruta.

10. Si lo desea, también puede agregar parámetros de consulta a la plantilla de solicitud web.
    1. Haga clic en Agregar clave y valor en la sección Parámetros de consulta.
    2. Proporcione una clave en el cuadro de texto Clave.

       También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

    3. Proporcione un valor en el cuadro de texto Valor.

       También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

    4. Deje la casilla de verificación Habilitado activada.
    5. Repita los subpasos a-d para agregar más pares de clave-valor.
11. Si ha agregado variables de ruta a la dirección URL, proporcione un valor para cada variable en la sección Variables de ruta.

    También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

    Sugerencia:

    Haga clic en La entrada admite expresiones de Arcade y elija una expresión de ArcGIS Arcade para agregarla su cuadro de texto asociado.

12. Haga clic en la pestaña Autorización.
13. Elija el método de autenticación del extremo REST y proporcione información de autenticación según sea necesario.

    Precaución:

    La información de autenticación proporcionada no está cifrada. Para proteger la información, agregue una configuración definida por el usuario cifrada para almacenar la información y hacer referencia a ella en la plantilla utilizando propiedades de trabajo dinámicas.

    Nota:

    La opción Token federado solo es compatible con los servicios publicados en el mismo sitio de Enterprise que Workflow Manager.

    1. De manera opcional, si elige la opción Clave API o Token de portador,haga clic en Generar token alternativamente desde el extremo.

       La configuración de Generar token desde el extremo aparece en el panel Solicitud web.

    2. Configure los ajustes del token para generar un token para la solicitud web.
14. Si lo desea, haga clic en la pestaña Encabezados para agregar pares de clave y valor de encabezado personalizados a la plantilla de solicitud web.
    1. Haga clic en Agregar clave y valor en la sección Encabezados personalizados.
    2. Proporcione una clave en el cuadro de texto Clave.

       También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

    3. Proporcione un valor en el cuadro de texto Valor.

       También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

    4. Deje la casilla de verificación Habilitado activada.
    5. Repita los subpasos a-d para agregar más pares de clave-valor.
15. Si lo desea, haga clic en la pestaña Cuerpo para agregar datos a la solicitud web.

    El cuerpo de la solicitud admite pares de clave-valor de datos de solicitud, pares de clave-valor codificados por URL y datos sin procesar en formato JSON o de texto sin formato.

    Sugerencia:

    También puede utilizar una expresión de ArcGIS Arcade para recuperar la configuración definida por el usuario o proporcionar valores dinámicos al texto del cuerpo.

16. Si lo desea, si tiene una licencia para ArcGIS Workflow Manager Server Advanced, configure los ajustes de salida de la plantilla de solicitud web.

    Nota:

    Para probar el valor de salida de la solicitud web, antes se debe completar la plantilla.

17. Si lo desea, haga clic en la pestaña Probar y luego en Probar respuesta para enviar la solicitud configurada y mostrar su respuesta.

    Si la solicitud web contiene expresiones de Arcade específicas del trabajo, debe activar Incluir Id. de trabajo y proporcionar un Id. de trabajo en el cuadro de texto Id. de trabajo para formatear correctamente la solicitud.

Configurar los ajustes de token

Si el extremo REST requiere un token para la autenticación, siga estos pasos para configurar la plantilla de solicitud web y generar un token que se pueda utilizar para autenticar la solicitud web.

1. En la pestaña Autorización, elija la opción Clave API o Token de portador y haga clic en Generar token alternativamente desde el extremo.

   La configuración de Generar token desde el extremo aparece en el panel Solicitud web.

2. Haga clic en la flecha desplegable Dirección URL y seleccione el tipo de solicitud que desea enviar.
3. Escriba la dirección URL del extremo REST en el cuadro de texto Dirección URL.
4. Si lo desea, agregue variables de ruta a la dirección URL usando la siguiente sintaxis:

   https://gisserver.domain.com/webadaptorname/apps/workflowmanager/:pathVariable/

   Las variables de ruta aparecen en la sección Variables de ruta.

5. Si lo desea, también puede agregar parámetros de consulta a la solicitud web.
   1. Haga clic en Agregar clave y valor en la sección Parámetros de consulta.
   2. Proporcione una clave en el cuadro de texto Clave.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   3. Proporcione un valor en el cuadro de texto Valor.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
6. Si ha agregado variables de ruta a la dirección URL, proporcione un valor para cada variable en la sección Variables de ruta.

   También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   Sugerencia:

   Haga clic en La entrada admite expresiones de Arcade y elija una expresión de ArcGIS Arcade para agregarla su cuadro de texto asociado.

7. Si lo desea, haga clic en la pestaña Encabezados para agregar pares de clave y valor de encabezado personalizados a la solicitud web.
   1. Haga clic en Agregar clave y valor en la sección Parámetros de consulta.
   2. Proporcione una clave en el cuadro de texto Clave.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   3. Proporcione un valor en el cuadro de texto Valor.

      También puede usar expresiones de ArcGIS Arcade para proporcionar un valor dinámico.

   4. Deje la casilla de verificación Habilitado activada.
   5. Repita los subpasos a-d para agregar más pares de clave-valor.
8. Si lo desea, haga clic en la pestaña Cuerpo para agregar datos a la solicitud web.

   El cuerpo de la solicitud admite pares de clave-valor de datos de solicitud, pares de clave-valor codificados por URL y datos sin procesar en formato JSON o de texto sin formato.

   Sugerencia:

   También puede utilizar una expresión de ArcGIS Arcade para recuperar la configuración definida por el usuario o proporcionar valores dinámicos al texto del cuerpo.

9. Haga clic en la pestaña Token.
10. Haga clic en el botón de alternancia Modo de prueba en la sección Token.
11. Pegue un ejemplo de la respuesta del extremo REST en el cuadro de texto Respuesta de muestra.

    Ejemplo de respuesta en formato JSON:

    {"access_token": "12345abcde",
    "expires_in":7199,
    "spatialReference": {
      "wkid": 4326,
      "latestWkid": 4326
    },
    "locations": [
      {
        "name": "380 New York Street",
        "extent": {
          "xmin": -117.196701,
          "ymin": 34.055489
        }
      }
    ]}

12. Proporcione un nombre para el token en el cuadro de texto Valor de salida.

    Este es el nombre que se utiliza en la plantilla de solicitud web para hacer referencia al token generado.

13. Proporcione una expresión JSONPath en notación de punto o notación entre corchetes en el cuadro de texto Ruta de extracción para analizar la respuesta y devolver el token generado.

    Ejemplo de JSONPath en notación de puntos:

    $.access_token

    Ejemplo de JSONPath en notación entre corchetes:

    $['access_token']

    El valor aparece en la columna Resultado de muestra.

14. Haga clic en Volver para seguir configurando la solicitud web.

Configurar los ajustes de salida

Licencia:

Esta funcionalidad requiere una licencia para el rol de ArcGIS Workflow Manager Server Advanced.

El rol de ArcGIS Workflow Manager Server Advanced le permite guardar la respuesta del extremo REST como un archivo, adjuntarla a la plantilla y configurarla como valores de salida personalizados. Los valores de salida se pueden utilizar para determinar la ruta que sigue el flujo de trabajo o usarse como entradas para otros pasos del flujo de trabajo. Si no se configura un valor de salida para la plantilla, el código de estado HTTP se almacena como el valor de salida de la plantilla. Para configurar los ajustes de salida, haga lo siguiente:

1. Haga clic en la pestaña Salida.
2. Si lo desea, haga clic en el botón de alternancia Habilitado de la sección Adjuntar respuesta para guardar la respuesta del extremo REST como un archivo y adjuntarla a la plantilla.
3. Si lo desea, siga estos subpasos para configurar el nombre del adjunto y la carpeta en la que se almacenará:
   1. Proporcione el nombre de la carpeta en la que se almacenará el adjunto en el cuadro de texto Nombre de carpeta.

      El nombre de la carpeta no puede contener una ruta de sistema de archivos ni caracteres especiales. Si no se proporciona un nombre de carpeta, se crea automáticamente una carpeta denominada General.

      Nota:

      La carpeta está contenida dentro del elemento de flujo de trabajo y no es una ruta de sistema de archivos.

   2. Seleccione una de las siguientes opciones de Nombre de adjunto:
      • Generado automáticamente: nombra automáticamente el adjunto con la siguiente sintaxis: <StepName>_<RunDate>_<RunTime>.
      • Personalizado: permite proporcionar un nombre de adjunto personalizado.
4. Si lo desea, siga estos subpasos para configurar valores de salida personalizados para la respuesta del extremo REST:
   1. Haga clic en el botón de alternancia Modo de prueba en la sección Valores de salida.
   2. Pegue un ejemplo de la respuesta del extremo REST en el cuadro de texto Respuesta de muestra.

      Ejemplo de respuesta en formato JSON:

      {"access_token": "",
      "expires_in":7199,
      "spatialReference": {
        "wkid": 4326,
        "latestWkid": 4326
      },
      "locations": [
        {
          "name": "380 New York Street",
          "extent": {
            "xmin": -117.196701,
            "ymin": 34.055489
          }
        }
      ]}

   3. Haga clic en Agregar salida y ruta.
   4. Proporcione un nombre para el valor de salida en el cuadro de texto Valor de salida.

      Este es el nombre del valor que se utiliza para obtener el valor de salida personalizado.

   5. Proporcione una expresión JSONPath en notación de puntos o notación entre corchetes para el valor que desea almacenar en el cuadro de texto Ruta de extracción.

      Ejemplo de JSONPath en notación de puntos:

      $.locations.0.name

      Ejemplo de JSONPath en notación entre corchetes:

      $['locations'][0]['name']

      El valor aparece en la columna Resultado de muestra.

   6. Si lo desea, repita los subpasos c-e para agregar más valores de salida personalizados.
5. Haga clic en Guardar para guardar los cambios.

Editar plantillas de solicitud web

Para editar plantillas de solicitud web, haga lo siguiente:

1. Acceda a la aplicación web de Workflow Manager.
2. Haga clic en la pestaña Diseño.

   Aparece la página Diseño.

   Nota:

   Si no tiene suficientes privilegios, la pestaña Diseño no estará disponible.

3. Haga clic en Plantillas .

   Nota:

   Si no tiene suficientes privilegios, el botón Plantillas no está disponible.

4. Haga clic en la pestaña Solicitud web.

   Aparece el panel Solicitud web.

   Nota:

   Si no tiene suficientes privilegios, la pestaña Solicitud web no estará disponible.

5. Haga clic en el nombre de la solicitud web que desea editar en el panel Solicitud web.

   Sugerencia:

   Puede filtrar la lista de solicitudes web en el panel Solicitud web escribiendo un término de búsqueda en el cuadro de texto Buscar plantillas de solicitud web.

6. Actualice la solicitud web según sea necesario.
7. Haga clic en Guardar para guardar los cambios.

Eliminar plantillas de solicitud web

La eliminación de las plantillas de solicitud web es permanente y no se puede deshacer. Para eliminar plantillas de solicitud web, haga lo siguiente:

1. Acceda a la aplicación web de Workflow Manager.
2. Haga clic en la pestaña Diseño.

   Aparece la página Diseño.

   Nota:

   Si no tiene suficientes privilegios, la pestaña Diseño no estará disponible.

3. Haga clic en Plantillas .

   Nota:

   Si no tiene suficientes privilegios, el botón Plantillas no está disponible.

4. Haga clic en la pestaña Solicitud web.

   Aparece el panel Solicitud web.

   Nota:

   Si no tiene suficientes privilegios, la pestaña Solicitud web no estará disponible.

5. Haga clic en el nombre de la solicitud web que desea eliminar en el panel Solicitud web.

   Sugerencia:

   Puede filtrar la lista de solicitudes web en el panel Solicitud web escribiendo un término de búsqueda en el cuadro de texto Buscar plantillas de solicitud web.

6. Haga clic en Más acciones y luego en Eliminar.

   Aparece un mensaje de confirmación.

7. Haga clic en Sí para eliminar la solicitud web o en No para cancelar.