Operações suportadas pelo servidor

Este artigo contém os seguintes tópicos:
casm173
Este artigo contém os seguintes tópicos:
As seguintes operações são aceitas para permitir que você integre as páginas da web do CA SDM a suas páginas da web:
  • CREATE_NEW
    Fornece uma interface genérica que permite que o usuário crie uma linha em uma tabela especificada. O nome do objeto deve ser especificado e, por padrão, um modelo com o nome
    detalhe_xxx
    _edit.htmpl é usado para o objeto
    xxx
    . É possível substituir o arquivo .htmpl especificando a propriedade HTMPL.
    • Especificadores obrigatórios:
      FACTORY=
      nome
      _
      do_objeto
    • Especificadores opcionais:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL=preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=zdetailxxx_
      factory
      .htmplKEEP
      .attr_name=value
      PRESET=
      preset_expression
      PRESET_REL=
      preset expression
      SET
      .attr_name=value
      use_template=1 | 0 (0 é o padrão)
    Para usar o especificador HTMPL com CREATE_NEW, o formulário de referência deve ter um nome compatível com a convenção de nomenclatura zdetailxxx_
    factory
    .htmpl. Deve começar com a sequência “zdetail”, seguida de quaisquer caracteres alfanuméricos (incluindo uma sequência de caracteres nula), um sublinhado e o nome da fábrica.
  • ENDSESSION ou LOGOUT
    Termina a sessão de logon atual. ENDSESSION é a operação preferencial.
  • GENERIC_LIST
    Fornece uma interface genérica que permite que o usuário exiba uma lista em qualquer tabela do banco de dados. O nome do objeto deve ser especificado e, por padrão, um modelo com o nome list_
    xxx
    .htmpl é usado para o objeto
    xxx
    . É possível substituir o arquivo .htmpl especificando a propriedade HTMPL.
    • Especificadores obrigatórios:
      FACTORY=
      object
      -
      name
      KEEP
      .attr_name=value
  • DISPLAY_FORM
    Fornece uma interface genérica que permite que o usuário exiba qualquer formulário personalizado.
    • Especificadores obrigatórios:
      HTMPL=
      arquivo_htmpl
    DISPLAY_FORM substitui JUST_GRONK_IT. As implementações existentes podem continuar a usar o JUST_GRONK_IT, que funciona exatamente como o DISPLAY_FORM. DISPLAY_FORM é a operação preferencial.
  • MENU
    Exibe a página do menu principal, que é definida no arquivo web.cfg, na propriedade Menu.
    • Especificadores opcionais:
      HTMPL=
      arquivo_de_menu
      arquivo_de_menu
      é o nome de um arquivo de menu principal alternativo.
  • PAGE_EXTENSION
    Permite que o webmaster especifique extensões adicionais para a interface.
    • Especificadores obrigatórios:
      NAME=
      arquivo_html
      html_file
      é um dos nomes de arquivos listados na diretiva UserPageExtensions do arquivo de configuração.
    • Especificadores opcionais:
      REQUIRES_LOGIN=1
      Quando presente, a página de logon aparecerá primeiro se o usuário não estiver conectado no momento. Se for omitido ou definido como zero, o arquivo é exibido sem verificar se o usuário está atualmente conectado.
  • RELOG
    Exibe a página de logon.
  • SEARCH
    Fornece uma interface genérica que permite pesquisar qualquer tabela no banco de dados. Esta operação presume que um search_
    xxx
    .htmpl foi criado, onde
    xxx
    é o
    nome do objeto
    , como definido nos arquivos .maj, no diretório majic, em bopcfg.
    Para obter mais informações, consulte Comandos de referência do CA Service Desk Manager. Por padrão, os resultados dessa pesquisa são exibidos em list_
    xxx
    .htmpl, mas eles podem ser substituídos pela especificação da propriedade HTMPL.
    • Especificadores obrigatórios:
      FACTORY=
      object-name
      QBE.
      op
      .
      attr_name
      =
      value
    • Especificadores opcionais:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      list_htmpl_file
      KEEP
      .attr_name=value
  • SEC_REFRESH
    Atualiza as informações de acesso do usuário no subsistema de segurança. Na tela de menu, é fornecido um hiperlink para essa operação aos usuários com os privilégios MODIFY (para o grupo funcional admin). Depois de atualizar os privilégios de acesso de um usuário com o programa de segurança, essa operação fornecerá um meio de atualizar as informações de acesso. Essa operação atualiza as informações de segurança de todos os usuários.
    A atualização de segurança é um processo assíncrono. Quando a atualização da segurança for realizada, uma mensagem será mostrada no arquivo padrão de log (stdlog).
  • SET_MENU
    O comportamento dessa operação é idêntico à de MENU quando MENU é usado com a variável de HTMPL. A única diferença é que essa operação define também o formulário de menu padrão como o formulário de menu especificado com a propriedade HTMPL.
    • Especificadores obrigatórios:
      HTMPL=
      arquivo_htmpl
    Essa operação substituirá a definição de MENU no web.cfg até que o serviço web seja reiniciado.
  • SHOW_DETAIL
    Fornece uma interface genérica que permite que o usuário exiba um detalhe somente leitura de uma linha em uma tabela especificada. É necessário especificar o nome da ID persistente (a partir do qual é deduzido o nome do objeto). Por padrão, é usado um modelo chamado detail_
    xxx
    _ro.htmpl para o objeto
    xxx
    . O arquivo .htmpl pode ser substituído especificando a propriedade HTMPL.
    • Especificadores obrigatórios:
      PERSID=
      persistent
      -
      id
    • Especificadores opcionais:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      readonly_detail_htmpl_file
  • UPDATE
    Fornece uma interface genérica para editar qualquer tabela. A ID e o nome do objeto devem ser transmitidos e um formulário de detalhes editável é exibido para o usuário. Por padrão, o usuário tem acesso exclusivo ao registro durante dois minutos e a garantia de colocar mudanças no banco de dados se forem enviadas nesse período.
    • Especificadores obrigatórios:
      PERSID=
      persistent-id
      orSET.id=
      id-of-row-to-update
      FACTORY=
      object-name
    • Especificadores opcionais:
      NEXT_PERSID=
      id
      -
      persistente
      (do registro a ser exibido após uma atualização com êxito)KEEP
      .attr_name=value
      KEY
      .attr_name=value
      HTMPL=zdetailxxx_
      factory
      .htmpl
    Para usar o especificador HTMPL com UPDATE, o formulário de referência deve ter um nome compatível com a convenção de nomenclatura zdetailxxx_
    factory
    .htmpl. O nome deve começar com a sequência “zdetail”, seguida de quaisquer caracteres alfanuméricos (incluindo uma sequência de caracteres nula), um sublinhado e o nome da fábrica.
