Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Simon Flock Schiesl Ferreira

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Ieda Ferreira Alves Flock

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

O objetivo é disponibilizar uma área de configuração dos parâmetros utilizados pela documentação de customização, permitindo a busca em fontes de pesquisa do próprio cliente. 

Para mais informações acessar Documentação de Customização.

Informações
iconfalse
titleÍndice

Índice

Objetivo

Configurar parâmetros do produto Datasul para realizar integração com o produto Fluig ECM


Visão Geral

Quando marcada a opão opção Habilitar integraçãofuncionalidade como   preencha as demais informações, considerando que apenas o campo Parâmetros do servidor não é obrigatório.Image Removed

Configuração

Habilitar integração

É responsável por habilitar/desabilitar integração do produto Datasul com o Fluig ECM.

URL Base 

URL Base de acesso ao Fluig ECM.

O formato desta URL Base sempre será [ PROTOCOLO ]://[ SERVIDOR ]:[ PORTA ]. Veja como exemplo a imagem acima.

os parâmetros initialurl, titlefield e urlfield são obrigatórios.


Image Added


Parâmetros Documentação de Customização

As configurações seguem a especificação Parâmetros para acionar a Central de Ajuda, abaixo temos uma tabela com os parâmetros utilizados no produto DATASUL

Parâmetro [ initialurl ]

URL para busca inicial. 

Parâmetro [ seemoreurl ]

URL para o Veja Mais.

Parâmetro [ baseurl ]

URL base que será concatenada como prefixo caso a propriedade de URL do item contenha somente o PATH.

Parâmetro [ arrayname ]

Propriedade que contém a lista de itens, caso o primeiro nível do retorno seja um objeto.

Parâmetro [ urlfield ]

Propriedade do item que contém a URL do documento.

Parâmetro [ titlefield ]

Propriedade do item que contém o título do documento.

Parâmetro [ pagetitle ]

Título da área para a busca customizada.



Informações

A opção Habilitar funcionalidade é exclusiva no produto DATASUL, utilizada para ativar e desativar o envio de parâmetros para central de ajuda TOTVS, não faz parte da especificação Parâmetros para acionar a Central de Ajuda


Exemplo 1

Resultado da busca inicial (Parâmetro initialurl) por módulo e programa:

Expandir
titleClique aqui para expandir
  • Bloco de código
    themeRDark
    titleExemplo 1 - Configuração
    Parâmetro initialurl: http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}[[&action={{action}}]] 
Parâmetro seemoreurl: http://<link 'veja mais'> 
Parâmetro titlefield: html_url 
Parâmetro titlefield: title 
Parâmetro pagetitle:  EXEMPLO 1 - DOCUMENTOS CUSTOMIZADOS

  • http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}[[&action={{action}}]]

  • Bloco de código
    themeRDark
    [ 
	{ 
	  "html_url": "http://<link do documento do programa>", 
	  "title": "Exemplo de documento customizado programa - SEC - SEC000AA" 
	} 
]

  • Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

  • Image Added

Resultado da busca inicial (Parâmetro initialurl) por módulo:

Expandir
titleClique aqui para expandir

  • http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}[[&action={{action}}]]

    • O valor em colchetes [[]] será removido ao realizar a busca por modulo, no exemplo configurado

      •   http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}

  • Bloco de código
    themeRDark
    [ 
	{ 
		"html_url": "http://<link do documento do programa>", 
		"title": "SEC - Exemplo 1 de documento customizado programa" 
	}, 
	{ 
		"html_url": "http://<link do documento do programa>", 
		"title": "SEC - Exemplo 2 de documento customizado programa" 
	}, 
	{ 
		"html_url": "http://<link do documento do programa>", 
		"title": "SEC - Exemplo 3 de documento customizado programa" 
	} 
]

  • Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

  • Image Added



Ilustração do exemplo 1, mostrando onde os parâmetros são utilizados:

Expandir
titleClique aqui para visualizar

Image Added

Exemplo 2

A configuração do exemplo 2 faz o uso dos parâmetros arrayname e baseurl.

Resultado da busca inicial (Parâmetro initialurl) por módulo e programa:
Expandir
titleClique aqui para expandir
  • Bloco de código
    themeRDark
    titleExemplo 2 - Configuração
    Parâmetro initialurl: http://<SERVIDOR>:<PORTA>/exemplo2?codModule={{codModule}}[[&action={{action}}]] 
Parâmetro seemoreurl: http://<link 'veja mais'> 
Parâmetro arrayname:  urls 
Parâmetro urlfield:   html_url 
Parâmetro titlefield: title 
Parâmetro baseurl:    http://<prefixo da URL> 
Parâmetro pagetitle:  EXEMPLO 2 - DOCUMENTOS CUSTOMIZADOS

  • http://<SERVIDOR>:<PORTA>/exemplo2?codModule={{codModule}}[[&action={{action}}]]

    • Observar que neste exemplo a propriedade urls contem a lista dos documentos, o nome dessa propriedade de retorno deve possuir o nome igual ao Parâmetro arrayname

  • Bloco de código
    themeRDark
    { 
	"urls": [ 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "Exemplo de documento customizado programa - SEC - SEC000AA" 
				} 
			] 
}

  • O valor da propriedade html_url será concatenada com o valor do Parâmetro baseurl

    • http://<prefixo da URL>/<PATH DO DOCUMENTO>

  • Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

  • Image Added

Resultado da busca inicial (Parâmetro initialurl) por módulo:

Expandir
titleClique aqui para expandir

  • http://<SERVIDOR>:<PORTA>/exemplo2?codModule={{codModule}}[[&action={{action}}]]

    • O valor em colchetes [[]] será removido ao realizar a busca por modulo, no exemplo configurado

      •   http://<SERVIDOR>:<PORTA>/exemplo1?codModule={{codModule}}

    • Observar que neste exemplo a propriedade urls contem a lista dos documentos, o nome dessa propriedade de retorno deve possuir o nome igual ao Parâmetro arrayname

  • Bloco de código
    themeRDark
    { 
	"urls": [ 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "SEC - Exemplo 1 de documento customizado programa" 
				}, 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "SEC - Exemplo 2 de documento customizado programa" 
				}, 
				{ 
					"html_url": "/<PATH DO DOCUMENTO>", 
					"title": "SEC - Exemplo 3 de documento customizado programa" 
				} 
			] 
}

  • O valor da propriedade html_url será concatenada com o valor do Parâmetro baseurl

    • http://<prefixo da URL>/<PATH DO DOCUMENTO>

  • Abaixo podemos verificar na imagem a área para documentos customizados, está localizada abaixo das áreas de conteúdos TOTVS.

  • Image Added

Ilustração do exemplo 2, mostrando onde os parâmetros são utilizados:

Expandir
titleClique aqui para visualizar

Image Added

Informações

Os exemplos 1 e 2 estão utilizando parâmetros na URL de busca inicial (Parâmetro initialurl) , para mais informações sobre os parâmetros que podem ser utilizados, verificar a página Parâmetros para o cliente configurar a customização

Usuário Integrador

Código da empresa

Código da empresa de integração criada no Fluig.

Código do usuário

Código do usuário integrador do Fluig ECM. Precisa ser informado um login de usuário registrado como administrador no Fluig ECM para que tenha permissão de processar as integrações de documentos.

Senha

Senha do usuário integrador do Fluig ECM.