Estruturas

Muitos produtos e implementações integráveis fazem uso extensivo de estruturas em árvore de interface do usuário para exibir relacionamentos hierárquicos entre registros no sistema. A estrutura fornece um objeto para definir uma estrutura de árvore e as regras sobre como preencher os nós na árvore, e processos para interpretar a configuração e renderizar dinamicamente a exibição em árvore.

Os tópicos desta seção contêm informações sobre o conteúdo da estrutura. O produto pode fornecer componentes da interface do usuário com estruturas prontas para casos de uso comuns. Para obter mais informações, consulte a documentação do produto.

Atributos Comuns das Estruturas

A organização da estrutura pode ter vários portais e zonas que mostram dados em uma estrutura hierárquica. A maioria das estruturas no sistema segue um padrão semelhante:
  • As estruturas têm vários níveis. Pode haver diferentes tipos de nós de estrutura presentes em um determinado nível; por exemplo, uma lista de tipos de algoritmo para um script, seguida de uma lista de etapas de script. Os ícones podem ser exibidos para identificar melhor o tipo de objeto do nó.

  • Os tipos de nó mais comuns fazem referência a uma entidade no sistema, como um esquema, script, área de dados etc. Geralmente, esses nós exibem a string de informações da referência da chave externa da entidade e proporcionam a capacidade de navegar até a entidade. Eles também podem permitir que o contexto do nó seja transmitido para outras zonas no portal.

  • Além da capacidade de navegar até a entidade associada, muitos tipos de nó têm um menu de contexto com outros caminhos de navegação.

  • Alguns nós são apenas informativos e são usados para agrupar um conjunto de nós-filho abaixo de um tipo ou categoria. Por exemplo, a estrutura Opções do objeto de negócios agrupa os nós de valor da opção abaixo dos nós de resumo que descrevem o tipo de opção.

Cada estrutura define os nós que a compõem e o relacionamento pai/filho entre esses nós. Um nó de estrutura define quais dos atributos comuns são aplicáveis ao nó e aos algoritmos responsáveis pela recuperação dos dados do nó e, opcionalmente, pela determinação das informações do nó a serem exibidas.

Algoritmo do Nó de Preenchimento

Um nó de estrutura exibe uma combinação dos atributos listados acima, geralmente para um objeto no contexto. Para um nó raiz, o objeto normalmente será derivado de um valor de contexto global ou do portal, como o script atual. Para cada nó de nível inferior, o contexto é derivado dos campos de contexto da linha pai; por exemplo, algoritmos para um tipo de algoritmo específico.

A principal responsabilidade do algoritmo preencher nó é receber o código da estrutura, o nome do nó e o valor (ou valores) de contexto-pai, determinar se há dados que devem ser mostrados para esse nó e retornar uma lista dos campos e valores de contexto aplicáveis a cada linha do nó. Os pontos a seguir destacam informações opcionais adicionais que podem ser retornadas pelo algoritmo:

  • Informações da entidade. Se o nó estiver relacionado a uma entidade específica, o código-objeto de manutenção e os valores da chave primária poderão ser retornados. Esses são usados para determinar informações padrão para o nó, incluindo detalhes de navegação.

  • Um valor de ícone de exibição. É usado para substituir o ícone definido no nó de estrutura e/ou o ícone padrão da entidade conforme definido no objeto de manutenção ou no objeto de negócios.

  • Uma string de informações. Esta pode ser usada para substituir a string de informações padrão de uma entidade ou para exibir texto independente, como um resumo ou uma descrição dos nós-filho seguintes.

  • Substitua os detalhes de transmissão, se necessário, para um nó específico. Por exemplo, defina nomes e valores de campos de transmissão específicos quando eles diferirem das chaves primárias da entidade relacionada ou indique que a transmissão não é aplicável a uma instância de nó, mesmo que a transmissão esteja ativada pela definição do nó.

Observação:
O algoritmo do nó de preenchimento é responsável por retornar todos os valores de contexto necessários para preencher seus nós filho. Para um nó informativo ou de resumo, isso pode exigir a inclusão dos campos de contexto-pai do nó no próprio contexto. Por exemplo, na estrutura de scripts, o nó de resumo que descreve o número de etapas é seguido por uma lista de etapas do script. O algoritmo de preenchimento do nó de resumo precisa incluir o código de script informado como contexto-pai na lista de contexto de saída, para que as etapas sejam recuperadas corretamente.

Algoritmo de Substituição de Informações

O algoritmo de substituição de informações tem duas finalidades principais:

  • Fornecer texto de informações alternativas para um nó de estrutura quando as informações disponíveis não forem adequadas para a implementação.

  • Recuperar insights contextuais relacionados à entidade do nó de estrutura, a serem incluídos no texto de informações do nó. No momento, apenas tipos de insight de placa são compatíveis.

  • Substitua os detalhes de transmissão, se necessário, para um nó específico. Por exemplo, defina nomes e valores de campos de transmissão específicos quando eles diferirem das chaves primárias da entidade relacionada ou indique que a transmissão não é aplicável a uma instância de nó, mesmo que a transmissão esteja ativada pela definição do nó.

