Variabili del server

Questo articolo contiene i seguenti argomenti:
casm173
Questo articolo contiene i seguenti argomenti:
Le informazioni su CA SDM vengono incluse nel modello HTML usando variabili che iniziano con il simbolo del dollaro ($). Ogni pagina viene creata con alcune variabili che sono documentate nel file modello. Queste variabili possono essere inserite nella pagina o usate in istruzioni condizionali:
  • Variabili semplici
  • Variabili delle proprietà
  • Variabili di ambiente
  • Variabili degli oggetti di business
  • Variabili degli elenchi
Variabili semplici
Le variabili semplici specificano i flag che vengono passati alla pagina Web. Per accedere a una variabile semplice, usare il nome preceduto dal simbolo del dollaro ($). In questo modo si rende disponibile il valore della variabile. $CAisd e $cgi sono due esempi di questo tipo di variabile. Inserendo $CAisd in un modello si sostituisce la directory di installazione del server Web principale di CA SDM, mentre $cgi fa riferimento all'URL del programma pdmweb.exe. Le variabili semplici sono documentate nella sezione superiore del file HTMPL in cui sono usate.
Di seguito è riportato l'elenco delle variabili che possono essere usate in tutti i file HTMPL:
  • $ACCESS.
    gruppo
    L'oggetto privilegio di accesso dell'utente contiene le impostazioni dei privilegi nel
    gruppo
    funzionale per l'utente corrente. Ad esempio, $ACCESS.admin gestisce il valore del privilegio per il gruppo funzionale admin. I valori dei privilegi validi sono:
    • 0 (Nessun accesso)
    • 1 (Visualizzazione)
    • 2 (Modifica)
    Questa variabile non è disponibile nel modulo di accesso.
  • $cgi
    L'URL del programma pdmweb.exe.
  • $cst
    L'oggetti dati dell'utente corrente. Questa variabile non è disponibile nel modulo di accesso. È possibile fare riferimento a singoli attributi di questo oggetto usando il formato $cst.
    nomeattr
    ; ad esempio, $cst.first_name.
  • $CAisd
    L'URL della directory di installazione del server Web principale di CA SDM.
  • $MachineName
    Il MachineName definito nel file web.cfg.
  • $ProductName
    Il nome del prodotto definito nel file NX.env.
  • $SESSION
    L'oggetto sessione salva tutte le variabili di sessione includendo l'ID di sessione ($SESSION.SID) e tutte le variabili definite dal file web.cfg.
  • $USER_STATE
    Informazioni sullo stato definito dall'utente.
