Variáveis de servidor

Este artigo contém os seguintes tópicos:
casm173
Este artigo contém os seguintes tópicos:
As informações do CA SDM são incluídas no modelo em HTML usando variáveis que começam com um cifrão ($). Cada página é criada com algumas variáveis que estão documentadas no arquivo de modelo. Essas variáveis podem ser inseridas na página ou usadas em instruções condicionais:
  • Variáveis simples
  • Variáveis de propriedade
  • Variáveis de ambiente
  • Variáveis de objeto comercial
  • Variáveis de lista
Variáveis simples
Variáveis simples especificam sinalizadores que são passados para a página da web. Para acessar uma variável simples, use o nome da variável precedido por um cifrão ($). Isso torna o valor da variável disponível. Por exemplo, duas variáveis desse tipo são $CAisd e $cgi. A inserção de $CAisd em um modelo resulta na substituição do diretório de instalação do servidor web principal do CA SDM, ao passo que $cgi refere-se ao URL do programa pdmweb.exe. As variáveis simples estão documentadas na seção superior do arquivo HTMPL que as utiliza.
A seguir é mostrada uma lista de variáveis que podem ser usadas em todos os arquivos HTMPL:
  • $ACCESS.
    grupo
    O objeto de privilégio de acesso do usuário contém as configurações de privilégio do
    grupo
    de funções grupo do usuário do logon atual. Por exemplo, $ACCESS.admin contém o valor de privilégio do grupo funcional admin. Os valores de privilégio válidos são:
    • 0-SEM ACESSO
    • 1-EXIBIR
    • 2-MODIFICAR
    Esta variável não está disponível no formulário de logon.
  • $cgi
    O URL do programa pdmweb.exe.
  • $cst
    O objeto de dados do usuário do logon atual. Esta variável não está disponível no formulário de logon. É possível fazer referência a atributos individuais desse objeto com o formato $cst.
    nome_do_atributo
    ; por exemplo, $cst.first_name.
  • $CAisd
    O URL do diretório de instalação do servidor web principal do CA SDM.
  • $MachineName
    O MachineName definido no arquivo web.cfg.
  • $ProductName
    O nome do produto definido no arquivo NX.env.
  • $SESSION
    O objeto da sessão salva todas as variáveis de sessão incluindo a ID da sessão ($SESSION.SID) e todas as variáveis definidas no arquivo web.cfg.
  • $USER_STATE
    Informações sobre o estado definidas pelo usuário.
