Skip to main content

Plugin parameters

PandoraFMS_SAP_Plugin cuentahas conthe losfollowing siguientesparameters parámetrosfor paraits sumanual ejecución manual:execution:

ParámetroParamter DescripciónDescription
-l "<license>"

IndicaTells althe plugin lathe licencialicense usarait parawill ejecutarlo.use Sito larun licenciait. noIf esthe válida,license elis invalid, the plugin mostraráwill undisplay an error. PorFor ejemplo:example:

 

-l "f51a6712-a3fALLp4x0Af3vAfjr9II2f-bas1g74w"
-h "<sap_host>"

IndicaIt altells the plugin lathe IP o nombreor DNS delname servidorof dethe SAP alserver queto conectarse.connect Porto. ejemplo:For example:

 

-h "10.5.6.30"
-c "<sap_client>"

IndicaIndicates alto the plugin el número de cliente (mandante)the SAP paraclient la(client) conexión.number Porfor ejemplo:the connection. For example:

 

-c "001"
-s "<sap_system>"

IndicaTells althe plugin el número de sistemathe SAP parasystem lanumber conexión.for Estethe parámetroconnection. determinaráThis elparameter puertowill usadodetermine enthe laport comunicaciónused conin communication with SAP. PorFor ejemplo:example:

 

-s "00"
-u "<sap_user>"

IndicaIndicates alto the plugin el usuario dethe SAP parauser lafor conexión.the Porconnection. ejemplo:For example:

 

-u "PANDORA01"
-p "<sap_password>"

IndicaTells althe plugin lathe contraseñapassword delof usuariothe deprevious SAP anterior.user. PorFor ejemplo:example:

 

-p "P45sw0rD."
-m "<plugin_module>"

IndicaIt alindicates to the plugin elthe ID deof módulothe delmodule quefrom sewhich quierenthe obtenerdata losis datosto be obtained (versee tablatable másbelow) adelante)in enan unaexecution ejecuciónas comoa pluginserver deplugin. servidor.For Por ejemplo:example:

 

-m "SYS_INFO"
-M "<plugin_module>"

IndicaIt alindicates to the plugin losthe IDs deof módulosthe demodules losfrom quewhich sethe quierendata obteneris losto datosbe obtained (versee tablatable másbelow) adelante)in enan unaexecution ejecuciónas comoan pluginagent deplugin. agente.Not Noall todos losmodule IDs desupport módulosthis sonmode, compatiblesand condo estenot modo,support ycustom nofilters admitenor filtrosconditions. oThis condicionesparameter personalizadas.can Estebe parámetroused semultiple puedetimes usarin variasa vecessingle enrun unato solaindicate ejecuciónmultiple paramodules. indicarFor varios módulos. Por ejemplo:example:

 

-M "SYS_INFO" -M "IDOC_FAIL_COUNT"
-R "<sap_rfc_function>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicathe la funciónSAP RFC defunction SAPto aexecute ejecutarto paraobtain obtenerthe losdata. datos.For Por ejemplo:example:

 

-R "TH_WPINFO"
-T "<sap_rfc_table>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicathe elname nombreof de la tabla dethe SAP detable lafrom quewhich obtenerto losobtain datos.the Pordata. ejemplo:For example:

 

-T "WPLIST"
-S "<sap_rfc_structure>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicathe elname nombreof de la estructura dethe SAP destructure lafrom quewhich obtenerto losobtain datos.the Pordata. ejemplo:For example:

 

-S "MSSDBLOGSIZE"
-F "<sap_field_1>,...,<sap_field_N>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loindicate admitan,the indicafields losof camposthe deprevious latable tablaor ostructure estructuraseparated anteriorby separados por comascommas "," defrom loswhich queyou sewant quierento obtenerobtain losthe datos.data. PorFor ejemplo:example:

 

-F "WP_TYP,WP_ISTATUS"

-W "<sap_filter_condition>"

oor

