eop_run Configuration File

mPower End of Period Suite

eop_run Configuration File

This file is used to pass a number of important parameters to eop_run and to portfolio_mon. The defaults listed in the description of the parameters are really for testing. The values actually given in the sample config file are probably more appropriate to production, and even then perhaps could go higher.

PROGRAM_LOC: Where eop_run knows to find portfolio_mon, eop_launch, and eop_restart and how portfolio_mon finds portfolio_stat.

PORTFOLIOS: Quoted, space-separated list of portfolios that eop_run -s will start. eop_run -r and eop_run -m do not care if their portfolio is or is not in this list.

ACCRUALS, INVOICES: These apply across the board to all portfolios in PORTFOLIOS when it comes to starting EOP. If there are reasons to have these switches vary by portfolio, then portfolios will have to be grouped together in different config files, each with its own combination of these switches.

CHECK_NUMBER: Will be applied across the board to all portfolios in PORTFOLIOS, making it less useful than it might appear. If LeasePak is configured for manual check numbers and many portfolios, then this could present some issues.

SUBMIT_INTERVAL: When multiple portfolios are listed in PORTFOLIOS, it is general practice to stagger their start times. There is a lot of very intense upfront activity involving the batch queues for each portfolio, and staggered start times reduce resource contention. The right length of time to wait between each submit is likely to be very site-specific. The site administrator will have to experiment with this and other parameters, both in mPower EOP Suite and in other LeasePak and queue management areas. SUBMIT_INTERVAL, measured in seconds, puts eop_run to sleep between each portfolio start.

MONITOR_INTERVAL: portfolio_mon calls portfolio_stat periodically to determine the status of the EOP they are monitoring. This parameter determines how often portfolio_stat is asked to run. While EOP is running, each invocation of portfolio_stat results in a line being added to the portfolio log file, in sort of a heart beat fashion. The default of 10 seconds is okay for testing but in the real world, 60 seconds or more is more likely sufficient. Even 5, 10, 15 or even 30 minutes (300, 600, 900 or 1800 seconds) may be sufficiently often.

STALL_TOLERANCE: Gives the number of MONITOR_INTERVALs to wait for a stalled EOP to start running before sending email. STALL_TOLERANCE is just the starting point in stall handling. The default, 120, times the default MONITOR_INTERVAL of 10 seconds gives 1200 seconds or 20 minutes. If the MONITOR_INTERVAL is 1800 seconds then STALL_TOLERANCE might be 1 or 2, giving 30 or 60 minutes. It depends on how closely daily processing is scheduled.

MAIL_TO, MAIL_FROM

