Operaciones de servidor compatibles

Este artículo contiene los siguientes temas:
casm173
Este artículo contiene los siguientes temas:
A fin de permitirle integrar las páginas web de CA SDM en sus páginas web, se admiten las siguientes operaciones:
  • CREATE_NEW
    Proporciona una interfaz genérica para permitir al usuario crear una fila en una tabla especificada. Debe especificarse el nombre de objeto y, de forma predeterminada, se emplea una plantilla llamada
    detail_xxx_
    edit.htmpl para el objeto
    xxx
    . Puede anular el archivo .htmpl si especifica la propiedad HTMPL.
    • Especificadores obligatorios:
      FACTORY=
      nombre
      -
      objeto
    • Especificadores opcionales:
      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 es el valor predeterminado)
    Para usar el especificador HTMPL con CREATE_NEW, el formulario al que se hace referencia debe tener un nombre conforme con la convención de nomenclatura zdetailxxx_
    fábrica
    .htmpl. El nombre debe comenzar por la cadena zdetail, seguida de cualquier carácter alfanumérico (incluida una cadena nula) y, a continuación, de un guion bajo y del nombre de la fábrica.
  • ENDSESSION o LOGOUT
    Finaliza la sesión iniciada en ese momento. ENDSESSION es la operación preferible.
  • GENERIC_LIST
    Proporciona una interfaz genérica para permitir al usuario mostrar una lista a partir de cualquier tabla de la base de datos. Debe especificarse el nombre de objeto y, de forma predeterminada, se emplea una plantilla llamada list_
    xxx
    .htmpl para el objeto
    xxx
    . Puede anular el archivo .htmpl si especifica la propiedad HTMPL.
    • Especificadores obligatorios:
      FACTORY=
      object
      -
      name
      KEEP
      .attr_name=value
  • DISPLAY_FORM
    Proporciona una interfaz genérica para permitir al usuario mostrar cualquier formulario personalizado.
    • Especificadores obligatorios:
      HTMPL=
      archivo_htmpl
    DISPLAY_FORM reemplaza a JUST_GRONK_IT. Las implementaciones existentes pueden continuar utilizando JUST_GRONK_IT, que funciona exactamente igual a DISPLAY_FORM. DISPLAY_FORM es la operación preferible.
  • MENU
    Muestra la página de menú principal, que se define en el archivo web.cfg en la propiedad Menu.
    • Especificadores opcionales:
      HTMPL=
      archivo_menú
      archivo_menú
      es el nombre de un archivo de menú principal alternativo.
  • PAGE_EXTENSION
    Permite al administrador Web especificar más extensiones para la interfaz.
    • Especificadores obligatorios:
      NAME=
      archivo_html
      archivo_html
      es uno de los nombres de archivo que se enumeran en la directiva UserPageExtensions del archivo de configuración.
    • Especificadores opcionales:
      REQUIRES_LOGIN=1
      Si está presente, primero aparecerá una página de inicio de sesión si el usuario no ha iniciado sesión aún. Si se omitió o estableció en cero, el archivo se muestra sin comprobar si el usuario está conectado actualmente.
  • RELOG
    Muestra la página de inicio de sesión.
  • SEARCH
    Proporciona una interfaz genérica para permitir la búsqueda de tablas en la base de datos. Esta operación supone que se ha creado un search_
    xxx
    .htmpl apropiado, donde
    xxx
    es el
    nombre de objeto
    , tal como se define en los archivos .maj del directorio majic en bopcfg.
    Para obtener más información, consulte Comandos de referencia de CA Service Desk Manager. De forma predeterminada, los resultados de esta búsqueda se muestran en list_
    xxx
    .htmpl, aunque podría omitirse si se especifica la propiedad HTMPL.
    • Especificadores obligatorios:
      FACTORY=
      object-name
      QBE.
      op
      .
      attr_name
      =
      value
    • Especificadores opcionales:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      list_htmpl_file
      KEEP
      .attr_name=value
  • SEC_REFRESH
    Actualiza la información de acceso del usuario procedente del subsistema de seguridad. A los usuarios que cuentan con privilegio de modificación (para el grupo funcional admin) se les proporciona, en la pantalla de menú, un hipervínculo para esta operación. Después de actualizar el privilegio de acceso de un usuario mediante el programa de seguridad, esta operación proporciona un medio de actualizar la información de acceso. (Esta operación actualiza la información de seguridad correspondiente a todos los usuarios).
    La actualización de la seguridad es un proceso asíncrono. Cuando se termine la actualización de seguridad, aparecerá un mensaje en el archivo de registro estándar (stdlog).
  • SET_MENU
    El comportamiento de esta operación es el mismo que el de la operación MENU cuando MENU se utiliza con la variable HTMPL. La única diferencia radica en que esta operación definirá también el formulario de menú predeterminado como el formulario de menú especificado con la propiedad HTMPL.
    • Especificadores obligatorios:
      HTMPL=
      archivo_htmpl
    Este especificador anulará la operación MENU definida en el archivo web.cfg hasta que se reinicie el servicio web.
  • SHOW_DETAIL
    Proporciona una interfaz genérica que permite al usuario mostrar un detalle de solo lectura de una fila en una tabla especificada. Es preciso especificar el nombre de ID persistente (desde el que se infiere el nombre de objeto). De forma predeterminada se emplea una plantilla llamada detail_
    xxx
    _ro.htmpl para el objeto
    xxx
    . El archivo .htmpl puede anularse si se especifica la propiedad HTMPL.
    • Especificadores obligatorios:
      PERSID=
      persistent
      -
      id
    • Especificadores opcionales:
      ALG_PRESET
      =preset_expression
      ALG_PRESET_REL
      =preset_expression
      CREATE_ALG=
      activity_log_type
      HTMPL=
      readonly_detail_htmpl_file
  • UPDATE
    Proporciona una interfaz genérica que hace posible editar cualquier tabla. Debe introducirse el ID y el nombre de objeto y se le mostrará al usuario un formulario de detalle que éste puede editar. De forma predeterminada, el usuario cuenta con acceso exclusivo al registro durante dos minutos y se le garantiza que los cambios pasan a la base de datos si se envían en este tiempo.
    • Especificadores obligatorios:
      PERSID=
      persistent-id
      orSET.id=
      id-of-row-to-update
      FACTORY=
      object-name
    • Especificadores opcionales:
      NEXT_PERSID=
      persistent
      -
      id
      (del registro que se mostrará cuando se lleve a cabo la actualización) KEEP
      .attr_name=value
      KEY
      .attr_name=value
      HTMPL=zdetailxxx_
      factory
      .htmpl
    Para usar el especificador HTMPL con UPDATE, el formulario al que se hace referencia debe tener un nombre conforme con la convención de nomenclatura zdetailxxx_
    fábrica
    .htmpl. El nombre debe comenzar por la cadena "zdetail", seguida de cualquier carácter alfanumérico (incluida una cadena nula) y, a continuación, de un guión bajo y del nombre de fábrica.