-W "<plugin_filter_condition>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicafilters filtrosfor paraquery condicionesconditions de consultas a tablas deto SAP otables filtrosor parafilters condicionesfor enconditions otroin tipoother detypes consultas delof plugin queries (dependiendodepending delon IDthe delmodule módulo)ID). EsteThis parámetroparameter secan puedebe indicarspecified variasmultiple vecestimes parafor múltiplesmultiple condiciones.conditions. MásThe adelanteformat sefor describeeach elof formatothese paraconditions cadais unadescribed debelow. estasFor condiciones. Por ejemplo:example:

 

-W "STATUS EQ 'F'" -W "AND JOBNAME LIKE 'Z%'"

oor

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

-I "<plugin_rfc_input>"

oor

-I "<sap_z_transaction_input>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, lothey admitan, indican entradasindicate "input" parainputs lafor ejecuciónthe deexecution lasof funcionesthe RFC.RFC Salvofunctions. paraExcept lafor ejecuciónthe deexecution transaccionesof SAP "Z" detransactions, SAP,this esteparameter parámetrocan sebe puedespecified indicarmultiple variastimes vecerfor para múltiples entradasmultiple "input". Másinputs. adelanteThe seformat describefor el formato para estas entradasthese "input". Porentries ejemplo:is described later. For example:

 

-I "TABLE_NAME,USR04" -I "DBNAME,XYZ"

oor

-I "Z_INPUT_TEST"
-L "<seconds>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicathe lanumber cantidadof deseconds segundosfrom desdethe elcurrent momentomoment actualbackwards haciain atráswhich endata loswill cualesbe sesearched. vanIts adefault buscarvalue datos. Su valor por defecto esis "86400". PorFor ejemplo:example:

 

-L "21600"
-C "<string>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicaa un textotext (as a modofilter) dethat filtro)the queresults debenof contener los resultados de la consultathe RFC paraquery sermust devueltoscontain porto elbe returned by the plugin. PorFor ejemplo:example:

 

-C "USER01"
-Z "<sap_z_transaction>"

EnIn modoserver plugin demode, servidor,for parathe losmodule IDs dethat módulossupport queit, loit admitan,indicates indicathe elname nombreof dethe la transacciónSAP Z detransaction SAPto aexecute ejecutarto paraobtain obtenerthe losdata. datos.For Por ejemplo:example:

 

-Z "Z_CHECK_STATUS"
-D "<delimiter>"

ParaFor losthe module IDs dethat módulossupport queit, loit admitan,indicates indicathe elfield carácterdelimiter delimitadorcharacter defor camposthe paraoutputs lasproduced salidasby que produzca elthe plugin quethat tenganhave una formatotable deformat. tabla.Its Sudefault valorvalue por defecto esis "|". PorFor ejemplo:example:

 

-D ";"
-H "<1 | 0>"

ParaFor losthe module IDs dethat módulossupport queit, loit admitan,indicates indicawhether siyou sewant quiereto obtenerobtain enthe latable salidaheader delin the plugin laoutput cabeceraor denot lafor tablaall othose nooutputs paraproduced todasby aquellas salidas que produzca elthe plugin quethat tenganhave una formatotable deformat. tabla.It Admiteadmits losthe valoresvalues "0" (nodo mostrarnot lashow cabecera)the oheader) or "1" (mostrarshow lathe cabecera)header). SuIts valordefault porvalue defecto esis "1". PorFor ejemplo:example:

 

-H "0"

 

  • Formato del parámetro -W parameter format

El parámetroThe "-W" puedeparameter sercan utilizadobe paraused distintosfor módulosdifferent delplugin plugin,modules, admitiendoadmitting 2 formatosdifferent distintosformats enin cadaeach caso:case:

    • FormatoFormat parafor los módulosmodules "RFC_READTABLE_COUNT", "RFC_READTABLE_TABLE" yand "RFC_READTABLE_GROUPTABLE" (consultastable a tablas)queries):