Para obter informações sobre o web.cfg, consulte Como configurar a interface web.
Variáveis de operação
Esta tabela lista as variáveis que podem ser definidas para cada uma das operações com suporte:
Variáveis
Descrição
Operações
ALG_PRESET
ALG_PRESET_REL
Especifica valores para um ou mais dos atributos do log de atividades criado como resultado da variável CREATE_ALG. Se CREATE_ALG não for especificada, ALG_PRESET e ALG_PRESET_REL serão ignoradas.
CREATE_NEWSEARCHSHOW_DETAIL
CREATE_ALG
Especifica o tipo de log de atividades a ser criado como efeito colateral da operação. Use as variáveis ALG_PRESET ou ALG_PRESET_REL para especificar valores para os atributos do novo log de atividades.
A sincronização de criação do log de atividades depende da operação, conforme indicado a seguir:
CREATE_NEW
O log de atividades é criado quando o novo registro é salvo. Se o novo registro não for salvo, não será criado nenhum log de atividades.
SEARCH
O log de atividades é criado quando um registro é selecionado no formulário de lista. Se o registro for exibido em vez de selecionado (isto é, se o usuário selecionar explicitamente o comando Exibir no menu mouse-over do formulário de lista), não será criado nenhum log de atividades.
SHOW_DETAIL
O log de atividades é criado antes que o registro seja exibido.
CREATE_NEWSEARCHSHOW_DETAIL
FACTORY
Especifica a classe de objeto a ser pesquisada, criada ou atualizada. Você pode usar qualquer nome especificado como um OBJETO nos arquivos *.maj da pasta $NX_ROOT/bopcfg, conforme listado na seção Comandos de referência do CA Service Desk Manager.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
HTMPL
Permite que o autor de HTMPL substitua a convenção de nomenclatura de modelos padrão e especifique explicitamente o arquivo HTMPL a ser exibido no lugar do modelo padrão.
Observação:
quando o especificador de HTMPL é usado com CREATE_NEW ou UPDATE, o nome do formulário de referência deve seguir a convenção de nomenclatura zdetailxxx_factory.htmpl, em que xxx representa quaisquer caracteres e
factory
é o nome da fábrica.
CREATE_NEWDISPLAY_FORMJUST_GRONK_ITMENUSEARCHSET_MENUSHOW_DETAIL
UPDATE
KEEP.
nome
Especifica o valor que pode ser salvo e transmitido entre páginas.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
KEY.
nome_do_atributo
Semelhante a SET.
nome_do_atributo
, com exceção de que essa opção especifica uma pesquisa em
nome_do_atributo
, que deve ser uma referência a outra tabela ou objeto.
UPDATE
NEXT_PERSID
Especifica a ID persistente do registro a ser exibido a seguir.
UPDATE
PERSID
Especifica a ID persistente de um registro a ser exibido. Você pode especificar este item de uma das seguintes maneiras:
Diretamente, com uma ID persistente que consiste em um nome de fábrica do objeto, dois-pontos (:) e uma ID do banco de dados de números inteiros exclusiva. Por exemplo, PERSID=chg:1234 especifica a requisição de mudança com ID do banco de dados 1234.
Indiretamente, com uma ID persistente que consiste em um nome de fábrica do objeto, dois-pontos (:), um nome de atributo, um segundo sinal de dois-pontos (:)e um valor. Essa forma de PERSID determina o registro da fábrica indicada que tem um atributo com o valor especificado. Por exemplo, PERSID=chg:chg_ref_num:demo:3 especifica a requisição de mudança com número de referência demo:3.
SHOW_DETAILUPDATE
PRESET
PRESET_REL
Especifica valores para um ou mais dos atributos do registro criado como resultado da variável CREATE_NEW. Se CREATE_NEW não for especificada, PRESET será ignorada.
CREATE_NEW
QBE.
op
.
nome_do_atributo
Especifica os valores a serem usados ao executar uma pesquisa. Esses valores são identificados usando-se uma palavra-chave QBE, em que
nome_do_atributo
identifica qualquer nome de atributo em um ticket que possa ser definido e
op
indica onde procurar o atributo:
EQ é igual ao valor
NE é diferente do valor
GT é maior que o valor
LT é menor que o valor
GE é maior ou igual ao valor
LE é menor ou igual ao valor.
NU é nulo.
NN não é nulo
IN corresponde à expressão SQL LIKE
KY contém o texto digitado
Se você não definir nenhuma variável QBE, será exibida a janela de pesquisa padrão.
SEARCH
SET.
nome_do_atributo
Especifica um nome de atributo a ser usado quando um ticket é criado, em que
nome_do_atributo
identifica qualquer atributo em um ticket que possa ser definido. Os nomes de atributo variam de acordo com o objeto subjacente. Todos os objetos e seus atributos podem ser encontrados nos arquivos *.maj do diretório majic, em bopcfg, conforme indicado na seção Comandos de referência do CA Service Desk Manager.
CREATE_NEWUPDATE
SET.
id
Especifica a ID do banco de dados da linha a ser atualizada.
UPDATE
SKIPLIST
Quando definida como 1, pesquisa esse resultado em 1 localização; não exibe a lista de resultados de pesquisa. Em vez disso, são exibidos diretamente os detalhes somente leitura.
SEARCH
use_template
Quando definida como 1, a operação SEARCH retorna uma lista de modelos. O modelo retornado selecionado será usado na operação CREATE_NEW para preencher um novo registro. Essa variável é válida para requisições de mudança, ocorrências e solicitações.
CREATE_NEWSEARCH
Sintaxe de PRESET, PRESET_REL, ALG_PRESET e ALG_PRESET_REL
As palavras-chave PRESET, PRESET_REL, ALG_PRESET e ALG_PRESET_REL do URL especificam valores iniciais para atributos do ticket e seu log de atividades, respectivamente. Há dois formatos possíveis:
  • [ALG_]PRESET=
    attr
    :
    valor
    Indica que o atributo especificado do ticket ou do log de atividades deve ser definido com o valor especificado. Por exemplo, a seguinte especificação define a descrição do novo ticket como “Olá:”
    PRESET=description:Hello
  • [ALG_]PRESET_REL=attr:obj.relattr:testattr:value
    Indica que o atributo especificado do ticket ou do log de atividades deve ser definido com um valor copiado de outra tabela do banco de dados. O valor é copiado do atributo
    relattr
    do
    obj
    cujo
    testattr
    tem o
    valor
    especificado. Por exemplo, a seguinte especificação define o atributo analista do novo ticket como a ID do contato com ID de usuário xyz123:
    PRESET_REL=analyst:cnt.id:userid:xyz123
    Quando esse formato é usado, a consulta implícita deve recuperar um registro exclusivo. Se mais de um contato (ou nenhum) tiver uma ID de usuário xyz123, a especificação PRESET de exemplo não terá nenhum efeito.