Variáveis de propriedade
As variáveis de propriedade representam uma propriedade do arquivo de configuração web.cfg. Você pode acessar qualquer entrada no arquivo web.cfg (incluindo as entradas definidas pelo usuário) dentro de um arquivo de modelo HTML com o prefixo “$prop”.
Por exemplo, uma das linhas de web cfg, que especifica o número de entradas exibidas em uma única página de um formulário de lista, é a seguinte:
ListPageLength 10
É possível fazer referência a essa variável em um modelo em HTML com a especificação:
$prop.ListPageLength
Se usar a marca especial <PDM_INCLUDE> para incorporar outro arquivo em um arquivo de modelo, você poderá especificar propriedades adicionais como atributos da marca <PDM_INCLUDE>. É possível fazer referência a essas propriedades do arquivo incluído do mesmo modo que com as propriedades de web cfg. Uma propriedade especificada como um atributo de <PDM_INCLUDE> que tenha o mesmo nome de uma propriedade de web cfg substituirá a propriedade de web cfg no arquivo incluído.
Por exemplo, a seguinte marca <PDM_INCLUDE> cria uma propriedade chamada $prop.menubar que pode ser mencionada no arquivo std_body.htmpl:
<PDM_INCLUDE FILE=std_body.htmpl menubar=no>
É possível fazer referência à propriedade do arquivo de configuração
xxx
de duas formas: $prop.
xxx
ou
$SESSION.xxx
. Ambos retornam o mesmo valor. No entanto, a sintaxe $prop.
xxx
é preferida porque envolve menos sobrecarga do servidor.
Além das propriedades de web cfg, há várias propriedades predefinidas que podem ser acessadas com $prop. São elas:
  • $prop.browser
    Uma sequência de caracteres que identifica o navegador em uso. Para o Internet Explorer, será “IE”.
  • $prop.combo_name
    Uma seqüência de caracteres que contém o nome do usuário atual, no formato “sobrenome, nome, nome_do_meio”.
  • $prop.factory
    Uma sequência de caracteres que contém a fábrica associada ao formulário atual, como “cr” para solicitações ou “iss” para ocorrências.
  • $prop.FID
    Uma sequência de caracteres que contém a ID numérica do formulário atual.
  • $prop.form_name
    Uma sequência de caracteres que contém o nome do modelo em HTML atual, no formato
    xxx
    .htmpl.
  • $prop.form_name_1
    Uma sequência de caracteres que contém a subsequência do nome do formulário antes do primeiro sublinhado. Por exemplo, para o formulário detail_chg_edit.htmpl, form_name_1 seria “detail”.
  • $prop.form_name_2
    Uma sequência de caracteres que contém a subsequência do nome do formulário depois do primeiro sublinhado e antes do último sublinhado (ou ponto). Por exemplo, para o formulário detail_chg_edit.htmpl, form_name_2 seria “chg”.
  • $prop.form_name_3
    Uma sequência de caracteres que contém a subsequência do nome do formulário depois do último sublinhado e antes do ponto. Por exemplo, no caso do formulário detail_chg_edit.htmpl, o form_name_3 será “edit”. Para o formulário de detalhes da combinação, que tenha o nome do arquivo do formulário detail_
    xxx
    .htmpl, $prop.form_name_3 será definido para a exibição atual: “ro” ou “edit”.
  • $prop.release
    Uma sequência de caracteres que contém o nível de versão do formulário. A instrução PDM_PRAGMA contém mais detalhes sobre essa propriedade.
  • $prop.SID
    Uma sequência de caracteres que contém a ID numérica da sessão atual.
  • $prop.sitemod
    Uma sequência de caracteres que contém o nome de modificação do formulário definido pelo site. A instrução PDM_PRAGMA contém mais detalhes sobre essa propriedade.
  • $prop.user_type
    Uma seqüência de caracteres que contém os itens “analista”, “cliente”, “funcionário” ou “convidado”.
  • $prop.version
    Uma sequência de caracteres que contém a versão do formulário. A instrução PDM_PRAGMA contém mais detalhes sobre essa propriedade.
