Parámetros del plugin

PandoraFMS_SAP_Plugin cuenta con los siguientes parámetros para su ejecución manual:

Parámetro	Descripción
-l "<license>"	Indica al plugin la licencia usara para ejecutarlo. Si la licencia no es válida, el plugin mostrará un error. Por ejemplo:   -l "f51a6712-a3fALLp4x0Af3vAfjr9II2f-bas1g74w"
-h "<sap_host>"	Indica al plugin la IP o nombre DNS del servidor de SAP al que conectarse. Por ejemplo:   -h "10.5.6.30"
-c "<sap_client>"	Indica al plugin el número de cliente (mandante) SAP para la conexión. Por ejemplo:   -c "001"
-s "<sap_system>"	Indica al plugin el número de sistema SAP para la conexión. Este parámetro determinará el puerto usado en la comunicación con SAP. Por ejemplo:   -s "00"
-u "<sap_user>"	Indica al plugin el usuario de SAP para la conexión. Por ejemplo:   -u "PANDORA01"
-p "<sap_password>" o -x "<sap_password_encrypted>"	Indica al plugin la contraseña del usuario de SAP anterior. Por ejemplo:   -p "P45sw0rD." o -x "bSg8XKC63rhGfXHgjzSCMQ"
-X "<sap_password>"	En lugar de lanzar el plugin para monitorizar un servidor de SAP, produce como salida la contraseña encriptada, para lanzar el plugin con el parámetro "-x" en lugar de "-p". Por ejemplo:   -X "P45sw0rD."
-m "<plugin_module>"	Indica al plugin el ID de módulo del que se quieren obtener los datos (ver tabla más adelante) en una ejecución como plugin de servidor. Por ejemplo:   -m "SYS_INFO"
-M "<plugin_module>"	Indica al plugin los IDs de módulos de los que se quieren obtener los datos (ver tabla más adelante) en una ejecución como plugin de agente. No todos los IDs de módulos son compatibles con este modo, y no admiten filtros o condiciones personalizadas. Este parámetro se puede usar varias veces en una sola ejecución para indicar varios módulos. Por ejemplo:   -M "SYS_INFO" -M "IDOC_FAIL_COUNT"
-R "<sap_rfc_function>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica la función RFC de SAP a ejecutar para obtener los datos. Por ejemplo:   -R "TH_WPINFO"
-T "<sap_rfc_table>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica el nombre de la tabla de SAP de la que obtener los datos. Por ejemplo:   -T "WPLIST"
-S "<sap_rfc_structure>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica el nombre de la estructura de SAP de la que obtener los datos. Por ejemplo:   -S "MSSDBLOGSIZE"
-F "<sap_field_1>,...,<sap_field_N>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica los campos de la tabla o estructura anterior separados por comas "," de los que se quieren obtener los datos. Por ejemplo:   -F "WP_TYP,WP_ISTATUS"
-W "<sap_filter_condition>" o -W "<plugin_filter_condition>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica filtros para condiciones de consultas a tablas de SAP o filtros para condiciones en otro tipo de consultas del plugin (dependiendo del ID del módulo). Este parámetro se puede indicar varias veces para múltiples condiciones. Más adelante se describe el formato para cada una de estas condiciones. Por ejemplo:   -W "STATUS EQ 'F'" -W "AND JOBNAME LIKE 'Z%'" o -W "WP_ISTATUS,EQ,2" -W "WP_ITYPE,EQ,1"
-I "<plugin_rfc_input>" o -I "<sap_z_transaction_input>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indican entradas "input" para la ejecución de las funciones RFC. Salvo para la ejecución de transacciones "Z" de SAP, esteEste parámetro se puede indicar varias vecerveces para múltiples entradas "input". Más adelante se describe el formato para estas entradas "input". Por ejemplo:   -I "TABLE_NAME,USR04" -I "DBNAME,XYZ" o -I "Z_INPUT_TEST"
-L "<seconds>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica la cantidad de segundos desde el momento actual hacia atrás en los cuales se van a buscar datos. Su valor por defecto es "86400". Por ejemplo:   -L "21600"
-C "<string>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica un texto (a modo de filtro) que deben contener los resultados de la consulta RFC para ser devueltos por el plugin. Por ejemplo:   -C "USER01"
-Z "<sap_z_transaction>"	En modo plugin de servidor, para los IDs de módulos que lo admitan, indica el nombre de la transacción Z de SAP a ejecutar para obtener los datos. Por ejemplo:   -Z "Z_CHECK_STATUS"
-D "<delimiter>"	Para los IDs de módulos que lo admitan, indica el carácter delimitador de campos para las salidas que produzca el plugin que tengan un formato de tabla. Su valor por defecto es "|". Por ejemplo:   -D ";"
-H "<1 | 0>"	Para los IDs de módulos que lo admitan, indica si se quiere obtener en la salida del plugin la cabecera de la tabla o no para todas aquellas salidas que produzca el plugin que tengan un formato de tabla. Admite los valores "0" (no mostrar la cabecera) o "1" (mostrar la cabecera). Su valor por defecto es "1". Por ejemplo:   -H "0"

 