O algoritmo de informações de substituição recebe o código da estrutura, o nome do nó, o objeto de manutenção e os valores de chave primária do nó. Os pontos a seguir destacam as informações que o algoritmo pode retornar:

  • Um valor de ícone de exibição.

  • Uma string de informações. Esta será usada para substituir a string de informações padrão na string formatada do nó.

  • Texto completo do nó. Esse será usado como o texto completo para exibição, substituindo a formatação definida no nó.

  • Uma lista de tipos de insights de placa e o contexto.

Observação:
Se o algoritmo de substituição de informações retornar tipos de insight para a entidade, ele também será responsável por retornar todos os valores de contexto necessários para esses tipos de insight. Para obter mais informações, consulte Insights Contextuais.

Preparando um Nó para Exibição

A seção a seguir destaca as etapas principais da extração dos dados de um nó e da formatação deles para exibição.

Determinando o Conteúdo de Nó

As seguintes etapas são executadas para recuperar os componentes que compõem a exibição do nó de estrutura:

  • O algoritmo Preencher Nó é chamado para determinar todos os nós da instância para o nó da estrutura, juntamente com seus detalhes relacionados.

  • O algoritmo de Substituição de Informações é chamado para cada instância de nó para permitir a substituição opcional dos detalhes relacionados à apresentação.

O conteúdo de exibição do nó é determinado da seguinte forma:

  • O ícone é determinado a partir das seguintes origens, na ordem: definição do nó da estrutura, valor do algoritmo de informações de substituição, valor do algoritmo do nó de preenchimento, valor padrão do objeto de manutenção/objeto de negócios.

  • O uso da transmissão é determinado pela definição no nó da estrutura.
    • Essa configuração pode ser substituída pelo algoritmo do Nó de Preenchimento ou pelo algoritmo de Informações de Substituição (que tem prioridade) para indicar que a transmissão não é aplicável a uma instância de nó específica.
    • Por padrão, os campos de transmissão de um nó são os nomes de chaves primárias de sua entidade relacionada. Os nomes dos campos de transmissão podem ser substituídos pelo algoritmo do Nó de Preenchimento ou pelo algoritmo de Informações de Substituição, sendo que este último tem prioridade.
  • A string de informações é determinada a partir das seguintes origens, em ordem: substituir valor do algoritmo de informações, preencher valor do nó, objeto de manutenção/algoritmo de informações do objeto de negócios. Se a string for derivada do algoritmo MO/BO, o texto de informações curtas será usado quando disponível; caso contrário, as informações padrão serão usadas.

  • O uso do menu de contexto é determinado pelas configurações na definição do nó de estrutura.

  • O sistema suporta um estilo diferente para linhas de cabeçalho, incluindo uma fonte maior. O uso do estilo de cabeçalho é determinado pela definição na definição de estrutura e só será aplicável se o nó for um nó raiz com apenas uma instância.

Formato de Texto do Nó

O texto dos nós que fazem referência a uma entidade do sistema geralmente inclui alguma combinação de um rótulo, a chave da entidade e uma string de informações. A configuração do nó fornece um campo de rótulo e um campo de string de formato de substituição que podem ser usados para definir o formato de texto do nó. A string de formato define quais dos componentes devem ser incluídos no texto, a ordem desses componentes e qualquer texto circundante e marcações HTML. Por exemplo, uma string de formato '%label - %key - %info' resultará em um texto de nó como o exemplo abaixo:

Exemplo de Formato do Nó da Estrutura

Se a string de formato estiver em branco, o texto padrão incluirá somente '%info'. Se um algoritmo de informações de substituição for configurado que retorne o texto completo do nó, o texto será apresentado sem formatação adicional.

Expansão Automática

Se a definição do nó da estrutura indicar que o nó deve ser expandido, o sistema extrairá e exibirá automaticamente os dados do nó-filho. Esse processamento continua até que não haja outros nós-filho marcados para expansão.

Há casos em que um nó da estrutura deve ser expandido condicionalmente com base nas regras de negócios. Por exemplo, evite a expansão inicial quando o número de nós filho exceder um determinado limite. É possível projetar o algoritmo "Nó de Preenchimento" para indicar se um nó da estrutura deve ser expandido inicialmente ou não. Quando preenchida, a indicação substitui a configuração na definição do nó da estrutura.

Estruturas Base Entregues

As estruturas são dados do sistema e o produto pode já fornecer várias estruturas predefinidas. É possível optar por personalizar uma estrutura de base entregue das seguintes maneiras:

  • É possível adicionar seus próprios nós a uma definição de estrutura existente.

  • É possível substituir a string de informações de um nó fornecendo seu próprio algoritmo de Substituição de Informações. Se um algoritmo de substituição base estiver configurado no nó, seu algoritmo personalizado deverá ser conectado a um número de sequência maior, para ter precedência sobre o algoritmo base.

Renderizando uma Estrutura

Para renderizar uma estrutura na interface do usuário, você incluiria o componente da Web da estrutura em um mapa da interface do usuário que faz referência à definição da estrutura.

Observação:
Para obter mais informações, consulte Incluir um Componente Web.