Utilización de la actividad Consultar objetos de Sage CRM

Utilice la actividad Consultar objetos para ejecutar una consulta SData sobre un tipo de objeto especificado en Sage CRM.

Acerca de esta tarea

Utilice esta tarea para ejecutar una consulta SData sobre un tipo de objeto especificado en la instancia de Sage CRM. La llamada a esta actividad es una llamada síncrona en la que se envían los datos de entrada a la actividad para ser procesados y se devuelve la respuesta a la orquestación.

Procedimiento

  1. Pulse el botón derecho (del ratón) en la sección Orquestaciones y seleccione Nueva orquestación.
  2. Arrastre el punto final de Sage CRM recién creado hasta la orquestación y seleccione la actividad Consultar objetos.
  3. Se añadirá la actividad Consultar objetos a la orquestación. Seleccione la actividad. Se mostrará la Lista de comprobación de Consultar objetos de Sage CRM.
  4. En la lista de comprobación, pulse Configurar.
  5. Especifique los parámetros de consulta válidos con una ‘?’ como un marcador de posición para el valor. Para configurar varios parámetros de consulta, separe cada parámetro de consulta por un símbolo de ‘&’. Algunos ejemplos de consulta:
    select=?&where=?
    startIndex=?&count=?
    orderBy=?
    select=?&where=?orderBy=?
      where=Lead_UpdatedDate lt @2016-01-10@

    Tenga en cuenta que la serie de consulta no debe comenzar por una ‘?’.

  6. Pulse Examinar para seleccionar el tipo de objeto. Se mostrará la ventana Examinar Sage CRM.
  7. En Examinar Sage CRM, puede seleccionar el tipo de objeto de la lista de tipos de objeto. Pulse Aceptar.
  8. Seleccione las Entradas de correlación en la Lista de comprobación. Los esquemas XML generados a partir del objeto seleccionado de la actividad Consultar objetos se muestran como nodos bajo el parámetro de entrada de la solicitud en el panel A actividad.
  9. En la Lista de comprobación, pulse Reintentar. Revise los valores predeterminados y realice los cambios que sean necesarios.
  10. Cree una correlación entre las variables de orquestación y el parámetro de entrada de la actividad.
    Nota: Los valores deben proporcionarse durante el tiempo de ejecución para todos los elementos obligatorios de la estructura de entrada. Se puede indicar un valor especificando un valor predeterminado para el elemento o enlazando el elemento con un nodo de entrada. Durante el tiempo de ejecución, si no se suministra ningún valor para un elemento obligatorio, la actividad lanza una excepción que es notificada por la consola de gestión web (WMC). Si no se proporciona un valor en tiempo de ejecución para un parámetro opcional de entrada, no se lanza ninguna excepción durante el tiempo de ejecución.
  11. Seleccione las Salidas de correlación en la lista de comprobación. El esquema XML generado para contener la respuesta de la actividad se muestra como nodos bajo el parámetro de salida de respuesta en el panel Desde actividad.
  12. Cree una correlación entre los parámetros de salida y las variables de orquestación.

    Parámetro de consulta:

    Tabla 1. Parámetros de consulta comunes para los objetos de consulta
    Nombre del campo Descripción
    startIndex Índice de inicio del registro desde el que debería empezar el resultado de la llamada de API.
    count Recuento del número de objetos que se van a mostrar en la respuesta.
    where Especifica un criterio de filtrado. Solo se devuelven los recursos que coinciden con los criterios especificados en el parámetro where.
    orderBy Especifica un criterio de ordenación. La colección se ordena por orden ascendente o descendente de los nombres de atributo especificados en este parámetro.
    select Selecciona las propiedades que se devolverán en la carga útil. Este parámetro permite a un cliente solicitar que se devuelva en la carga útil una lista determinada de propiedades. Proporciona un control preciso sobre la amplitud y la profundidad de la información devuelta.

    Al menos uno de los parámetros de consulta anteriores debe tener un valor correlacionado o predeterminado para que la actividad se ejecute correctamente.

Resultados

Habrá configurado la actividad Consultar objetos de Sage CRM.
Nota:

Esta actividad funciona al captar varios registros de un tipo especificado. Como tal, la respuesta de entrada debe ser única, que es aplicable a una llamada única de API a recuperar todo para captar varios objetos.