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.


Visão Geral

Quando marcada a opção Habilitar funcionalidade como   preencha as demais informações, considerando que apenas os parâmetros initialurl, titlefield e urlfield são obrigatórios.



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.

A opção Habilitar funcionalidade é exclusiva no produto DATASUL, utilizada para ativar e desativar o envio de parâmetros para central de ajuda TOTVS, essa propriedade 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:

  • 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}}]]
  • [
  {
    "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.


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

  • 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}}
  • [
  {
    "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.



Exemplo 2

A configuração do exemplo 2 faz o uso das propriedades Parâmetro arrayname e Parâmetro baseurl.

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

  • 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 mesmo nome que a propriedade configurada em Parâmetro arrayname
  • {
  "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 da propriedade 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.


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

  • 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 mesmo nome que a propriedade configurada em Parâmetro arrayname
  • {
  "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 da propriedade  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.

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