Para obtener más información sobre web.cfg, consulte Cómo configurar la interfaz web.
Variables de operación
Esta tabla muestra las variables que pueden definirse para cada una de las operaciones de las operaciones compatibles:
Variables
Descripción
Operaciones
ALG_PRESET
ALG_PRESET_REL
Especifica valores para uno o más de los atributos del registro de actividades creado como resultado de la variable CREATE_ALG. Si no se especifica CREATE_ALG, se omiten ALG_PRESET y ALG_PRESET_REL.
CREATE_NEWSEARCHSHOW_DETAIL
CREATE_ALG
Especifica el tipo de registro de actividad que debe crearse como efecto secundario de la operación. Utilice las variables ALG_PRESET o ALG_PRESET a fin de especificar valores para los atributos del nuevo registro de actividades.
El momento de creación del registro de actividades dependerá de la operación, tal y como aparece a continuación:
CREATE_NEW
El registro de actividades se crea cuando se guarda el nuevo registro. Si no se guarda el nuevo registro, el registro de actividades no se crea.
SEARCH
El registro de actividades se crea cuando se selecciona un registro del formulario de lista. Si el registro se visualiza, pero no se selecciona (esto es, si el usuario selecciona de forma explícita el comando Ver del menú que aparece al pasar el ratón por el formulario de lista), no se crea ningún registro de actividades.
SHOW_DETAIL
El registro de actividades se crea antes de que se muestre el registro.
CREATE_NEWSEARCHSHOW_DETAIL
FACTORY
Especifica la clase de objeto que hay que buscar, crear o actualizar. Puede utilizar cualquier nombre especificado como OBJECT en los archivos *.maj de $NX_ROOT/bopcfg tal y como se muestra en Comandos de referencia de CA Service Desk Manager.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
HTMPL
Permite al autor de HTMPL anular la convención de nombres de plantilla predeterminada y especificar explícitamente el archivo HTMPL que debe mostrarse en lugar de la plantilla predeterminada.
Nota:
Cuando se emplea el especificador HTMPL con CREATE_NEW o UPDATE, el nombre del formulario al que se hace referencia debe seguir la convención de nombres zdetailxxx_fábrica.htmpl, donde xxx es cualquier combinación de caracteres y
fábrica
es el nombre de fábrica.
CREATE_NEWDISPLAY_FORMJUST_GRONK_ITMENUSEARCHSET_MENUSHOW_DETAIL
UPDATE
KEEP.
nombre
Especifica el valor que puede guardarse e introducirse entre páginas.
CREATE_NEWGENERIC_LISTSEARCHUPDATE
KEY.
nombre_atributo
Similar a la variable SET.
nombre_atributo
, excepto por el hecho de que especifica una búsqueda de
nombre_atributo
, que debe constituir una referencia a otra tabla u objeto.
UPDATE
NEXT_PERSID
Especifica el ID persistente del registro que debe mostrarse a continuación.
UPDATE
PERSID
Especifica el ID persistente de un registro que debe mostrarse. Puede especificar esta variable de cualquiera de las siguientes formas:
Directamente, mediante un ID persistente que conste de un nombre de fábrica, dos puntos (:) y un ID de base de datos de números enteros exclusivo. Por ejemplo, PERSID=chg:1234, especifica la orden de cambio con el ID de base de datos 1234.
Indirectamente, con un ID persistente que conste de un nombre de fábrica, dos puntos (:), un nombre de atributo, otros dos puntos (:) y un valor. Este formato de PERSID define el registro de la fábrica especificada que cuenta con un atributo del valor especificado. Por ejemplo, PERSID=chg:chg_ref_num:demo:3 especifica la orden de cambio con número de referencia demo:3.
SHOW_DETAILUPDATE
PRESET
PRESET_REL
Especifica valores para uno o más de los atributos del registro creado como resultado de la variable CREATE_NEW. Si no se especifica CREATE_NEW, PRESET se omite.
CREATE_NEW
QBE.
op
.
nombre_atributo
Especifica los valores que utilizar al realizar una búsqueda. Estos valores se identifican mediante una palabra clave QBE, donde
nombre_atributo
identifica cualquier nombre de atributo en un ticket que pueda definirse y
op
indica que se busque donde el atributo:
EQ, es igual que el valor.
NE, no es igual que el valor.
GT, es mayor que el valor.
LT, es inferior al valor.
GE, es igual o mayor que el valor.
LE, es igual que el valor o inferior a este.
NU es nulo.
NN, no es nulo.
IN, coincide con la expresión LIKE de SQL.
KY, contiene el texto introducido.
Si no define ninguna variable QBE, se muestra la ventana de búsqueda estándar.
SEARCH
SET.
nombre_atributo
Especifica el nombre de atributo que se utilizará al crear un ticket, donde
attr_name
identifica cualquier atributo susceptible de definición en un ticket. Los nombres de atributo variarán en función del objeto subyacente. Puede encontrar todos los objetos y sus atributos en los archivos *.maj del directorio majic en bopcfg, tal y como se muestra en Comandos de referencia de CA Service Desk Manager.
CREATE_NEWUPDATE
SET.
ID
Especifica el ID de base de datos correspondiente a la fila que es preciso actualizar.
UPDATE
SKIPLIST
Cuando esta variable se define como 1, las búsquedas que dan como resultado 1 coincidencia no muestran la lista de resultados de la búsqueda. En su lugar, se muestra directamente el formulario de detalles de sólo lectura.
SEARCH
use_template
Cuando esta variable se define como 1, la operación SEARCH devolverá una lista de plantillas. La plantilla devuelta seleccionada se utilizará en la operación CREATE_NEW para rellenar un nuevo registro. Esta variable es válida para órdenes de cambio, incidencias y solicitudes.
CREATE_NEWSEARCH
Sintaxis de PRESET, PRESET_REL, ALG_PRESET y ALG_PRESET_REL
Las palabras clave PRESET, PRESET_REL, ALG_PRESET y ALG_PRESET_REL en la URL especifican valores iniciales para atributos del parte y de su registro de actividades, respectivamente. Los formatos posibles son dos:
  • [ALG_]PRESET=
    atrib
    :
    valor
    Indica que el atributo especificado del parte o del registro de actividades debe definirse como el valor especificado. Por ejemplo, la siguiente especificación define la descripción del nuevo parte como “Hola:”
    PRESET=description:Hello
  • [ALG_]PRESET_REL=atrib:obj.atribrel:atribprueba:valor
    Indica que el atributo especificado del parte o del registro de actividades debe definirse como un valor copiado desde otra tabla de base de datos. El valor se copia del atributo
    relattr
    del
    obj
    cuyo
    testattr
    tiene el
    valor
    especificado. Por ejemplo, la siguiente especificación define el atributo analista perteneciente al nuevo parte como el ID del contacto con ID de usuario xyz123:
    PRESET_REL=analyst:cnt.id:userid:xyz123
    Cuando se utiliza este formato, la consulta implícita debe recuperar un registro exclusivo. Si hay más de un contacto con el ID de usuario xyz123 (o ningún contacto dispone de ese ID), la especificación PRESET del ejemplo no surte ningún efecto.