EnIn lasthe consultasqueries realizadasmade a tablas deto SAP lastables, condicionesthe queconditions sethat debenmust indicarbe cumplenindicated elcomply formatowith esperadothe porformat laexpected funciónby the "RFC_READ_TABLE", quefunction, sewhich corresponderíawould con:correspond to:

CAMPOFIELD OPERADOROPERATOR 'VALOR'VALUE'

SiIf se indican múltiples parámetrosmultiple "-W" puedeparameters queare seaindicated, necesarioit indicarmay enbe lasnecessary condicionesto consecutivasindicate siin sethe unenconsecutive medianteconditions losif comparadoresthey lógicosare joined by means of the "AND" uor "OR". Selogical debecomparators. tenerNote en cuenta quethat SAP evaluaráwill lasevaluate condicionesthe enconditions elin ordenthe indicado.order Porlisted. ejemplo:For example:

-W "CAMPOFIELD OPERADOROPERATOR 'VALOR'VALUE'" -W "AND CAMPOFIELD OERADOROPERATOR 'VALOR'VALUE'" -W "OR CAMPOFIELD OPERADOROPERATOR 'VALOR'VALUE'"

SeríaIt equivalentewould be equivalent to a unasingle condición única:condition:

-W "CAMPOFIELD OPERADOROPERATOR 'VALOR'VALUE' AND CAMPOFIELD OPERADOROPERATOR 'VALOR'VALUE' OR CAMPOFIELD OPERADOROPERATOR 'VALOR'VALUE'"

PorDue limitacionesto delsocket conector,limitations, unaa solasingle condicióncondition indicadaindicated enin un parámetroa "-W" noparameter puedecannot exceder deexceed 70 caracterescharacters. SiIf necesitayou indicarneed condicionesto másindicate largaslonger trateconditions detry concatenarlasconcatenating mediantethem elby usousing de múltiples parámetrosmultiple "-W" yparameters eland uso de comparadores lógicosusing "AND" yand "OR". logical comparators.

  •  

EjemploExample deof condiciónactual real:condition:

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

 

    • FormatoFormat parafor elthe restorest deof módulos:the modules:

ParaFor módulosmodules quethat noare seannot consultasqueries a tablas deto SAP mediantetables lathrough funciónthe "RFC_READ_TABLE" elfunction, formatothe deformat losof filtrosthe debefilters ser:must be:

CAMPO,OPERADOR,VALORFIELD,OPERATOR,VALUE

ParaFor estosthese casos,cases, siif se indican múltiples parámetrosmultiple "-W" separameters consideraráare queindicated, todasit laswill condicionesbe debenconsidered cumplirsethat aall lathe vezconditions must be met at the same time (comoas siif sethey concatenasenwere conconcatenated operadoreswith lógicoslogical "AND") operators).

EjemploExample deof condiciónactual real:condition:

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

 

ElThe "CAMPOFIELD" dependeráwill dedepend laon tabla o estructura dethe SAP consultada,table poror ejemplostructure podríaconsulted, serfor elexample campoit could be the "STATUS" defield laof tablathe "TBTCO". Existentable. variasThere páginasare dondeseveral sepages puedenwhere consultaryou loscan camposconsult disponiblesthe deavailable tablasfields deof SAP comotables, porsuch ejemplo:as:

https://www.sapdatasheet.org/