In order to have mPower EOP Suite send email, these two parameters must be set to appropriate values, and sendmail must be properly configured on the server. Multiple addresses may be used if separated by semicolons (;) and the list is enclosed in double quotation marks ("). Mail is sent:

On each failure to submit or resubmit a portfolio
On each portfolio termination, whether failure or successful completion
When a stalled portfolio exceeds STALL_TOLERANCE
When a stalled portfolio starts to run (but only if mail was sent out previously about the stall)

PRE_EOP_PROC, START_PORT_PROC, END_PORT_PROC: These three parameters specify command lines to be executed by eop_run or portfolio_mon at appointed times. They are to be complete command lines, as mPower EOP Suite will not add to them in any way except by the action of the shell itself. They may contain parameter references ($-values) to any parameter defined at the times they are processed. They are processed twice, once when the config file is read and the assignments are evaluated and performed, and once upon invocation, which is done in the form of an eval: eval `echo $PRE_EOP_PROC` for instance. The variable value of PRE_EOP_PROC is made available as the statement eval is to evaluate by `echo ...`, and then any further shell substitutions or metacharacter processing, etc., are performed at that time. Then the resulting command line is executed.

PRE_EOP_PROC: This is performed by eop_run -s before any portfolios are processed. The example in the config file simply clears the screen log generated by eop_run's main loop, but can be used for anything. Backing up the database and the data directory before starting EOP is extremely advisable; this is a perfect place to do it. PRE_EOP_PROC is called only on eop_run -s, never on eop_run -r or eop_run -m.

START_PORT_PROC: This is performed by eop_run immediately before submitting each portfolio. In this config file, it is used to call a small script that clears out a destination directory that is to receive files at the end of the portfolio's processing. START_PORT_PROC is called only on eop_run -s, never on eop_run -r or eop_run -m.

END_PORT_PROC: This is performed by portfolio_mon on successful completion of EOP in the portfolio being monitored. This config file uses this parameter to call a small script that copies that portfolio's udata files into the directory cleared out by START_PORT_PROC. END_PORT_PROC is called only on successful completion of the portfolio, never on failure.

MPC_URL: This parameter allows the inclusion of mPower URL where is it deployed with '/' at the end.

MPC_LP_AUTH: This parameter allows the inclusion of mPower authentication mode.

MPC_LP_USER, MPC_LP_PASS: LeasePak client username and password that has access to mPower. These two parameters are required when mPower authentication modes HEADER or ENVIRONMENT are used.

MPC_LP_HOST, MPC_LP_PORT, MPC_LP_ENVR, MPC_LP_VERS: These parameters are required when mPower authentication mode ENVIRONMENT is used.

MPC_LP_HOST: This is the hostname where mpower daemon is deployed.
MPC_LP_PORT: This is the port number that handles all the mPower connection requests to mpower daemon. This port is setup while installing LeasePak. For details, see Internet and Init Services Installed by LeasePak
MPC_LP_ENVR: This is the LeasePak environment name.
MPC_LP_VERS: This is the LeasePak version number.

MPC_LOG_FILE: This variable enables mpower client to debug log file for SOAP messages. Setting the variable to 0 will disable the log file. The variable will create and store messages in $ueop/log/*mpwr_api.log file.

MPC_SSL_VERIFY: Setting this variable to 1 will always verify SSL certificate when connecting to mPower. If the value is set to 0 then it will skip the verification SSL certificate.

The START_PORT_PROC and END_PORT_PROC scripts are listed following eop_run.cfg.

Sample Configuration File

    
# Required:
#   PROGRAM_LOC=	- path where portfolio_stat, portfolio_mon, eop_launch and
#			  eop_restart are located, typically $ubin/eop_mpwr
#   PORTFOLIOS=		- "-quoted list of portfolios to submit
#   ACCRUALS=		- Y or N
#   INVOICES=		- Y or N
#   MPC_URL=		- mPower URL where it is deployed
#			  Don't forget to add "/" at the end of URL
#   MPC_LP_AUTH=	- authentication mode (ADFS/PLAIN/ENCRYPTED/HEADER/ENVIRONMENT)
# Following are required when authmode = ADFS / HEADER / ENVIRONMENT :
#   MPC_LP_USER=	- LeasePak username that has access to mpower 
#   MPC_LP_PASS=	- LeasePak password 
# Following are required when authmode = ENVIRONMENT:
#   MPC_LP_HOST=	- hostname of where mpower daemon is deployed 
#   MPC_LP_PORT=	- port number of the mpower daemon
#   MPC_LP_ENVR=	- environment name
#   MPC_LP_VERS=	- LeasePak version e.g. 7.40
#
# Optional:
#   EOP_RUN_TYPE	- D or M or Y, user can set End of Month or Year 
#			  run before actual date which is allowed in U0401 
#			- If Blank, default U0401 setup will be used
#   SUBMIT_INTERVAL=	- defaults to 5 seconds between submitting portfolios
#   MONITOR_INTERVAL=	- defaults to 10 seconds between checks for EOP status
#   STALL_TOLERANCE=	- defaults to 120 iterations of MONITOR_INTERVAL
#   CHECK_NUMBER=	- if required by LeasePak setup
#   MAIL_TO=		- "-quoted, ;-separated list of email addresses
#   MAIL_FROM=		- email address
#   PRE_EOP_PROC=	- complete "-quoted path and text of job to perform
#			  before the first portfolio is submitted, such as backups
#   START_PORT_PROC=	- complete "-quoted path and text of job to perform
#			  before each portfolio is submitted
#   END_PORT_PROC=	- complete "-quoted path and text of job to perform
#			  when each portfolio completes
#   POST_EOP_PROC=	- complete "-quoted path and text of job to perform
#			  after the last portfolio has completed and has completed
#			  post-portfolio processing.
#   MPC_LOG_FILE=	  1 - enable mpower client debug log file for SOAP messages
#			  0 - disable log file
#   MPC_SSL_VERIFY=	  1 - always verify SSL certificate when connecting to mpower
#			  0 - skip verification of SSL certificate
#

PROGRAM_LOC=$ubin/eop_mpwr
PORTFOLIOS="2"
ACCRUALS=Y
INVOICES=Y
EOP_RUN_TYPE=
SUBMIT_INTERVAL=45
MONITOR_INTERVAL=60
STALL_TOLERANCE=30
CHECK_NUMBER=
MAIL_TO="[email protected];[email protected]"
[email protected]
PRE_EOP_PROC="rm -f $ueop/log/eopsuite.log"
START_PORT_PROC="$PROGRAM_LOC/clear_data $PORTFOLIO $ENVDIR/ready_data"
END_PORT_PROC="$PROGRAM_LOC/copy_data $PORTFOLIO $ENVDIR/ready_data"
POST_EOP_PROC="$PROGRAM_LOC/your_custom_program"

#-------------------------------------------------------------------------------------------------
# configuration variables for perl scripts
#-------------------------------------------------------------------------------------------------
MPC_URL=https://mpower.netsoltech.com/mpower-74a/
MPC_LP_AUTH=PLAIN
MPC_LP_USER=mpower
MPC_LP_PASS=mpower
MPC_LP_HOST=leasepak.netsoltech.com
MPC_LP_PORT=7406
MPC_LP_ENVR=mpower
MPC_LP_VERS=7.40
MPC_LOG_FILE=0
MPC_SSL_VERIFY=0