Variáveis de ambiente
As variáveis de ambiente representam uma entrada do arquivo de configuração NX.env. É possível fazer referência a qualquer entrada de NX.env em um arquivo de modelo em HTMPL acrescentado-se o prefixo “$env”.
Por exemplo, uma das linhas de NX.env, que especifica o nome de host do servidor do CA SDM, é a seguinte:
@NX_SERVER=hostname
É possível fazer referência a essa variável em um arquivo de modelo em HTMPL com a especificação:
$env.NX_SERVER
Variáveis de objeto comercial
As variáveis Businessobject representam um objeto do CA SDM, como uma ocorrência ou uma solicitação. Para acessar um objeto, é necessário iniciar com o nome da variável, seguido por um ponto (.), seguido pelo nome do atributo a ser exibido. Por exemplo, em uma ocorrência em que, por convenção, o objeto é representado pela variável args, você pode exibir a descrição, a data de abertura, o número de telefone do destinatário, o número de atividades na ocorrência e a descrição da primeira atividade, conforme mostrado a seguir:
$args.description $args.open_date $args.assignee.phone_number $args.act_log.length $args.act_log.0.description
É possível usar chaves para delimitar o nome da variável caso ela não esteja cercada de espaços em branco. Por exemplo, tanto $foo bar quanto ${foo}bar são válidos. Você também pode usar a variável args para acessar valores que não sejam de atributos (por exemplo, $args.KEEP.
nome
, conforme descrito em Operações aceitas).
Talvez não seja possível definir uma variável que não seja de atributo. Por exemplo, talvez seja possível acessar um formulário a partir de dois locais diferentes, sendo que apenas um deles fornece um valor para $args.KEEP.foo. Você pode fornecer um valor padrão para uma referência de $args com a seguinte sintaxe, em que a sequência de caracteres depois dos dois-pontos será substituída pela referência se o valor de
variável
for indefinido:
${args.variable:default}
  • Variáveis de data de fuso horário
    As variáveis de data de fuso horário são um caso especial de variáveis de objeto comercial. Elas fornecem um meio de converter datas universais (UTC), representadas por números inteiros, em datas de sequência de caracteres ajustadas para o fuso horário do navegador do usuário. A variável para representar datas de número inteiro é:
    $args.attr_name_INT_DATE
    Exemplo:
    $args.open_date_INT_DATE
  • Variáveis de dados de fábrica
    As variáveis de dados de fábrica são um caso especial de variáveis de objeto comercial. Uma variável de dados de fábrica é substituída pelas informações sobre um objeto de referência. Há sete variáveis desse tipo disponíveis:
    • $args.
      nome_do_atributo
      .COMMON_NAME
      O nome comum (sequência de caracteres legível externamente) da tabela mencionada pelo atributo. Por exemplo, no formulário de Detalhes da solicitação, o valor de $args.assignee.COMMON_NAME é o nome de combinação do destinatário (“sobrenome, nome, nome do meio”).
    • $args.attr_name.COMMON_NAME_ATTR
      O nome de atributo do nome comum na tabela mencionada pelo atributo. Por exemplo, no formulário de Detalhes da solicitação, o valor de $args.assignee.COMMON_NAME_ATTR é “combo_name”.
    • $args.FACTORY_
      nome_do_atributo
      O nome da fábrica associada ao atributo especificado. Por exemplo, no formulário de Detalhes da solicitação, o valor de $args.FACTORY_assignee é “agt”.
    • $args.LENGTH_
      nome_do_atributo
      O tamanho máximo do atributo. Por exemplo, no formulário de Detalhes da solicitação, o valor de $args.LENGTH_summary é 240.
    • $args.
      nome_do_atributo
      .REL_ATTR
      O atributo rel attr (chave estrangeira) do atributo. Por exemplo, no formulário de Detalhes da solicitação, o valor de $args.assignee.REL_ATTR é o valor do campo ID do destinatário.
    • $args.
      nome_do_atributo
      .REL_ATTR_ATTR
      O nome do atributo rel_attr na tabela mencionada pelo atributo. Por exemplo, no formulário de Detalhes da solicitação, o valor de $args.assignee.REL_ATTR_ATTR é “id”.
    • $args.REQUIRED_
      nome_do_atributo
      Uma seqüência de caracteres, “0” ou “1”, que indica se o atributo de referência é obrigatório.
    • $args.
      nome_do_atributo
      .SELECTIONS
      Uma lista de seleções válidas para
      nome_do_atributo
      . Esse valor será uma sequência de caracteres vazia se
      nome_do_atributo
      não for uma referência a outra tabela ou se o tamanho de tabela mencionada por
      nome_do_atributo
      exceder o valor da propriedade de arquivo de configuração SelListCacheMax. Caso contrário, a variável SELECTIONS será uma sequência de caracteres que contém o nome comum e o atributo rel attr de todas as entradas na tabela de referência. Valores sucessivos são separados pele sequência de caracteres “@,@”; assim, o valor da variável tem o formato:
      "[email protected],@[email protected],@[email protected],@rel_attr2"
    • $args.
      fábrica
      _SEL_UNDER_LIMIT
      Uma sequência de caracteres, “0” ou “1”, que indica se o número atual de linhas na tabela que corresponde a
      fábrica
      é inferior ao valor da propriedade de arquivo de configuração SelListCacheMax. Essa variável é preterida em favor da variável SELECTIONS, que deve ser usada em todos os novos formulários.
    As variáveis de dados de fábrica que contêm uma referência com pontos (COMMON_NAME, REL_ATTR e SELECTIONS) podem ser usadas com uma referência com pontos de qualquer tamanho. Por exemplo, em um formulário de Detalhes da solicitação, $args.assignee.organization.COMMON_NAME é substituído pelo nome externo da organização do destinatário.
Variáveis de lista
As variáveis de lista são usadas para iteração nos dados. Eles são acessados usando as marcas de lista como descrito em PDM_LIST: formatar uma lista de linhas do banco de dados.