ElThe "OPERADOROPERATOR" determinadetermines elthe tipotype deof comparacióncomparison queto sebe harámade entrebetween elthe indicated "CAMPO"FIELD" y eland "VALOR"VALUE". indicados.The Lospossible posiblesoperators operadores son:are:

    1. EQ: ElThe valorvalue delof campothe debefield sermust igualbe alequal valorto indicado.the indicated value.
    2. NE: ElThe valorvalue delof campothe debefield sermust distintobe aldifferent valorfrom indicado.the indicated value.
    3. LT: ElThe valorvalue delof campothe debefield sermust menorbe queless elthan valorthe indicado.indicated Envalue. consultasIn atable tablasqueries medianteusing "RFC_READ_TABLE", siif elthe campofield to compare is a comparardate esor unatime, fechathe uoldest hora,dates lasor fechastimes uare horaslower másthan antiguasthe sonmost menoresrecent quedates lasor fechas u horas mas recientes.times.
    4. LE: ElThe valorvalue delof campothe debefield sermust menorbe oless igualthan queor elequal valorto indicado.the Enindicated consultasvalue. aIn tablastable mediantequeries using "RFC_READ_TABLE", siif elthe campofield to compare is a comparardate esor unatime, fechathe uoldest hora,dates lasor fechastimes uare horaslower másthan antiguasthe sonmost menoresrecent quedates lasor fechas u horas mas recientes.times.
    5. GT: ElThe valorvalue delof campothe debefield sermust mayorbe quegreater elthan valorthe indicado.indicated Envalue. consultasIn atable tablasqueries medianteusing "RFC_READ_TABLE", siif elthe campofield to compare is a comparardate esor unatime, fechathe umost hora,recent lasdates fechasor utimes horasare másgreater recientesthan sonthe mayoresoldest quedates lasor fechas u horas mas antiguas.times.
    6. GE: ElThe valorvalue delof campothe debefield sermust mayorbe ogreater igualthan queor elequal valorto indicado.the Enindicated consultasvalue. aIn tablastable mediantequeries using "RFC_READ_TABLE", siif elthe campofield to compare is a comparardate esor unatime, fechathe umost hora,recent lasdates fechasor utimes horasare másgreater recientesthan sonthe mayoresoldest quedates lasor fechas u horas mas antiguas.times.
    7. LIKE: ElThe valorvalue delof campothe sefield debemust ajustarbe aadjusted lato expresión the delexpression valorof indicado.the Soloindicated disponiblevalue. paraOnly consultasavailable afor tablastable queries (RFC_READ_TABLE).

ElThe indicated "VALORVALUE" indicadoallows permiteapplying aplicarthe el filtrofilter (condición)condition) deof losthe resultadosquery deresults laaccording consultato de acuerdo a suits "OPERADOR"OPERATOR". SeIt recomiendais encapsularrecommended siempreto losalways valoresencapsulate entrevalues comillasin simplessingle enquotes las consultas a tablas dein SAP contable queries with "RFC_READ_TABLE".

ConWith elthe "OPERADOR"OPERATOR" deof tipotype "LIKE" lasthe expresionesindicated indicadasexpressions permitenallow elthe usouse delof carácterthe character "%" parato determinardetermine quethat puedeit sercan cualquierbe caracterany decharacter from 0 ato N veces.times. PorFor ejemplo:example:

Z% : PermiteIt indicarallows queindicating elthat campothe confield elwith quewhich seit comparais debecompared tenermust unhave valora quevalue althat menosat comienceleast porbegins lawith letrathe letter Z, pudiendoand tenermay oor nomay másnot caractereshave amore continuación.characters after it.

ParaFor losthe "CAMPO"FIELD" deof tipotype "DATS" oor "TIMS" (tiposfield detypes camposof deSAP tablas de SAP) se puede hacer uso detables) macros paracan serbe sustituidasused porto labe fechareplaced yby horathe correspondientecorresponding date and time (segúnaccording lato the macro) respectowith arespect lato fechathe ydate horaand deltime momentoof dethe ejecuciónplugin delexecution plugin,time, laswhich cualesallow permitenyou aplicarto filtrosapply dinámicosdynamic confilters elwith formatothe correctocorrect paraformat estosfor tiposthese detypes camposof deSAP SAP.fields.

    1. Macros parafor camposfields deof tipotype "DATS":
      1. _N_DAYSAGO_: Fecha de hace N días.days ago date.
      2. _N_WEEKSAGO_: Fecha de hace N semanas.weeks ago date.
    2. Macros parafor camposfields deof tipotype "TIMS":
      1. _N_SECSAGO_: Hora de hace N segundos.seconds ago time.
      2. _N_MINSAGO_: Hora de hace N minutos.minutes ago time.
      3. _N_HOURSAGO_: Hora de hace N horas.hours ago time.