As palavras-chave PRESET, PRESET_REL, ALG_PRESET e ALG_PRESET_REL podem ocorrer tantas vezes quantas forem desejadas em um URL, permitindo a definição de vários atributos. Como alternativa, um único operando de palavra-chave pode especificar múltiplos valores separados por @@. Se o separador '@@' for usado, você não pode misturar formatos de valor para as palavras-chave [ALG_]PRESET e [ALG_]PRESET_REL. Por exemplo, a seguir são mostradas duas maneiras diferentes de especificar valores para descrição do ticket, resumo e analista:
PRESET=description:Hello+PRESET=summary:HelloThere+PRESET_REL=analyst:cnt.id:userid:xyz123 PRESET=description:[email protected]@summary:HelloThere+PRESET_REL=analyst:cnt.id:userid:xyz123
Para solicitações, ocorrências, incidentes, problemas e requisições de mudança, tanto PRESET quanto PRESET_REL aceitam um atributo de palavra-chave ASSET para vincular um objeto a um ativo. O atributo ASSET atualiza o atributo affected_resource de uma solicitação, incidente ou problema, ou o LREL de ativo de uma ocorrência ou requisição de mudança.
Exemplos de link
Os exemplos de links a seguir não incluem o caminho para o CA SDM. Todos os URLs do CA SDM começam com uma codificação no seguinte formato:
http://
nome_do_host
[:
porta
]/CAisd/pdmweb.exe
Neste exemplo,
nome_do_host
é o nome do servidor e
porta
(opcional) é o número da porta, caso esteja sendo usado o Tomcat. Essa codificação é mostrada como reticências (…) nos seguintes exemplos de URL:
  • Para criar uma solicitação com um usuário final afetado com a ID de usuário tooda01, use o exemplo de URL a seguir:
    ...?OP=CREATE_NEW+FACTORY=cr+PRESET_REL=customer:cnt.id:userid:tooda01
  • Para exibir uma lista de todas as solicitações atribuídas para a ID de usuário tooda01, use o exemplo de URL a seguir:
    ...?OP=SEARCH+FACTORY=cr+QBE.EQ.assignee.userid=tooda01
  • Para exibir o formulário de detalhes para solicitação 1234, use os URLs de exemplo:
    ...?OP=SHOW_DETAIL+FACTORY=cr+PERSID=cr:ref_num:1234 (read-only view) ...?OP=UPDATE+FACTORY=cr+PERSID=cr:ref_num:1234 (update view)
Você pode ignorar o desafio de logon usando os Serviços web para autenticação. Para obter informações sobre o método getBopsid(), consulte a seção Comandos de referência do CA Service Desk Manager.