Como carregar a interface de consulta de documentos via API
Visão geral
Confira abaixo o modelo de estrutura XML para a Consulta de documentos:
<?xml version="1.0" encoding="UTF-8"?>
Sim
-
<eContent>
Sim
Raiz.
<header>
Sim
Cabeçalho de identificação pelo Zeev docs.
<module name="smlwebsearch" />
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>
Não
Estrutura contendo configurações sobre os módulos que serão acessados.
<event name="smlwebsearch">
Sim
Campo que fará a chamada do módulo de Consulta. Atributo(s): name (obrigatório) - nome do módulo que será aplicado um conjunto de configurações e regras
<option showHeader=" " showFloatMenu=" " openHeader=" " openFloat=" " fullscreen=" " viewerTarget=" " parentUrl=" " />
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. parentUrl (opcional) - url da página que fez a chamada e que tem o iframe nomeado no atributo "viewerTarget".
<content type=" ">
Sim
Identificação do conteúdo onde serão aplicadas as parametrizações. Atributo(s): type (obrigatório) - 'basic' ou 'advanced'.
<fields>
-
-
<field name=" " visible=" " enabled=" " required=" " defaultValue=" " defaultValueEnd=" " defaultDescription=" " commandOrName=" " />
Não
Identificação do campo da aplicação. Atributo(s): name (opcional) - nome do campo atribuído à aplicação. Para filtro por intervalo, informar o início no atributo "defaultValue" e o fim no atributo "defaultValueEnd". Observações: campo deve estar configurado para aceitar busca por intervalo. 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. commandOrName (opcional) - Esse atributo só é válido para os campos de sistema DOCTYPE_ID, IDXQUEUE_ID, IDXSITDOC_ID e PNDRSN_ID. Ao utilizar o DOCTYPE_ID, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Comando" do tipo de documento que deseja realizar a busca. Para os demais, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Nome" da fila, situação e/ou pendência. Caso seja informado o defaultValue, o atributo commandOrName não será considerado.
</ fields>
-
-
<results itemsPerPage=" " showDeleted=" ">
Não
Forma de apresentação do resultado da busca em tela. Atributo(s): itemsPerPage (opcional) - quantidade de registros exibidos por página no grid. showDeleted (opcional) - exibir registros excluídos logicamente - true/false.
<column name=" " sortable=" " group=" " visible=" " />
Não
Identificação da coluna do grid. Atributo(s): name (opcional) - nome da coluna atribuída à aplicação. sortable (opcional) - permite a ordenação dos registros pela coluna - true/false. group (opcional) - permite o agrupamento de registros pela coluna - true/false. visible (opcional) - visibilidade do campo - true/false.
</ results>
-
-
</ content>
-
-
<action name=" " />
Não
Executa a ação dos botões. Atributo(s): name (opcional) - nome do botão. Ex: search.
</ event>
-
-
</ events>
-
-
</structure>
-
-
</eContent >
-
-
Efetue o download do modelo de XML:
Observação: para ser possível abrir o documento selecionado em um iFrame os atributos "viewerTarget" e "parentUrl" devem estar preenchidos. Também é necessário a implementação de um código javascript na página que realizou a chamada, esse código permite trocar mensagens entre páginas mesmo em domínios diferentes. Segue abaixo código javascript:
function setUrlViewer(event) {
//Nome (ID) do iFrame que será utilizado para abrir o documento
var iFrameName = event.data.split('|')[ 0 ]
//Url do documento para abertura no iFrame
var url = event.data.split('|')[ 1 ]
//Passando url para o iFrame
document.getElementById(iFrameName).src = url;
}
Além de incluir a função acima é necessário incluir um EventListener na página que fará a chamada para os iFrames, segue código:
window.addEventListener("message", setUrlViewer, false);