pdm_text_cmd: interfaz de la línea de comandos de Text API

Comandos de referencia › pdm_text_cmd: interfaz de la línea de comandos de Text API

pdm_text_cmd: interfaz de la línea de comandos de Text API

Utilice el comando pdm_text_cmd para Text API, que sirve para crear y actualizar diversos objetos como, por ejemplo, solicitudes, órdenes de cambio, incidencias, activos o contactos.

Importante: No se pueden utilizar las comillas simples o dobles como el parámetro de los comandos pdm_text_nxd o bop_cmd.

Sintaxis

Este comando tiene el formato siguiente:

pdm_text_cmd -t tabla {-u del_ID_de_usuario -p del_ID_persistente} [-o operación] [-f archivo de entrada] [-T tiempo de espera] [-h]

-t tabla

(Obligatorio) Especifica la tabla que se debe procesar. El nombre de tabla puede ser uno de los siguientes valores (no se distingue entre mayúsculas y minúsculas):

Activo
Contacto
Cambio
Incidencia
Solicitud

Nota: Consulte la sección [OPTIONS] del archivo text_api.cfg la lista completa de nombres de tabla válidos.

-u del_ID_de_usuario | -p del_ID_persistente

(Se necesita una opción) Identifica el contacto para esta operación:

-u del_ID_de_usuario: Identifica el contacto utilizando el valor del ID de usuario.
-p del_ID_persistente: Identifica el contacto utilizando el ID de objeto exclusivo para el registro del contacto. del_ID_persistente debe tener la forma cnt:xxxx. xxxx es el ID persistente del objeto.

Nota: El valor especificado con esta opción se agrega al final de la entrada para el comando pdm_text_cmd mediante la palabra clave apropiada, %FROM_USERID o %FROM_PERSID.

-o operación

Especifica la operación que se debe realizar. El valor de operación debe ser uno de los siguientes valores (no se distingue entre mayúsculas y minúsculas):

NEW: crea un objeto. Se trata del valor predeterminado en caso de que no se especifique ninguna operación.
UPDATE | UPD: si no se encuentra el objeto, se crea y, si se encuentra, se actualiza.
UPDATE_ONLY | UPDO: si se encuentra el objeto, se actualiza; de lo contrario, no se realiza ninguna acción.

Tanto UPDATE como UPDATE_ONLY requieren que se use la palabra clave %SEARCH en la entrada del comando. Sólo se puede realizar una operación cada vez que se invoque pdm_text_cmd.

-f archivo_entrada

Especifica la ruta completa al archivo que se debe procesar, que es un archivo de texto que contiene comandos de Text API válidos. Si se omite este parámetro, se utilizan los comandos de STDIN. Text API utiliza el siguiente formato básico para la entrada:

%palabra_clave=valor

Puede emitir varios comandos dentro de la entrada si separa la solicitud de comandos con al menos cinco símbolos de porcentaje (%%%%%).

Nota: Para obtener más información sobre palabras clave válidas y sobre el formato de la entrada en Text API, consulte el archivo text_api.cfg.

-T tiempo de espera

Especifica el número de segundos que se espera a que se produzca la respuesta del servidor antes de que se dé por agotado el tiempo de espera. El valor predeterminado es 30 segundos.

Nota: pdm_text_cmd muestra las respuestas basadas en texto y recibidas de Text API, que incluyen mensajes de error o de confirmación, así como el texto original enviado mediante la API para su procesamiento. pdm_text_cmd devuelve cero si el comando se ejecuta correctamente sin advertencias ni errores, o bien devuelve uno si se ejecuta correctamente pero con advertencias. Si se devuelve cualquier otro valor, significa que se ha producido algún error.

Importante: En UNIX, LIBPATH debe estar definido antes de ejecutar varias utilidades CA SDM. Utilice pdm_task para definir LIBPATH antes de ejecutar una utilidad. Por ejemplo, indique "pdm_task pdm_clean_attachments ...".

Nota: Al transferir los parámetros desde el símbolo del sistema, utilice Ctrl+Z en Windows y Ctrl+D en POSIX.

Más información:

Uso del API de texto