Variabili delle proprietà
Le variabili delle proprietà rappresentano una proprietà del file di configurazione, web.cfg. È possibile accedere a qualsiasi voce nel file web.cfg (comprese voci definite dall'utente) all'interno di un file modello HTML aggiungendo il prefisso “$prop.”
Di seguito è riportato un esempio di una delle righe di web.cfg, che specifica il numero di voci visualizzate in una singola pagina in un modulo elenco:
ListPageLength 10
È possibile fare riferimento a questa variabile in un modello HTML specificando:
$prop.ListPageLength
Se si usa il tag speciale <PDM_INCLUDE> per incorporare un altro file in un file modello, è possibile specificare proprietà aggiuntive come attributi del tag <PDM_INCLUDE>. È possibile fare riferimento a queste proprietà nel file incluso allo stesso modo usato per le proprietà di web.cfg. Una proprietà specificata come attributo <PDM_INCLUDE> avente lo stesso nome di una proprietà di web.cfg sostituisce la proprietà di web.cfg nel file incluso.
Ad esempio, il tag seguente <PDM_INCLUDE> include una proprietà denominata $prop.menubar a cui si può fare riferimento all'interno del file std_body.htmpl:
<PDM_INCLUDE FILE=std_body.htmpl menubar=no>
È possibile fare riferimento a una proprietà del file di configurazione
xxx
in due modi: $prop.
xxx
o
$SESSION.xxx
. Entrambi restituiscono lo stesso valore. Tuttavia si preferisce la sintassi $prop.
xxx
perché comporta un minore carico sul server.
Oltre alle proprietà di web.cfg, esistono diverse proprietà predefinite a cui si può accedere con $prop. Esse sono:
  • $prop.browser
    Stringa che identifica il browser usato. Ad esempio "IE" per Internet Explorer.
  • $prop.combo_name
    Stringa contenente il nome dell'utente corrente, nel formato "last_name, first_name middle_name".
  • $prop.factory
    Stringa contenente il factory associato al modulo corrente, ad esempio "cr" per le richieste o "iss" per le Issue.
  • $prop.FID
    Stringa contenente l'ID numerico del modulo corrente.
  • $prop.form_name
    Stringa contenente il nome del modello HTML corrente, nel formato
    xxx
    .htmpl.
  • $prop.form_name_1
    Stringa contenente la sottostringa del nome del modulo prima del primo trattino di sottolineatura. Ad esempio, per il modulo detail_chg_edit.htmpl, form_name_1 è "detail".
  • $prop.form_name_2
    Stringa contenente la sottostringa del nome del modulo dopo il primo trattino di sottolineatura e prima dell'ultimo trattino di sottolineatura (o del punto). Ad esempio, per il modulo detail_chg_edit.htmpl, form_name_2 è "chg".
  • $prop.form_name_3
    Stringa contenente la sottostringa del nome del modulo dopo l'ultimo trattino di sottolineatura e prima del punto. Per esempio, per il modulo detail_chg_edit.htmpl, form_name_3 sarebbe “modifica”. Per il modulo dettaglio combinazione , che ha un nome file del modulo detail_
    xxx
    .htmpl, $prop.form_name_3 è impostata sulla visualizzazione attuale, “sl” o “modifica”.
  • $prop.release
    Stringa contenente il livello di release del modulo. L'istruzione PDM_PRAGMA contiene più dettagli su questa proprietà.
  • $prop.SID
    Stringa contenente l'ID numerico della sessione corrente.
  • $prop.sitemod
    Stringa contenente il nome della modifica definita in locale del modulo. L'istruzione PDM_PRAGMA contiene più dettagli su questa proprietà.
  • $prop.user_type
    Stringa contenente "analyst," "customer," "employee" o "guest".
  • $prop.version
    Stringa contenente la versione del modulo. L'istruzione PDM_PRAGMA contiene più dettagli su questa proprietà.
Variabili di ambiente
Le variabili dell'ambiente rappresentano una voce nel file di configurazione NX.env. È possibile fare riferimento a qualsiasi voce del file NX.env all'interno di un file modello HTMPL inserendo il prefisso "$env".
Di seguito è riportato l'esempio di una delle righe di NX.env, che specifica il nome host del server CA SDM:
@NX_SERVER=hostname
È possibile fare riferimento a questa variabile in un file modello HTMPL specificando:
$env.NX_SERVER
Variabili degli oggetti di business
Le variabili di BusinessObject rappresentano un oggetto di CA SDM, ad esempio una Issue o una richiesta. Per accedere a un oggetto, è necessario iniziare con il nome della variabile, seguito da un punto (.) e da qualsiasi nome di attributo che si desidera visualizzare. Ad esempio, in una Issue in cui, per convenzione, l'oggetto è rappresentato dalla variabile args, è possibile visualizzare la descrizione, la data di apertura, il numero di telefono dell'assegnatario, il numero di attività sulla Issue e la descrizione della prima attività, come mostrato di seguito:
$args.description $args.open_date $args.assignee.phone_number $args.act_log.length $args.act_log.0.description
È possibile usare le parentesi graffe per delimitare il nome della variabile se non è circondato da spazi. Ad esempio, $foo bar e ${foo}bar sono nomi validi. È possibile anche usare la variabile args per accedere a valori che non sono attributi (ad esempio, $args.KEEP.
nome
, come descritto in Operazioni supportate).
Una variabile non attributo può non essere definita. Ad esempio, è possibile accedere a un modulo da due punti diversi, di cui solo uno fornisce un valore per $args.KEEP.foo. È possibile specificare un valore predefinito per un riferimento $args usando la sintassi seguente, in cui il riferimento è sostituito dalla stringa dopo i due punti se la
variabile
non è definita:
${args.variable:default}
  • Variabili delle date con fuso orario
    Le variabili delle date con fuso orario sono un tipo speciale di variabili degli oggetti azienda. Forniscono un mezzo per convertire le date in formato universale (UTC), rappresentate come numeri interi, in date in formato di stringa adattate al fuso orario del browser dell'utente. La variabile per rappresentare le date con numeri interi è:
    $args.attr_name_INT_DATE
    Esempio:
    $args.open_date_INT_DATE
  • Variabili dei dati factory
    Le variabili dei dati factory sono un tipo speciale di variabili degli oggetti azienda. Una variabile dei dati factory è sostituita dalle informazioni su un oggetto a cui si fa riferimento. Sono disponibili sette variabili di questo tipo:
    • $args.
      nome_attr
      .COMMON_NAME
      Il nome comune (stringa leggibile dall'esterno) della tabella a cui fa riferimento l'attributo. Ad esempio, nel modulo Dettagli richiesta, il valore di $args.assignee.COMMON_NAME è il nome combinazione dell'assegnatario ("last, first, middle").
    • $args.nome_attr.COMMON_NAME_ATTR
      Il nome dell'attributo del nome comune nella tabella a cui fa riferimento l'attributo. Ad esempio, nel modulo Dettagli richiesta, il valore di $args.assignee.COMMON_NAME_ATTR è il "combo_name".
    • $args.FACTORY_
      nome_attr
      Il nome del factory associato all'attributo specificato. Ad esempio, nel modulo Dettagli richiesta, il valore di $args.FACTORY_assignee è "agt".
    • $args.LENGTH_
      nome_attr
      La lunghezza massima dell'attributo. Ad esempio, nel modulo Dettagli richiesta, il valore di $args.LENGTH_summary è 240.
    • $args.
      nome_attr
      .REL_ATTR
      REL_ATTR (chiave esterna) dell'attributo. Ad esempio, nel modulo Dettagli richiesta, il valore di $args.assignee.REL_ATTR è il valore del campo dell'ID dell'assegnatario.
    • $args.
      nome_attr
      .REL_ATTR_ATTR
      Il nome dell'attributo di REL_ATTR nella tabella a cui fa riferimento l'attributo. Ad esempio, nel modulo Dettagli richiesta, il valore di $args.assignee.REL_ATTR_ATTR è "id".
    • $args.REQUIRED_
      nome_attr
      Una stringa, "0" o "1", indicante se è necessario l'attributo a cui si fa riferimento.
    • $args.
      nome_attr
      .SELECTIONS
      Un elenco di selezioni valide per
      nome_attr
      . Questo valore è una stringa vuota se
      nome_attr
      non è un riferimento a un'altra tabella o se la dimensione della tabella a cui fa riferimento
      nome_attr
      supera il valore della proprietà SelListCacheMax nel file di configurazione. Altrimenti la variabile SELECTIONS è una stringa contenente il nome comune e il REL_ATTR di tutte le voci nella tabella a cui si fa riferimento. I valori successivi sono separati dalla stringa "@,@", in modo che il valore della variabile abbia il formato:
      "[email protected],@[email protected],@[email protected],@rel_attr2"
    • $args.
      factory
      _SEL_UNDER_LIMIT
      Una stringa, "0" o "1", che indica se il numero corrente di righe nella tabella corrispondente a
      factory
      è minore del valore della proprietà SelListCacheMax nel file di configurazione. A questa variabile si preferisce la variabile SELECTIONS, che dovrebbe essere usata in tutti i nuovi moduli.
    Il riferimento con notazione a punti presente nelle variabili dei dati factory (COMMON_NAME, REL_ATTR e SELECTIONS) può avere una lunghezza qualsiasi. Ad esempio, in un modulo Dettagli richiesta $args.assignee.organization.COMMON_NAME viene sostituito dal nome esterno dell'organizzazione dell'assegnatario.
Variabili degli elenchi
Le variabili degli elenchi sono usate per eseguire iterazioni tra i dati. Vi si accede utilizzando tag elenco come descritto in PDM_LIST: formattazione di un elenco di righe del database.