Como obter a estrutura de campos da biblioteca
Visão geral
É possível obter a estrutura de campos da aplicação e de sistema através do Serviço Web abaixo:
Serviço Web: https://<servidor do Zeev docs>/services/silentLogin.svc
Método: GetXmlModel(string applicationCode), retorno string.
Estrutura modelo do XML para retorno dos campos da biblioteca
Confira abaixo o modelo de estrutura XML para a Consulta de documentos: o retorno de campos da aplicação e de sistema (GetXmlModel):
<?xml version="1.0" encoding="UTF-8"?>
Sim
-
<eContent>
Sim
Raiz.
<header>
Sim
Cabeçalho de identificação pelo Zeev docs.
<module name=" " />
Sim
Informações do módulo de entrada. Atributo(s): name (obrigatório) - nome do módulo.
<application code=" " />
Sim
Identificação da aplicação. Atributo(s): code (obrigatório) - código da aplicação.
<userToken />
Sim
Token de identificação do usuário para SilentLogin. Disponibilizada interface para geração do token através de web service.
<access limit=" " expireDate=" " />
Sim
Validade do acesso, podendo ser pela quantidade de acessos e pela data de expiração, valendo o que ocorrer primeiro. Atributo(s): limit (obrigatório) - quantidade de execuções do token. expireDate (opcional) - data de validade do token.
<identification />
Não
Campo para ser utilizado na integração caso necessite registrar algum código de identificação do sistema e/ou usuários legados.
<adHocUser />
Não
Usuário que será gravado o log de acesso e ação.
</ header>
-
-
<structure>
-
-
<events>
-
-
<event name=" ">
Não
Estrutura contendo configurações sobre os módulos que serão acessados.
<option showHeader=" " showFloatMenu=" " openHeader=" " openFloat=" " fullscreen=" " viewerTarget=" " />
Não
Dentro de "option" é feita a configuração da exibição da interface do módulo. Atributo(s): showHeader (opcional) - exibir o cabeçalho da página - true/false showFloatMenu (opcional) - exibir o painel (menu) lateral esquerdo - true/false. openHeader (opcional) - manter o painel superior da página visível - true/false. openFloat (opcional) - manter o painel (menu) lateral esquerdo visível - true/false. fullscreen (opcional) - forçar a abertura da janela ocupando toda a tela - true/false. viewerTarget (opcional) - nome do frame. Possibilita configurar o frame em que os documentos abertos para visualização ou edição devem ser carregados. Ex: _blank.
<content type=" ">
Sim
Identificação do conteúdo onde serão aplicadas as parametrizações. Atributo(s): type (obrigatório) - 'basic'.
<fields>
-
-
<field name=" " visible=" " enabled=" " required=" " defaultValue=" "=" " defaultDescription=" " />
Não
Identificação do campo da aplicação. Atributo(s): name (opcional) - nome do campo atribuído à aplicação. visible (opcional) - visibilidade do campo - true/false. enabled (opcional) - campo habilitado para edição - true/false. required (opcional) - preenchimento obrigatório - true/false. defaultValue (opcional) - texto ou valor padrão atribuído ao campo defaultDescription (opcional) - utilizado somente para atribuição de descrição padrão em campo do tipo Fonte de dados.
</ fields>
-
-
</ content>
-
-
</ event>
-
-
</ events>
-
-
</structure>
-
-
</eContent >
-
-
Efetue o download do modelo de XML: