Configuración de la API de getPage para recuperar datos adicionales

Cree un archivo getPage-templates.json personalizado para recuperar los datos necesarios de las llamadas de API de getPage existentes sin necesidad de escribir ningún código.

Guarde el archivo en la carpeta src-custom/assets/custom del módulo. Por ejemplo, packages/<route>/src-custom/assets/custom/getPage-templates.json.

Sólo necesita utilizar este archivo si los datos personalizados que está intentando recuperar de IBM Sterling® Order Management System no se recuperan ya mediante la llamada a la API predeterminada getPage. Para revisar qué datos ya se han recuperado y para determinar qué es necesario añadir al archivo personalizado, realice los pasos siguientes.

  1. En Order Hub, vaya a la página que desea actualizar. Siempre que se carga una página, se llama a la API getPage .
  2. Utilice la consola del navegador para buscar el nombre de API y el template ID que se utiliza para recuperar datos. Para ver un ejemplo, consulte Mensaje de registro de ejemplo en la consola del navegador.
  3. Consulte el getPage-templates.json que se ha cargado para la aplicación para ver las plantillas de API y qué datos ya se han recuperado. Copie sólo la plantilla que desea alterar temporalmente. Por ejemplo, getPage-templates.json para el módulo buc-app-order incluye plantillas para muchas API como getDateTypeList y getAuditList, entre otras. Si simplemente desea añadir una propiedad para recuperar un nuevo valor de la API de getAuditList , copie sólo la plantilla getAuditList . Para obtener más información, consulte Comprender el archivo getPage-templates.json.
  4. En el archivo getPage-templates.json personalizado, añada la plantilla que desea alterar temporalmente. Para ver un ejemplo, consulte Ejemplo de un archivo getPage-templates.json personalizado.
    Nota: Para ver un conjunto completo de datos que puede recuperar, consulte la documentación de IBM Sterling Order Management System API. Para obtener información, consulte Generación y acceso a Javadoc.

Mensaje de registro de ejemplo en la consola del navegador

A continuación se muestra un registro de consola de ejemplo cuando se visualiza el separador Auditorías en la página Detalles del pedido.
Time since init (ms): 16644. 
Log type: LOG.
Log generator: @buc/svc-angular.
Message: BucCommOmsRestAPIService.getPage():  Invoking API "getAuditList" using template ID "default"

Descripción del archivo getPage-templates.json

Dentro del archivo getPage-templates.json, los objetos se dividen en función de la API de IBM Sterling Order Management System a la que se llama getPage, y del escenario en el que se llama a la API. La estructura del archivo de configuración es la siguiente:
{
  "apiName": {
       "scenarioId": { <template ID to use for the scenario> },
       "default": { <template ID to use by default. This is used if a scenario name was not specified when invoking the API> }
}
Por ejemplo, el código siguiente es una parte del archivo getPage-templates.json predeterminado. Observe que esta muestra incluye dos plantillas API: getDateTypeList y getAuditList. Si ha personalizado la tabla Auditorías , sólo tiene que copiar la plantilla getAuditList .
{
  "getDateTypeList": {
    "default": {
      "DateTypeList": {
        "DateType": [
          {
            "ActualFlag": "",
            "CallingOrganizationCode": "",
            "DateTypeId": "",
            "DateTypeKey": "",
            "Description": "",
            "ExpectedFlag": "",
            "RequestedFlag": "",
            "SystemDefined": "",
            "CommittedFlag": ""
          }
        ]
      }
    }
  },
  "getAuditList": {
    "default": {
      "AuditList": {
        "Audit": {
          "Modifyts": "",
          "Modifyuserid": "",
          "AuditContextId": "",
          "AuditXml": "",
          "Reference1": "",
          "Reference2": "",
          "Reference3": "",
          "Reference4": "",
          "Reference5": "",
          "Reference6": ""
        }
      }
    }
  }
}

Ejemplo de un archivo getPage-templates.json personalizado

Basándose en el registro de ejemplo, si ha personalizado la tabla de auditoría para incluir la propiedad AuditKey , debe indicar a la API getAuditList que recupere el valor AuditKey del origen de datos. Por lo tanto, añada el código siguiente al archivo getPage-templates.json personalizado para incluir la propiedad AuditKey .
{
  "getAuditList": {
    "default": {
      "AuditList": {
        "Audit": {
          "Modifyts": "",
          "Modifyuserid": "",
          "AuditContextId": "",
          "AuditXml": "",
          "Reference1": "",
          "Reference2": "",
          "Reference3": "",
          "Reference4": "",
          "Reference5": "",
          "Reference6": "",
          "AuditKey": ""
        }
      }
    }
  }
}