• Formato del parámetro -W

El parámetro "-W" puede ser utilizado para distintos módulos del plugin, admitiendo 2 formatos distintos en cada caso:

• • Formato para los módulos "RFC_READTABLE_COUNT", "RFC_READTABLE_TABLE" y "RFC_READTABLE_GROUPTABLE" (consultas a tablas):

En las consultas realizadas a tablas de SAP las condiciones que se deben indicar cumplen el formato esperado por la función "RFC_READ_TABLE", que se correspondería con:

CAMPO OPERADOR 'VALOR'

Si se indican múltiples parámetros "-W" puede que sea necesario indicar en las condiciones consecutivas si se unen mediante los comparadores lógicos "AND" u "OR". Se debe tener en cuenta que SAP evaluará las condiciones en el orden indicado. Por ejemplo:

-W "CAMPO OPERADOR 'VALOR'" -W "AND CAMPO OERADOR 'VALOR'" -W "OR CAMPO OPERADOR 'VALOR'"

Sería equivalente a una condición única:

-W "CAMPO OPERADOR 'VALOR' AND CAMPO OPERADOR 'VALOR' OR CAMPO OPERADOR 'VALOR'"

Por limitaciones del conector, una sola condición indicada en un parámetro "-W" no puede exceder de 70 caracteres. Si necesita indicar condiciones más largas trate de concatenarlas mediante el uso de múltiples parámetros "-W" y el uso de comparadores lógicos "AND" y "OR".

•  

Ejemplo de condición real:

-W "SEQNO EQ '000'" -W "AND DATUM GE '_1_DAYSAGO_'"

 

• • Formato para el resto de módulos:

Para módulos que no sean consultas a tablas de SAP mediante la función "RFC_READ_TABLE" el formato de los filtros debe ser:

CAMPO,OPERADOR,VALOR

Para estos casos, si se indican múltiples parámetros "-W" se considerará que todas las condiciones deben cumplirse a la vez (como si se concatenasen con operadores lógicos "AND").

Ejemplo de condición real:

-W "WP_ISTATUS,EQ,16" -W "WP_ITYPE,EQ,1"

 

El "CAMPO" dependerá de la tabla o estructura de SAP consultada, por ejemplo podría ser el campo "STATUS" de la tabla "TBTCO". Existen varias páginas donde se pueden consultar los campos disponibles de tablas de SAP como por ejemplo:

https://www.sapdatasheet.org/

El "OPERADOR" determina el tipo de comparación que se hará entre el "CAMPO" y el "VALOR" indicados. Los posibles operadores son:

1. 1. EQ: El valor del campo debe ser igual al valor indicado.
   2. NE: El valor del campo debe ser distinto al valor indicado.
   3. LT: El valor del campo debe ser menor que el valor indicado. En consultas a tablas mediante "RFC_READ_TABLE", si el campo a comparar es una fecha u hora, las fechas u horas más antiguas son menores que las fechas u horas mas recientes.
   4. LE: El valor del campo debe ser menor o igual que el valor indicado. En consultas a tablas mediante "RFC_READ_TABLE", si el campo a comparar es una fecha u hora, las fechas u horas más antiguas son menores que las fechas u horas mas recientes.
   5. GT: El valor del campo debe ser mayor que el valor indicado. En consultas a tablas mediante "RFC_READ_TABLE", si el campo a comparar es una fecha u hora, las fechas u horas más recientes son mayores que las fechas u horas mas antiguas.
   6. GE: El valor del campo debe ser mayor o igual que el valor indicado. En consultas a tablas mediante "RFC_READ_TABLE", si el campo a comparar es una fecha u hora, las fechas u horas más recientes son mayores que las fechas u horas mas antiguas.
   7. LIKE: El valor del campo se debe ajustar a la expresión  del valor indicado. Solo disponible para consultas a tablas (RFC_READ_TABLE).

