The goal of this document is to identify UMP job settings in the registry which may need to be modified after the scheduled job is created. While it does not cover all possible entries, it does describe some useful and some not so useful entries that typically need to be changed after a job is created. This information is subject to change and no support will be provided over the manual editing of a job. At present, if changes need to be made to a job that are not available in the tool's user interface, you should delete and re-create the job with the desired settings.
In User Manager Pro, after you have created scheduled jobs, such as report or password randomization jobs, you need to change the settings of the job but no editing options are available to you.
The only options available for modifying the scheduled jobs is to add or remove systems from the list or to change its schedule.
User Manager Pro's job settings are stored in the system's registry. You will need to edit the registry in order to change these additional settings.
Note: incorrectly modifying the registry can lead to general system instability or loss of data. Lieberman Software assumes no responsibility for damages that occur to your system as a result of incorrectly modifying the registry. As always, you should ensure you have a current system state backup prior to manipulating your system's registry.
Open your system's registry editor by typing regedit and navigate to "HKLM\Software\Lieberman\UsrMgrPro 2.0\Jobs\Schedule". Here you will find a key which corresponds to the job(s) you wish to modify. It will have a name similar to "00000018". It is in and under this key you will find all of the job settings.
Note: incorrectly modifying your job settings can cause your scheduled job to not run correctly, run at the incorrect time, or perform unintended actions.
The options you see will vary based on job type. However, the basic layout is largely the same: In the job number/id key, you will find information about the job creation and run times:
* Can be edited in normal user interface; deferred jobs job editor
- ActiveGroupName, string value: this is the group where the system(s) you are managing/reporting on were selected from
- ActOnGroup*, String: dynamic group name to run this job against. If you do not wish to use this value, it should be deleted.
- bDeleteOnEnd, DWORD, value = 1 or 0: this tells the system to or not to delete the job after its next run
- bRetry, DWORD, value = 1 or 0: indicates that the job is or is not in a state of retry
- bRunNow*, DWORD, value = 1 or 0: indicates that the job will be run following the defined sleep interval regardless of job schedule
- bStopped, DWORD, value = 1 or 0: If set to one, indicates that retries (per retry policy) have been exhausted
- DayOffset*, DWORD, value = 0 - 6: indicates which day of the week the job is scheduled to run on. Value is ignored if job schedule does not use days such as an hourly job.
- DoWakeOnLan, DWORD, value = 1 or 0: determines if a wake on lan packet will be sent prior to the job initiation.
Note: In order for wake on LAN to work, your hardware must be configured to support it and this tool must have successfully talked to that machine in the past in order to have the necessary addressing information required for WOL to work.
- GroupComment, String: comment for the group if the group has a comment
- IconImage, DWORD, value = 0, 1, or 2: used to help determine job status. 0 = Green, 1 = Yellow, 2 = Red
- JobComment, String: This text value is displayed in the deferred processing windows and is typically used to identify what the scheduled job is doing
- JobCreationTime, Binary: this is the job creation time in binary format
- LastErrorCode, DWORD: last error code for any part of the job that ran
- m_bRunOnNewSystems*, DWORD, value = 1 or 0: determines if the job will run against new systems that are added to the group. Works only for dynamic groups (see "ActOnGroup" above)
- m_bUpdateSystemList*, DWORD, value = 1 or 0: determines if UMP will update the dynamic group membership prior to running the job
- MinOffset*, DWORD, value = 0 - 59: time in minutes into the hour that the job will run
- MonthOffset*, DWORD, value = 0-11: month in which the job will run
- Retries, DWORD: number of retries the job has performed to date for the current job run
- SetBits, DWORD: used to determine the job type such as user editing, or reporting, etc.
- SkedDayMap*, DWORD: if the job is a days of week job, this value indicates which days the job will run
- SkedNextRetryTime, DWORD: next scheduled retry time for the job time_t format
- State, DWORD, value = 0 - 8: current executing state of the job
- Status, String: text value of the last result of the last action performed by the job
- sync_type, DWORD, value = 2 - 5: 2 = SET, 3 = Reboot, 4 = Abort Reboot, 5 = Physically ID System, one
- TimeOffset*, DWORD, value = 0 - 23: hourly offset for daily job runs
- WakeOnLanDelay, DWORD: value in seconds between WOL packet send and job initiation
- YearOffset, DWORD, value = 0 or 1: for a one time job if it is this year (0) or next year (1)
Underneath the job number/id key you will find the following subkeys:
- Actions - subkeys define the list of systems to perform work on and the status of that work on those systems
- ReportingParams - seen if scheduling a report; contains information about report id and database connection info
- Notifications - visible if scheduling a report and selected to perform post-generation actions such as emailing the report; see below
- EditUser - seen if scheduling user actions
- EditRight - seen if managing user/group rights
- EditPolicies - seen if managing password and account lockout policies
- EditAuditing - seen if turning of or on audting
- EditRegistry - see if making registry changes
- EditRegistryPermissions - seen if changing registry permissions
- EditGroup - seen if managing local group
- EditGlobalGroup - seen if managing global groups
- EditGroupMembership - seen if manipulating local group membership
- EditGlobalGroupMembership - seen if manipulating global group membership
Notifications: during the scheduling of a report, the last setup action is to determine if you would like to perform post report generation actions. You may generate a file, send an email, send a file as an email attachment, or run a program. Those settings are determined here and can only be changed in the registry. The valid settings for these notifications are:
- bAttachFile, DWORD, value = 1 or 0: determines if the created file, when being emailed, is to be the body of the email or attached as a separate file
- bExportEnable, DWORD: not used for scheduled reporting
- bExportSelect, DWORD: not used for scheduled reporting
- bLimitToEnabled, DWORD: not used for scheduled reporting
- bLimitToSelect, DWORD: not used for scheduled reporting
- bOutputColumnHeaders, DWORD, value = 1 or 0: indicates if the column headers identifying the data in the column are to be included in the report
- EMAILSubject, string: the subject line of the email
- ExecCommandLine, string, the fully qualified path to the executable to be run once the report has finished running
- ExecWorkingDirectory, string (optional): used in conjunction with ExecCommandLine, should be the fully qualified path to the directory where the executable is being run from
- HTMLFileName, string: if generating an html report, this can be used to specify the fully qualified path to an alternate html template
- HTMLReportAlternateRowColors, DWORD, value = 0 or 1: a value of one will set every other row in an HTML report as either grey or white
- iSortColumnIndex, DWORD, value = 0 - N: 0 represents the first column name in the report while N represents the last; if your report had 13 columns and you wanted to sort by the seventh column, you would use a value of 6, likewise, if you wanted to sort by the last column, you would use a value of 12.
- ReportAction, DWORD, value = 0 - 4: 0 = none, generate file only, 1 = view, 2 = print, 3 = email, 4 = execute
- ReportMaxWidth, DWORD, value = 0 - 100: used for fixed width files, indicates the number of columns to be included in the report
- ReportName, string: fully qualified path to where the generated report should be created and named
- ReportTitle, string: the title displayed in the title bar of an html report
- ReportType, DWORD, value 0 -3: indicates the type of report output, 0 = CSV, 1 = tabbed, 2 = ASCII, 3 = HTML
- SMTPToList, string: semicolon ';' delimited string value of all email recipients of this report (e.g. email@example.com;firstname.lastname@example.org)
To determine which columns should be included in the exported report, UMP will look at the "ColumnsEnabledForExport" subkey and look at the 1 or 0 value for each possible column and only include items with a value of 1 in the report that is generated.
The values seen in the other subkeys are subject to change or addition as feature are added or modified.
User Manager Pro Suite (UMPS)
User Manager Pro (UMP)