Serviços e Serviços de Negócios Úteis

A seção a seguir destaca alguns serviços e serviços de negócios contidos no produto que podem ser úteis para as implementações.

Serviço de Explorador de Dados

O sistema contém um mecanismo para a realização de uma instrução SQL select para uso em scripts, plug-ins Java e por meio de uma chamada de um serviço Web. Para tanto, uma zona onde o SQL é definido é criada com o uso de um dos tipos de zona do explorador de dados. Em seguida, use o serviço Explorador de Dados (FWLZDEXP) para criar um serviço de negócios.

Observação: Vários serviços de negócios contidos no produto-base e que referenciam esse serviço podem ser usados como modelo.

Os pontos a seguir descrevem como criar o próprio serviço de negócios para esse serviço. Note que, geralmente, há um serviço de negócios separado para cada zona.

  • Informe um código de Serviço de Negócios e uma Descrição. É recomendado definir o código do serviço de negócios de modo a corresponder com o código da zona, pois assim fica mais fácil saber qual serviço de negócios chama qual zona.
  • Selecione o Nome do Serviço FWLZDEXP.
  • Na guia Esquema, abaixo do nó <schema> , informe o mapeamento dos campos necessários para o serviço do Explorador de Dados:
    • A Zona deve ser mapeada para o campo de serviço ZONE_​CD. Defina o código da zona como o valor padrão.
    • Para cada filtro do usuário definido na zona, crie um mapeamento de esquema para o campo de serviço Fx_​VALUE , em que "x" é o número do filtro (dos parâmetros da zona).
    • Para cada filtro oculto definido na zona, crie um mapeamento para o campo de serviço Hx_​VALUE , em que "x" é o número do filtro (dos parâmetros da zona).
    • Os resultados da pesquisa são retornados como uma lista pelo serviço do explorador de dados. Cada valor de coluna está no campo de serviço COL_​VALUE com um número de sequência apropriado ( SEQNO ). Os resultados podem ser nivelados com base no número de sequência, o que permite a definição de um nome de elemento lógico.
    • Outro campo útil é ROW_​CNT , que informa o número de linhas recuperadas pela pesquisa.

Veja a seguir um exemplo do esquema de um serviço de negócios que recebe um código de objeto de negócios e retorna uma lista de valores de status e descrições que permite a definição dos motivos do status.


<schema>
     <zone mapField="ZONE_CD" default="F1-BOSTSLST"/>
     <bo mapField="H1_VALUE" />>
     <rowCount mapField="ROW_CNT"/>>
     <results type="list" mapList="DE">>
          <status dataType="string" mapField="COL_VALUE">
               <row mapList="DE_VAL">>
                    <SEQNO is="1" />>
               </row>>
          </status>>
          <description dataType="string" mapField="COL_VALUE">
               <row mapList="DE_VAL">>
                    <SEQNO is="2" />>
               </row>>
          </description>>
      </results>>
</schema>

Serviço de Log do Objeto de Manutenção

Muitos objetos de manutenção têm suporte para uma tabela de log que segue um padrão de nomes de coluna e comportamento. O sistema contém um serviço chamado Serviço de Log de Objeto de Manutenção Genérico (F1MOLOGP) que pode ser usado para realizar funções comuns relacionadas a entradas de log:

  • Ler entradas de log. Se você transmitir determinados objeto de manutenção, chave primária e número de sequência do log, o serviço retornará os detalhes daquela entrada de log. O produto contém um serviço de negócios genérico que pode ser usado para esse propósito — Objeto de Manutenção Genérico - Recuperar Detalhes do Log (F1–ReadMOLog). Como alternativa, é possível criar um serviço de negócios para determinado objeto de manutenção em que o código do objeto de manutenção é atribuído ao elemento do objeto por meio da sintaxe padrão. Isso permite que a funcionalidade de negócios específica daquele objeto de manutenção use o serviço de negócios específico.

  • Adicionar log. O serviço pode ser usado para adicionar uma entrada de log. Se um log de usuário for adicionado, os comentários do usuário serão preenchidos na descrição detalhada. As entradas de log geradas pelo sistema geralmente fornecem categoria de mensagem/número de mensagem junto com outras informações, como status, tipo de log específico e, opcionalmente, uma referência a um objeto relacionado (por meio de característica). O produto contém um serviço de negócios genérico que pode ser usado para esse propósito — Adicionar Log de Objeto de Manutenção Genérico (F1–AddMOLog). Como alternativa, é possível criar um serviço de negócios para determinado objeto de manutenção em que o código do objeto de manutenção é atribuído ao elemento do objeto por meio da sintaxe padrão. Isso permite que a funcionalidade de negócios específica daquele objeto de manutenção use o serviço de negócios específico.

Serviços de Negócios-Base

A tabela a seguir destaca alguns serviços de negócios contidos no produto que podem ser úteis para a lógica personalizada das implementações.

CUIDADO: esta não pretende ser uma referência completa dos Serviços de Negócios. Para localizar todos os serviços de negócios compatíveis, consulte a página do serviço de negócios.

Serviços Relacionados a Objetos de Negócios

