Como pré-indexar um documento via API
Visão geral
Confira abaixo o modelo de estrutura XML para pré-indexar documento (EXECUTEACTION: PREINDEX):
<?xml version="1.0" encoding="UTF-8"?>
Sim
-
<eContent>
Sim
Raiz.
<header>
Sim
Cabeçalho de identificação pelo Zeev docs.
<module name="SILENTLOGINEXECUTEACTION" />
Sim
Identificação da aplicação. Atributo(s): code (obrigatório) - código da aplicação.
<machine />
Sim
Nome da máquina onde a ação é realizada.
<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.
<identification />
Não
Nó de livre preenchimento, podendo ser utilizado para inclusão de identificação do sistema que gerou o XML de SilentLogin.
<adHocUser />
Não
Usuário que será gravado o log de acesso e ação.
</ header>
-
-
<structure>
-
-
<events>
-
-
<event name="PREINDEX">
Sim
Informações do módulo de entrada. Atributo(s): name (obrigatório) - nome da função a ser chamada.
<content>
-
-
<fields>
-
-
<field name=" " value=" " commandOrName=" " />
Sim
Campos da aplicação destino que devem ser populados com o novo documento. Atributo(s): name (obrigatório) - nome dos campos da aplicação pela qual se deseja filtrar os documentos. value (obrigatório) - valor pelo qual o campo deve ser filtrado. 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 utilizar para atualizar o documento. 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 value, o atributo commandOrName não será considerado. ATENÇÃO: Os campos DOCTYPE_ID, IDXQUEUE_ID, IDXSITDOC_ID, PNDRSN_ID são obrigatórios.
</ fields>
-
-
</ content>
-
-
</ event>
-
-
</ events>
-
-
</structure>
-
-
</eContent >
-
-
Efetue o download do modelo de XML:
O retorno do método será o ID do novo documento pré-indexado.
Importante: por padrão os dados de valores de formulário enviados via API não serão validados quanto à obrigatoriedade, tipo de dado e máscaras. Esse controle deverá ser feito pela aplicação que está dando origem à chamada ou então por uma validação incluída no processo referenciado. Apenas validado a obrigatoriedade de tipo de documento, etapa, situação e pendência.