El "VALOR" indicado permite aplicar el filtro (condición) de los resultados de la consulta de acuerdo a su "OPERADOR". Se recomienda encapsular siempre los valores entre comillas simples en las consultas a tablas de SAP con "RFC_READ_TABLE".

Con el "OPERADOR" de tipo "LIKE" las expresiones indicadas permiten el uso del carácter "%" para determinar que puede ser cualquier caracter de 0 a N veces. Por ejemplo:

Z% : Permite indicar que el campo con el que se compara debe tener un valor que al menos comience por la letra Z, pudiendo tener o no más caracteres a continuación.

Para los "CAMPO" de tipo "DATS" o "TIMS" (tipos de campos de tablas de SAP) se puede hacer uso de macros para ser sustituidas por la fecha y hora correspondiente (según la macro) respecto a la fecha y hora del momento de ejecución del plugin, las cuales permiten aplicar filtros dinámicos con el formato correcto para estos tipos de campos de SAP.

1. 1. Macros para campos de tipo "DATS":
      1. _N_DAYSAGO_: Fecha de hace N días.
      2. _N_WEEKSAGO_: Fecha de hace N semanas.
   2. Macros para campos de tipo "TIMS":
      1. _N_SECSAGO_: Hora de hace N segundos.
      2. _N_MINSAGO_: Hora de hace N minutos.
      3. _N_HOURSAGO_: Hora de hace N horas.

Para todas las macros se puede sustituir "N" por un número entero positivo ó 0.

Los campos de tipo "DATS" tienen el formato "YYYYMMDD", y por lo tanto las macros para campos "DATS" se sustituiran con valores en ese formato, siendo:

• • • YYYY: El año con 4 dígitos, por ejemplo "2022".
    • MM: El mes con 2 dígitos, por ejemplo "05".
    • DD: El dia del mes con 2 dígitos, por ejemplo "13".

Los campos de tipo "TIMS" tienen el formato "hhmmss", y por lo tanto las macros para campos "TIMS" se sustituiran con valores en ese formato, siendo:

• • • hh: La hora con 2 dígitos en formato de 24 horas, por ejemplo "13".
    • mm: Los minutos con 2 dígitos, por ejemplo "08".
    • ss: Los segundos con 2 dígitos, por ejemplo "51".

 

• Formato del parámetro -I

El parámetro "-I" puede ser utilizado para distintos módulos del plugin, admitiendo 2 formatos distintos en cada caso:

• • Formato para el módulo "RFC_Z_TRANS" (transacciones "Z" de SAP):

Para este módulo el formato necesario del parámetro será el valor que deba tener la transacción "Z" de SAP para el campo "INPUT" de la petición. Por ejemplo:

-I "Z_INPUT_TEST"

 

• • Formato para el resto de módulos:

Para el resto de módulos, el formato que deben tener los parámetros "-I" es el siguiente:

INPUT,VALOR

El "INPUT" dependerá de la función de SAP consultada, por ejemplo podría ser la entrada "TABLE_NAME" de la función "RFC_GET_TABLE_ENTRIES". Existen varias páginas donde se pueden consultar las entradas "input" disponibles de funciones de SAP como por ejemplo:

https://www.sapdatasheet.org/

El "VALOR" indicado es el que se asignará al "INPUT" al ejecutar la función RFC correspondiente.

Ejemplo de entrada "input" real:

-I "TABLE_NAME,USR04"

Los parámetros "-I" también admiten el uso de macros con el mismo formato que las usadas para los parámetros "-W": "_N_SECSAGO_", "_N_MINSAGO_", "_N_HOURSAGO_", "_N_DAYSAGO_" y "_N_WEEKSAGO_" (ver el punto anterior para más detalles).