Nome do Serviço de Negócios Descrição
F1-AutoTransitionBO Executa algoritmos de monitoramento associados ao status atual de determinada instância de objeto de negócios, o que pode resultar em transição de status subsequente.
F1-CompareBusinessObjectData Compara duas versões de determinada instância de objeto de negócios.
F1-DetermineBo Determina o objeto de negócios de determinada instância de um objeto de manutenção por meio da execução da lógica Determinar Objeto de Negócios do Objeto de Manutenção.
F1-GetRequiredFieldsForBOState Retorna os campos obrigatórios para determinado status do objeto de negócios.
F1-RetrieveBOOption Retorna os valores de opção de objeto de negócios para determinado objeto de negócios e tipo de opção.
F1-RetrieveBOStatusOption Retorna os valores de opção de objeto de negócios para determinado objeto de negócios, status e tipo de opção.
F1-RetrieveBOStatusOption Recupera uma lista de objetos de negócios para determinado objeto de manutenção que são acessíveis para o usuário atual.
F1-RetrieveBoStatusDescription Retorna a descrição de determinado status do objeto de negócios.
F1-RetrieveBusinessObjectLabel Retorna o rótulo apropriado para determinado caminho (ex.: elemento) dentro de um esquema de objeto de negócios.
F1-RetrieveNextStates Retorna uma lista dos próximos status possíveis com base na entrada de um objeto de manutenção e sua chave primária, ou de um objeto de negócios e um de seus status.

Serviços Relacionados a E-Mail

Nome do Serviço de Negócios Descrição
F1-EmailService Envia uma mensagem de e-mail em tempo real.
F1-RetrieveEmailAddress Recupera os endereços de e-mail dos usuários que pertencem a uma Função de Atividade.
F1-RetrieveEnvironmentURL Recupera as informações de URL do ambiente atual para a instalação.

Ferramentas para Mapas e Scripts

Nome do Serviço de Negócios Descrição
F1-AddWarning Este serviço de negócios pode ser usado para registrar um aviso fornecendo os detalhes da mensagem. O sistema coleta todos os avisos e os exibe para o usuário de uma só vez.
F1-CheckOnlineConnection Verifica se a Conexão é Online ou Batch.
F1-CheckWarning Usado para verificar se há avisos acumulados. Se os avisos tiverem sido acumulados, qualquer lógica que não possa ser submetida a rollback (quando os avisos forem mostrados) não deverá ser executada.
F1-DateMath Realiza vários cálculos matemáticos de data e hora. Para obter mais informações, consulte a descrição do serviço de negócios.
F1-DateTimeFormattingService Formata determinada data/hora com base nas definições do perfil de exibição do usuário.
F1-ExecuteScriptInNewSession Executa um Script de Serviço em uma nova seção/transação de processamento.
F1-GetFieldLabel Recupera o rótulo de determinado campo.
F1-GetForeignKeyReference Recupera as informações da referência de chave externa de determinadas Referência de Chave Externa e chave primária, incluindo descrição das informações, opção de navegação e menu contexto.
F1-GetFKReferenceDetails Recupera as informações da referência de chave externa de determinados objeto de manutenção e chave primária, incluindo código da referência de chave externa, descrição das informações, opção de navegação, zona de pesquisa e menu contexto.
F1-GetLookupDescription Recupera as informações de consulta de um valor de campo de pesquisa com o uso do nome do campo de pesquisa.
F1-GetExtLookUpVal Retorna a lista de valores de determinado objeto de negócios de busca extensível.
F1-GetMonthInYearAbbreviation Retorna uma abreviação de mês com três caracteres para uma data de entrada no formato do sistema.
F1-NumberAmountFormatter Formata determinado valor ou número com base nas definições do perfil de exibição do usuário. Também pode receber entradas para ajuste de escala e, opcionalmente, aplicar definições de moeda.
F1-OutmsgDispatcher Envia uma mensagem em tempo real que dá ao usuário a opção de manter a mensagem no banco de dados e capturar erros que possam ocorrer durante a chamada. Para obter mais informações, consulte Mensagens em Tempo Real.
F1-OutmsgMediator Uma alternativa a F1-OutmsgDispatcher, e pode ser uma opção melhor caso o remetente não exija que um registro de mensagem de saída seja instanciado. Para obter mais informações, consulte Mensagens em Tempo Real.
F1-RethrowError Emite um erro de aplicativo com o uso da entrada categoria da mensagem/número/parâmetros.
F1-RetrieveMODescription Recupera a descrição de um objeto de manutenção.
F1-ReturnMessage Retorna a mensagem expandida com base na categoria de mensagem, no número, nos parâmetros e nos tipos de parâmetro.
F1-SavePointDispatcher Permite a execução de um script de serviço em que as exceções são capturadas e a transação é revertida para um savepoint definido antes da execução do script.

Serviços Relacionados ao Usuário

Nome do Serviço de Negócios Comentários
F1-CheckApplicationSecurity Verifica a segurança do usuário para determinado serviço de aplicativo/modo de acesso
F1-CheckUserAuthorization Determina se o usuário está autorizado para acesso com base na entrada serviço do aplicativo, código de segurança e nível de autorização.
F1-DetermineIfUserCanApproveTD Determina se o usuário atual pode aprovar determinada Atividade.