Las palabras clave PRESET, PRESET_REL, ALG_PRESET y ALG_PRESET_REL pueden aparecer tantas veces como se desee en una URL, para hacer posible la configuración de varios atributos. Del mismo modo, un único operando de palabra clave puede especificar varios valores separados mediante @@. Si se utiliza el separador “@@”, no es posible mezclar formatos de valor pertenecientes a las palabras clave [ALG_]PRESET y [ALG_]PRESET_REL. Por ejemplo, en el siguiente ejemplo se muestran dos formas distintas de especificar valores para la descripción del parte, el resumen y el 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
En el caso de solicitudes, incidencias, incidentes, problemas y órdenes de cambio, tanto PRESET como PRESET_REL admiten un atributo de palabra clave ASSET a fin de vincular un objeto a un activo. El atributo ASSET actualiza el atributo affected_resource de una solicitud, de un incidente o de un problema o, también, el activo LREL correspondiente a una incidencia o a una orden de cambio.
Ejemplos de vínculos
Los siguientes ejemplos de vínculos no incluyen la ruta a CA SDM. Todas las URL de SDM CA empezar por código con el formato siguiente:
http://
nombredehost
[:
puerto
]/CAisd/pdmweb.exe
En este ejemplo,
nombredehost
es el nombre del servidor y
puerto
(opcional) es el número de puerto en caso de que se esté usando Tomcat. Este código se muestra en forma de puntos suspensivos (…) en los siguientes ejemplos de URL:
  • Para crear una solicitud con un usuario final afectado con el ID de usuario tooda01, utilice el siguiente ejemplo de dirección URL:
    ...?OP=CREATE_NEW+FACTORY=cr+PRESET_REL=customer:cnt.id:userid:tooda01
  • Para mostrar una lista de todas las solicitudes asignadas al ID de usuario tooda01, utilice el siguiente ejemplo de dirección URL:
    ...?OP=SEARCH+FACTORY=cr+QBE.EQ.assignee.userid=tooda01
  • Para mostrar el formulario de detalle para la solicitud 1234, utilice los siguientes ejemplos de direcciones URL:
    ...?OP=SHOW_DETAIL+FACTORY=cr+PERSID=cr:ref_num:1234 (read-only view) ...?OP=UPDATE+FACTORY=cr+PERSID=cr:ref_num:1234 (update view)
Es posible omitir el proceso de inicio de sesión si se utilizan Servicios web para la autenticación. Para obtener más información sobre el método getBopsid(), consulte Comandos de referencia de CA Service Desk Manager.