ParaFor todasall las macros se puede sustituirmacros, "N" porcan unbe replaced by a númeropositive entero positivointeger óor 0.

LosFields camposof de tipotype "DATS" tienenhave elthe formatoformat "YYYYMMDD", yand portherefore lo tanto lasthe macros para camposfor "DATS" sefields sustituiranwill conbe valoresreplaced enwith esevalues formato,in siendo:that format, being:

      • YYYY: ElThe añoyear conwith 4 dígitos,digits, porfor ejemploexample "2022".
      • MM: ElThe mesmonth conwith 2 dígitos,digits, porfor ejemploexample "05".
      • DD: ElThe diaday delof mesthe conmonth with 2 dígitos,digits, porfor ejemploexample "13".

LosThe camposfields deof tipotype "TIMS" tienenhave elthe formatoformat "hhmmss", yand portherefore lo tanto lasthe macros para camposfor "TIMS" sefields sustituiranwill conbe valoresreplaced enwith esevalues formato,in siendo:that format, being:

      • hh: LaThe horahour conwith 2 dígitosdigits enin formato24-hour deformat, 24for horas, por ejemploexample "13".
      • mm: LosThe minutosminutes conwith 2 dígitos,digits, porfor ejemploexample "08".
      • ss: LosThe segundosseconds conwith 2 dígitos,digits, porfor ejemploexample "51".

 

  • Formato del parámetro -I parameter format

El parámetroThe "-I" puedeparameter sercan utilizadobe paraused distintosfor módulosdifferent delplugin plugin,modules, admitiendoadmitting 2 formatosdifferent distintosformats enin cadaeach caso:case:

    • FormatoFormat parafor el módulothe "RFC_Z_TRANS" module (transaccionesSAP "Z" de SAP)transactions):

ParaFor estethis módulomodule, elthe formatonecessary necesarioformat delof parámetrothe seráparameter elwill valorbe quethe debavalue tenerthat lathe transacciónSAP transaction "Z" demust SAPhave parafor el campothe "INPUT" defield laof petición.the Porrequest. ejemplo:For example:

-I "Z_INPUT_TEST"

 

    • FormatoFormat parafor elthe restorest deof módulos:the modules:

ParaFor elthe restorest deof módulos,the elmodules, formatothe queformat debenthat tener los parámetrosthe "-I" esparameters elmust siguiente:have is as follows:

INPUT,VALORVALUE

ElThe "INPUT" dependeráwill dedepend laon función dethe SAP consultada,function porqueried, ejemplofor podríaexample serit lacould entradabe the "TABLE_NAME" deinput laof funciónthe "RFC_GET_TABLE_ENTRIES". Existenfunction. variasThere páginasare dondeseveral sepages puedenwhere consultaryou lascan entradasconsult the available "input" disponiblesentries de funciones deof SAP comofunctions, porsuch ejemplo:as:

https://www.sapdatasheet.org/

ElThe "VALORVALUE" indicadoindicated esis elthe queone sethat asignaráwill albe assigned to the "INPUT" alwhen ejecutarexecuting lathe funcióncorresponding RFC correspondiente.function.

Ejemplo de entradaActual "input" real:example:

-I "TABLE_NAME,USR04"

Los parámetrosThe "-I" tambiénparameters admitenalso elsupport usothe deuse of macros conwith elthe mismosame formatoformat queas lasthose usadasused parafor los parámetrosthe "-W": parameters: "_N_SECSAGO_", "_N_MINSAGO_", "_N_HOURSAGO_", "_N_DAYSAGO_" yand "_N_WEEKSAGO_" (versee elpoint puntoabove anteriorfor para más detalles)details).

 

Back to top