Modelos em HTML (formulário HTMPL)

Este artigo contém os seguintes tópicos:
casm173
Este artigo contém os seguintes tópicos:
Os formulários na interface web do são distribuídos como modelos HTML, em arquivos com o sufixo .htmpl. Esses são chamados de formulários HTMPL no restante deste documento.
Um formulário HTMPL contém HTML padrão (incluindo JavaScript) mais extensões de linguagem que são interpretadas por um daemon do servidor (ou serviço) do chamado mecanismo da web, que fornece ao navegador o HTML padrão. Essas extensões são:
  • As referências a variáveis de servidor. São indicadas por um nome que começa com um cifrão. Podem incluir os valores de colunas do banco de dados do , referências a propriedades de configuração do mecanismo da web ou outras informações do servidor.
  • Marcas especiais que orientam o mecanismo da web a executar tarefas no servidor, como ler informações do banco de dados do . Essas marcas têm nomes no formato <PDM_...> ou <pdm_...>.
Não é necessário conhecer extensões de HTMPL ou HTML para personalizar formulários do CA SDM com o WSP.
Convenções de nomenclatura de modelos
As seguintes convenções de nomenclatura são usadas para identificar os quatro tipos básicos de arquivos HTMPL, em que
xxx
é o objeto:
Tipo de modelo
Nome
Lista (filtro de pesquisa e resultados)
list_
xxx
.htmpl
Formulário de detalhes somente leitura e de edição combinado (interface do analista)
detail_
xxx
.htmpl
Formulário de detalhes somente leitura
detail_
xxx
_ro.htmpl
Formulário de detalhes de edição
detail_
xxx
_edit.htmpl
É possível localizar as definições dos objetos e suas propriedades nos seguintes locais:
  • (UNIX) $NX_ROOT/bopcfg/majic/*.maj
  • Windows: d
    iretório-instalação\
    bopcfg\majic
Para obter informações sobre os objetos e atributos que definem o CA SDM, consulte Comandos de referência do CA Service Desk Manager.
Diretórios HTMPL
São fornecidos diferentes conjuntos de arquivos HTMPL para implementar essas interfaces, conforme mostrado na seguinte tabela:
Sistema operacional
Diretório que contém arquivos HTMPL
Windows
Diretório_de_instalação
\bopcfg\www\htmpl\web\
interface
UNIX
$NX_ROOT/bopcfg/www/htmpl/web/
interface
Nessa tabela,
interface
é o nome da interface (analista, cliente ou funcionário).
Não há nenhum diretório separado para arquivos de interface de convidado. Por padrão, essa interface usa os arquivos da interface de funcionário. É possível alterar a interface de usuário convidado modificando o tipo de acesso associado ao usuário System_anonymous. Tanto os arquivos de cliente quanto os de funcionário modificam-se dinamicamente, caso o usuário atual seja conhecido ou um convidado, usando o comando de modelo <PDM_IF> descrito neste documento.
Há três subdiretórios de interface adicionais no diretório htmpl:
  • padrão:
    contém arquivos HTMPL comuns a todas as interfaces. Ao procurar um arquivo, o mecanismo da web verifica primeiro o diretório correspondente à interface do usuário atual e, em seguida, o diretório padrão.
  • pda/analyst: (UNIX)
  • pda\analyst: (Windows)
    Contém arquivos HTMPL usados pela interface de dispositivo móvel. No CA Service Desk Manager r11.0, a interface do dispositivo móvel é fornecida apenas para analistas.
  • web/
    interface
    /legacy: (UNIX)
  • web\
    interface
    \legacy: (Windows)
    Contém arquivos HTMPL da release anterior do que não são mais usados. Esse diretório será criado automaticamente se estiver atualizando de uma versão anterior quando instalar o . É possível excluir o diretório legacy se nenhum de seus arquivos estiver relacionado aos arquivos personalizados.
É recomendável não modificar diretamente os arquivos HTMPL fornecidos. Em vez disso, use o WSP ou copie manualmente o arquivo a ser modificado para o diretório mods do site e modifique-o nesse diretório. O servidor web do procura um novo formulário no diretório site mods adequado antes de verificar o diretório de distribuição. Os diretórios site mods padrão para cada uma das interfaces são os seguintes:
Sistema operacional
Diretório de arquivos HTMPL modificados pelo site
Windows
diretório_de_instalação\site\mods\www\htmpl\interface\interface
UNIX
$NX_ROOT/site/mods/www/htmpl/
interface/interface
Se você alterar o formulário e salvá-lo no
diretório_de_instalação\site\mods\www\htmpl\interface
, ele será visto por todos os usuários, independentemente do grupo de formulários a que pertença. Se você o salvar em
diretório_de_instalação
\site\mods\www\htmpl\interface\
interface
, somente os Contatos definidos como pertencentes a esse grupo de formulários verão os formulários alterados.
Na tabela anterior,
interface
é o nome da interface (analista, cliente ou funcionário). Não há um diretório separado para arquivos de interface do convidado; essa interface usa os arquivos da interface do funcionário. A vantagem de armazenar os arquivos HTMPL modificados no diretório site mods é que esse diretório é preservado quando você instala uma nova versão ou versão de manutenção do . Além disso, manter os arquivos modificados em site mods preserva os arquivos originais e assegura que você sempre tenha uma cópia correta do arquivo HTMPL distribuído originalmente.
Cada página de interface web tem uma função primária, conforme indicado na seguinte tabela que mostra os principais modelos em HTML. No entanto, você pode adicionar blocos <PDM_FORM> a qualquer modelo para acessar diretamente qualquer operação aceita pela interface web. Pode, por exemplo, modificar o menu principal para que inclua campos de envio de ocorrências sem usar a página intermediária ou pode adicionar campos de critérios de pesquisa e um botão Pesquisar a um formulário de lista:
Página da web
Modelo do HTML
Formulário principal
menu_frames.htmpl
Exibir/criar/atualizar uma requisição de mudança
detail_chg.htmpl
Exibir uma lista de requisições de mudança
list_chg.htmpl
Exibir/criar/atualizar uma ocorrência
detail_iss.htmpl
Exibir uma lista de ocorrências
list_iss.htmpl
Exibir/criar/atualizar uma solicitação
detail_cr.htmpl
Exibir uma lista de solicitações
list_cr.htmpl
Exibir informações de detalhes do anúncio
detail_cnote_html
Exibir uma lista de anúncios
list_cnote.html
Efetuar logon
login.htmpl
Para obter uma lista completa de modelos, exiba o conteúdo dos diretórios na tabela no início desta seção.
Grupos de formulários da web
Você pode coletar páginas da web personalizadas em um ou mais grupos de formulários. Os diretórios de grupos de formulários estão nos seguintes diretórios:
  • Windows
    diretório_de_instalação\site\mods\www\htmpl\web\
    interface
    diretório_de_instalação\site\mods\www\wwwroot\subdiretório
  • UNIX
    $NX_ROOT/site/mods/www/htmpl/web/
    interface
    $NX_ROOT/site/mods/www/wwwroot/subdiretório
Cada grupo de formulários é um subdiretório nesses diretórios. Especifique o diretório de formulários personalizado no campo Grupo de formulários de personalização do tipo de acesso.
Quando um usuário solicita um formulário, o mecanismo da web verifica primeiro o diretório de grupos de formulários personalizados adequado, em seguida, o diretório padrão da interface web do usuário e, por fim, o diretório padrão. É possível definir mais de um tipo de acesso para a mesma interface web, cada um com um grupo de formulários personalizados diferente. Isso permite definir alguns formulários especializados para diferentes tipos de usuários e ainda obter a maioria dos formulários na interface padrão.
Um processo semelhante ocorre quando uma página da web solicita um arquivo de um dos subdiretórios wwwroot (css, html, img ou scripts). O mecanismo da web examina uma referência HTMPL no formato CAisd / img / xxx. gif e converte-a em um dos seguintes arquivos GIF, selecione a primeira em que encontra xxx.gif:
  • /CAisd/sitemods/img/grupo_de_formulários/xxx.gif
  • /CAisd/sitemods/img/xxx.gif
  • /CAisd/img/xxx.gif
Como criar um grupo de formulários da web
Você pode criar um grupo de formulários para especificar quais os formulários visíveis para os membros do grupo.
Siga estas etapas:
  1. Se quiser criar um grupo de formulários além dos grupos de formulários Analista, Cliente ou Funcionário predefinidos, criar um grupo de formulários selecionando Salvar como, no menu Arquivo do WSP e clicando no botão Adicionar grupo de formulários da caixa de diálogo Salvar formulário como. Por exemplo, se deseja fornecer duas versões personalizadas distintas da interface do Analista, você poderá cria grupos de formulários chamados Analista1 e Analista2 para essa finalidade. Pode também definir um novo grupo de formulários se a interface que você estiver definindo não se encaixar logicamente em um dos grupos de formulários predefinidos.
  2. Na interface web (não em uma sessão de visualização do ), selecione Segurança, Tipos de acesso no menu Administração. Em seguida, clique em um tipo de acesso (ou crie um novo) e use a lista suspensa Grupo de formulários de personalização, da janela Detalhes do tipo de acesso, para atribuir um grupo de formulários a um tipo de acesso. O determina o tipo de acesso quando um contato efetua logon e usa o grupo de formulários de personalização para especificar onde procurar formulários personalizados na estrutura de diretórios site mods. Se o mecanismo da web não encontrar um formulário no diretório de grupos de formulários, ele procurará primeiro no diretório padrão do tipo de acesso do usuário e, em seguida, no diretório padrão.
  3. No , selecione Salvar no menu Arquivo ou copie manualmente os arquivos HTMPL personalizados para o seguinte diretório:
    No Windows: diretório
    installation-directory
    \site\mods\www\htmpl\web\
    form_group_name
    No UNIX: $NX_ROOT/site/mods/www/htmpl/web/
    form_group_name
Depois de configurar um novo grupo de formulários da web e copiar os arquivos de suporte para os subdiretórios adequados, você deverá reiniciar o serviço web antes que as alterações sejam aplicadas.