Configurando a API getPage para recuperar dados adicionais

Crie um arquivo getPage-templates.json customizado para recuperar os dados necessários de chamadas API existentes do getPage sem a necessidade de gravar qualquer código.

Salve o arquivo para a pasta src-custom/assets/custom do módulo Por exemplo, packages/<route>/src-custom/assets/custom/getPage-templates.json..

Você só precisará usar esse arquivo se os dados personalizados que estiver tentando recuperar do IBM Sterling® Order Management System ainda não tiverem sido recuperados pela chamada padrão da API getPage. Para revisar quais dados já foram recuperados e para determinar o que você precisa incluir no arquivo customizado, conclua as etapas a seguir:

  1. Em Order Hub, procure a página que você deseja atualizar. Sempre que uma página é carregada, a API getPage é chamada
  2. Use o console do navegador para localizar o nome da API e o template ID que é usado para recuperar dados. Para obter um exemplo, consulte Mensagem de log de amostra no console do navegador
  3. Consulte o getPage-templates.json carregado para o aplicativo para ver os modelos de API e quais dados já foram recuperados. Copie apenas o modelo que você deseja substituir Por exemplo, o getPage-templates.json para o módulo buc-app-order inclui modelos para muitas APIs como getDateTypeList e getAuditList, entre outros. Se você simplesmente desejar incluir uma propriedade para recuperar um novo valor da API getAuditList , copie somente o modelo getAuditList . Para obter mais informações, consulte Noções básicas sobre o arquivo getPage-templates.json.
  4. No arquivo getPage-templates.json customizado, inclua o modelo que deseja substituir. Para ver um exemplo, consulte Exemplo de um arquivo getPage-templates.json personalizado.
    Observação: Para visualizar um conjunto completo de dados que você pode recuperar, consulte a documentação da API doIBM Sterling Order Management System. Para obter informações, consulte Gerando e acessando Javadoc.

Mensagem de log de amostra no console do navegador..

Aqui está um log do console de amostra ao visualizar a guia Auditorias na página Detalhes do pedido.
Time since init (ms): 16644. 
Log type: LOG.
Log generator: @buc/svc-angular.
Message: BucCommOmsRestAPIService.getPage():  Invoking API "getAuditList" using template ID "default"

Entendendo o arquivo getPage-templates.json

No arquivo getPage-templates.json, os objetos são divididos com base na API doIBM Sterling Order Management System que é chamada por getPage e no cenário em que a API é chamada. A estrutura do arquivo de configuração é a seguinte:
{
  "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 exemplo, o código a seguir é uma parte do arquivo getPage-templates.json padrão Observe que esse exemplo inclui dois modelos de API: getDateTypeList e getAuditList. Se você customizou a tabela Auditorias , basta copiar apenas o modelo 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": ""
        }
      }
    }
  }
}

Exemplo de um arquivo getPage-templates.json customizado

Com base no log de amostra, se você customizou a tabela de auditoria para incluir a propriedade AuditKey , será necessário instruir a API getAuditList para recuperar o valor AuditKey da origem de dados. Portanto, inclua o seguinte código no arquivo getPage-templates.json customizado para incluir a propriedade AuditKey .
{
  "getAuditList": {
    "default": {
      "AuditList": {
        "Audit": {
          "Modifyts": "",
          "Modifyuserid": "",
          "AuditContextId": "",
          "AuditXml": "",
          "Reference1": "",
          "Reference2": "",
          "Reference3": "",
          "Reference4": "",
          "Reference5": "",
          "Reference6": "",
          "AuditKey": ""
        }
      }
    }
  }
}