OpCon Server Options
The Enterprise Manager Administration supports management of Server Options in OpCon. Only the OpCon administrative users in the ocadm role can access the options. Refer to Managing Server Options in the Enterprise Manager online help.
General Settings
The General category contains default behavior settings for the SAM.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
Job Dependency Offset Type | Calendar Days | Y | This parameter determines if the Job Dependencies with Offset values are calculated with calendar days or with occurrence of the job.
|
Alternate Odd and Even Weeks | False | Y | The alternate to the Odd/Even Weeks frequency is Every Other Week. By setting the Server Option "Alternate Odd and Even Weeks" to "True," jobs using the Odd/Even Weeks frequency will be treated as Every Other Week frequency. Valid values are True and False. |
Number of Runs Included in Job Average Calculations | 10 | Y | Defines the number of most recent job history records to use when SAM Calculates Job Averages. Valid values range from 1 to 999. |
SAM Calculates Job Averages | False | Y | Determines if SAM calculates job start and run time averages after each job run.
|
Remove Period in Abbreviated Months and Days | False | Y | SAM will check this setting for resolving Tokens that contain abbreviated months and abbreviated days.
Valid values are True and False. |
Allow Wild Cards in Events | False | Y | This parameter indicates whether or not * (asterisk) and ? (question mark) are treated as wild cards in Schedule, Job, and Machine Names within Events. Valid values are True and False. |
TLS Certificate Serial Number | blank | Y | This parameter is an identifier of the digital certificate that is optionally assigned to the OpCon server's SMANetCom program, required only when TLS Client Validation has been selected by one or more LSAMs. This number can be found in the certificate store of the machine where the OpCon server is installed. When blank, the OpCon server's SMANetCom program will not supply a TLS Client certificate to any LSAM. Note: If an LSAM requires TLS Client validation, but SMANetCom does not provide its certificate, then the communication link with that LSAM will fail to connect. |
Login Security Message | blank | Y | This parameter configures a security message to display to users after logging into the application. If a value is specified, then this value is shown in the security message that is displayed to users after login. Note: This parameter configures the security message to display in both the Enterprise Manager and Solution Manager applications. |
Incident Management System | blank | Y | This parameter identifies the name of the ticketing system that is used for incident management. If a value is specified, then this value is used as a label to replace the "Incident Ticket ID" label in the Daily Job Information dialog. |
Allow Job Events to Restart Schedules | False | Y | This parameter configures the SAM to allow an event to start a completed schedule. If this option is activated, the following events cause the restart of a completed schedule: $JOB:ADD, $JOB:RESTART, or $JOB:RESCHEDULE. By default, the SAM does not restart a completed schedule and logs the event as an error in the Critical.log. When this option is activated, the SAM restarts a schedule to allow events to process if they are received after a schedule is completed. Valid values are True and False. |
Failed jobs should keep the Schedule "In Process" | False | Y | This parameter configures the SAM to keep schedules In Process that contain Failed jobs and Marked Failed jobs. By default, the SAM closes a schedule when all jobs are in one of the following job status categories: Cancelled, Skipped, Finished OK, or Failed. Refer to Jobs Status Change Commands. Valid values are True and False. |
Number of Days to Keep a Service Request Execution | 7 | Y | This parameter defines the number of days to retain service request execution history. |
Solution Manager URL | blank | N | This parameter defines the Solution Manager URL to allow opening Solution Manager within the Enterprise Manager. If a value is specified, a Solution Manager option will appear in the Navigation frame. Note: After defining a URL and saving the value, you must log out then log in to the Enterprise Manager for the Solution Manager option to appear in the Navigation frame. |
Logging Options
The Logging category contains log and trace settings for the SAM.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
Log Critical messages to NT Events | False | Y | This parameter enables writing of all SAM critical errors to the Application Log in the Microsoft Event Log. To minimize overhead, the SAM does not write critical messages to the Windows event log by default. Valid values are True and False. |
Log job dependency errors to Critical.log | True | Y | This parameter enables/disables logging job dependency errors to the critical log.
Valid values are True and False. |
Maximum number of days archived SAM logs should be kept | 10 | Y | This parameter sets the maximum number of archive folders (i.e., days) for all log archives. By default, the SAM deletes archived logs older than 10 days. The SAM archives log files once per day. Valid values range from 0 to 365. CAUTION: This number must be less than the ArchiveDaysToKeep setting in the SMAServMan configuration file. |
Maximum number of days Schedule Build logs should be kept | 10 | Y | This parameter sets the maximum number of days to keep Schedule Manager logs. By default, the SAM deletes logs older than 10 days. Valid values range from 0 to 365. |
SAM Message Logging Level | Terse | Y | This parameter determines the amount of SAM processing information written to the SAM log files. Valid values are Terse, Verbose, and Debug.
|
Time Settings
The Time Settings category contains time-related settings for the SAM.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
Hour of each day SAM should detect Schedules to build | 0 | Y | By default, at midnight the SAM detects schedules to build. Valid values range from 0 to 23 and are based on a 24-hour format starting from 0 (midnight) to 23 (11 p.m.). The SAM only processes the builds once per day. If this hour changes after the build process, SAM does not consider this parameter until the next day. Set specific times for individual schedules to build on the schedule definitions. For more information, refer to Schedule Maintenance. Note: To enable notification for failed schedule build processes, define OpCon events on the SMA_SKD_BUILD job on the AdHoc schedule. SMA Technologies provides template jobs for AdHoc with the AdHoc.mdb file. For more information, refer to SMA_SKD Jobs on the AdHoc Schedule. |
Minutes between checking running jobs | 5 | Y | This parameter determines the maximum time period for the SAM to wait before inquiring about job status. SAM only inquires about the job status if SMANetCom has not received a valid message from the LSAM in the configured amount of time. When jobs are processing, the status responses update the timestamp of the last time the SAM received job information. For short jobs, there is no need for the SAM to request job status. If the SAM does not receive a status for the job within the specified time-out value, it requests the job status. This timer is necessary for jobs that run for long periods of time. It is also necessary for possible losses in communication between SMANetCom and the LSAM. If job-processing issues are suspected, set this timer to three minutes for debugging. When finished debugging, set the timer back to five minutes. If all is running well, this timer can be increased to a recommended maximum of 10 minutes. Valid values range from 1 to 1440. Note: Jobs in a "Start Attempted" status are not subject to this timer because they are checked in as timely a fashion as possible. |
Seconds SAM should wait between PreRun attempts | 180 | Y | This parameter determines the amount of time in seconds between prerun attempts. By default, the SAM re-attempts prerun jobs every 180 seconds (3 minutes) until the job succeeds. Valid values range from 0 to 32000. |
SMTP Server Settings
The SMTP Server Settings category contains configuration options the SMA Notify Handler will use to send email and/or SMS notifications.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
JORS Attachment Timeout | 120 | Y | Defines the number of seconds the SMA Notify Handler should wait for an attachment to return from a JORS request. Valid values range from 60 to 3600 seconds. |
Authentication User (UNC Access) | blank | Y | Defines the Windows user account the SMA Notify Handler will use to gain access to machines and UNC paths on the network. This user is required if:
The user must have privileges to:
|
Authentication Encrypted Password (UNC Access) | blank | Y | Defines the encrypted password for the Windows user the SMA Notify Handler will use to gain access to machines and UNC paths on the network. This user is required if:
To encrypt the password manually:
|
SMTP Server Name (Primary Email) | blank | Y | Defines the name of the Primary SMTP server for sending email. If no SMS servers are defined, this server will also send SMS text messages. If the value is blank, the SMA Notify Handler cannot send email or text notifications. Default: Blank |
SMTP Server Port (Primary Email) | 25 | Y | Defines the server port that SMA Notify Handler will use when sending email through the Primary SMTP server. The user can set the value for this option.
|
SMTP Notification Address (Primary Email) | noreply | Y | Defines the email address the SMA Notify Handler will use as the "From" address when sending E-mail or Text Messages through the Primary Email server. If the SMTP server requires authentication, this setting is ignored and the administrator must configure the SMTP Authentication User and Password for the Primary Email server. If a value is not specified, the SMA Notify Handler will default to noreply. Customers should specify an email address consistent with their domain name. The SMA Notify Handler will not validate the email address specified; it will only send the message with that "From" address, leaving the validation up to the SMTP server. |
SMTP Authentication User (Primary Email) | blank | Y | Defines an email address for authentication to the Primary Email SMTP server. If the SMTP server requires authentication, a value must specified here. If a value is not specified when required by the SMTP server, the SMA Notify Handler will not be able to send emails or text messages. Customers should specify an email address consistent with their domain name. The SMA Notify Handler will not validate the email address specified; it will only send the message with the user and password specified, leaving the validation up to the SMTP server. |
SMTP Authentication Encrypted Password (Primary Email) | blank | Y | Defines the password for the SMTP Authentication User for the Primary Email server. If the SMTP server requires authentication, a value must specified here that provides the encrypted password for the user. To encrypt the password manually:
|
SMTP Total Attachment Size in MB (Primary Email) | 10 | Y | Determines the maximum total of MB in the attachments for an email attachments notification from the Primary Email SMTP server. This value should match the limit set by the SMTP server. |
SMTP Authentication -Enable SSL (Primary Email) | False | Y | Determines if the SMA Notify Handler will use SSL encryption when connecting to the Primary Email SMTP server. If the SMTP server requires SSL Encryption, the value must be set to True. |
SMTP Maximum Number of Attachments (Primary Email) | 50 | Y | Determines the maximum number of attachments allowed per email on a notification from the Primary Email SMTP server. This value should match the limit set by the SMTP server. |
SMTP Server Name (Secondary Email) | blank | Y | Defines the name of the Secondary SMTP server for sending email.If messages fail to send through the Primary Email server, the SMA Notify Handler will attempt to send the message again through the Secondary Email server. If no SMS servers are defined, this server will also serve as a Secondary server to send SMS text messages. If the value is blank, the SMA Notify Handler will not attempt messages through a Secondary server. Default: Blank |
SMTP Server Port (Secondary Email) | 25 | Y | Defines the server port that SMA Notify Handler will use when sending email through the Secondary SMTP server. The user can set the value for this option.
|
SMTP Notification Address (Secondary Email) | noreply | Y | Defines the email address the SMA Notify Handler will use as the "From" address when sending E-mail or Text Messages through the Secondary Email server. If the SMTP server requires authentication, this setting is ignored and the administrator must configure the SMTP Authentication User and Password for the Secondary Email server. If a value is not specified, the SMA Notify Handler will default to noreply. Customers should specify an email address consistent with their domain name. The SMA Notify Handler will not validate the email address specified; it will only send the message with that "From" address, leaving the validation up to the SMTP server. |
SMTP Authentication User (Secondary Email) | blank | Y | Defines an email address for authentication to the Secondary Email SMTP server. If the SMTP server requires authentication, a value must specified here. If a value is not specified when required by the SMTP server, the SMA Notify Handler will not be able to send emails or text messages through the Secondary server. Customers should specify an email address consistent with their domain name. The SMA Notify Handler will not validate the email address specified; it will only send the message with the user and password specified, leaving the validation up to the SMTP server. |
SMTP Authentication Encrypted Password (Secondary Email) | blank | Y | Defines the password for the SMTP Authentication User for the Secondary Email server. If the SMTP server requires authentication, a value must specified here that provides the encrypted password for the user. To encrypt the password manually:
|
SMTP Total Attachment Size in MB (Secondary Email) | 10 | Y | Determines the maximum total of MB in the attachments for an email attachments notification from the Secondary Email SMTP server. This value should match the limit set by the SMTP Server. |
SMTP Authentication -Enable SSL (Secondary Email) | False | Y | Determines if the SMA Notify Handler will use SSL encryption when connecting to the Secondary Email SMTP server. If the SMTP server requires SSL Encryption, the value must be set to True. |
SMTP Maximum Number of Attachments (Secondary Email) | 50 | Y | Determines the maximum number of attachments allowed per email on a notification from the Secondary Email SMTP server. This value should match the limit set by the SMTP server. |
SMTP Server Name (Primary SMS) | blank | Y | Defines the name of the Primary SMTP server for sending SMS text messages.
|
SMTP Server Port (Primary SMS) | 20 | Y | Defines the server port that SMA Notify Handler will use when sending SMS text messages through the Primary SMS server. The user can set the value for this option. Valid values range from 0 to 9999, and must be positive. If no user-defined value is specified, then the default port (20) will be used. |
SMTP Notification Address (Primary SMS) | noreply | Y | Defines the email address the SMA Notify Handler will use as the "From" address when sending SMS Text Messages through the Primary SMS server.
The SMA Notify Handler will not validate the email address specified; it will only send the message with that "From" address, leaving the validation up to the SMTP server. |
SMTP Authentication User (Primary SMS) | blank | Y | Defines an email address for authentication to the Primary SMS SMTP server.
The SMA Notify Handler will not validate the email address specified; it will only send the message with the user and password specified, leaving the validation up to the SMTP server. |
SMTP Authentication Encrypted Password (Primary SMS) | blank | Y | Defines the password for the SMTP Authentication User for the Primary SMS server.
|
SMTP Authentication -Enable SSL (Primary SMS) | False | Y | Determines if the SMA Notify Handler will use SSL encryption when connecting to the Primary SMS SMTP server. If the SMTP server requires SSL Encryption, the value must be set to True. |
SMTP Server Name (Secondary SMS) | blank | Y | Defines the name of the Secondary SMTP server for sending SMS text messages.
|
SMTP Server Port (Secondary SMS) | 20 | Y | Defines the server port that SMA Notify Handler will use when sending SMS text messages through the Secondary SMS server. The user can set the value for this option. Valid values range from 0 to 9999, and must be positive. If no user-defined value is specified, then the default port (20) will be used. |
SMTP Notification Address (Secondary SMS) | noreply | Y | Defines the email address the SMA Notify Handler will use as the "From" address when sending Text Messages through the Secondary SMS server.
The SMA Notify Handler will not validate the email address specified; it will only send the message with that "From" address, leaving the validation up to the SMTP server. |
SMTP Authentication User (Secondary SMS) | blank | Y | Defines an email address for authentication to the Secondary SMS SMTP server.
Customers should specify an email address consistent with their domain name. The SMA Notify Handler will not validate the email address specified; it will only send the message with the user and password specified, leaving the validation up to the SMTP server. |
SMTP Authentication Encrypted Password (Secondary SMS) | blank | Y | Defines the password for the SMTP Authentication User for the Secondary SMS server.
|
SMTP Authentication -Enable SSL (Secondary SMS) | False | Y | Determines if the SMA Notify Handler will use SSL encryption when connecting to the Secondary SMS SMTP server. If the SMTP server requires SSL Encryption, the value must be set to True. |
Notification Settings
The Notification Settings category contains configuration options for the SMA Notify Handler.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
MaximumLogFileSize (bytes) | 150000 | Y | Defines the maximum size in bytes for each log file. Determines when the current log file is closed and a new file is started. When the file reaches this maximum size, it is archieved and a new log file is created. This setting creates small manageable log files. The SMANotifyHandler.log resides in the <Output Directory>\SAM\Log\ directory. When the log file reaches the maximum size, the SMA Notify Handler archives the file in <Output Directory>\SAM\Log\Archieve\<Date> . The SAM then maintains the archive folders.Minimum Value = 50000 bytes Maximum Value = 500000 bytes |
Trace Level | None | Y | Determines the detail of debug trace logs. Valid Selections:None Basic (non-detailed trace)DetailedVery Detailed (Traces all the possible debug information in the application.) |
Include Labels in Notifications | True | Y | This parameter enables/disables the inclusion of labels for Machine Name, Schedule Name, Job Name, and so forth in notification messages. By default, the SMA Notify Handler includes all labels to enhance the clarity of the information. This setting applies to all notification types except "Text Message." Valid values are True and False. |
Include Machine Name in Notifications | True | Y | This parameter enables/disables inclusion of the Machine Name in notification messages. By default, the SMA Notify Handler includes the machine name to identify the job's machine. This setting applies to all notification types except "Text Message." Valid values are True and False. |
Notification Delimiter | blank | Y | This parameter determines the delimiter used between fields in notification messages. This delimiter allows third-party notification tools to easier read messages. Valid values are:
|
Seconds between Checking for New Notifications | 20 | Y | This parameter defines the delay in seconds between searches for new events in the NOTIFY table. Valid values range from 5 to 20. |
Days to Keep Notification History | 14 | Y | Defines the number of days of Notification history to keep in the database. The notification history table shows the notification ID and trigger that caused each notification so users can research how a notification was generated. Valid values range from 1 - 35. |
Event Source for Windows Event Log Messages | OPCON_ENS | Y | This parameter defines the event source that show up in the Source column in the Windows Event Viewer. Valid values are OPCON_ENS or SMANotifyHandler. |
SPO Notifications Enabled | False | Y | This parameter enables/disables processing of SPO events by the SMA Notify Handler. Valid values are True and False. |
Path and File Name of SPO Executable | blank | Y | This parameter defines the full path to the executable responsible for processing SPO messages. |
SPO Default Alarm ID | blank | Y | This parameter is the default machine name for SPO Events. By default, the SMA Notify Handler does not send a machine name with SPO events. The maximum is 24 characters. |
Stack SPO Events | True | Y | This parameter enables/disables the SMA Notify Handler to make the ALARM qualifier unique across multiple job states. Valid values are True and False.
|
SNMP Notifications Enabled | False | Y | This parameter enables/disables processing of SNMP events by the SMA Notify Handler. Valid Values are True and False. |
Write SPO and SNMP Event Failures to the Windows Event Log | True | Y | This parameter enables/disables the SMA Notify Handler to write SNMP or SPO event failures to the Windows Event Log. Valid values are True and False. |
Automatic License Notifications
The Automatic License Notifications category contains settings to determine if and how the SAM will send automatic license notifications.
SMA Technologies strongly recommends enabling automatic license notifications. If for any reason the license is compromised and this feature is not enabled, only SAM Critical log will report the problem. Notifying SMA Technologies and local OpCon administrators automatically will ensure action can be taken before the license expires.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
Send Email to SMA Office | Disabled | Yes | This parameter determines if SAM will automatically send email notifications to SMA Technologies office when:
To enable this option choose the SMA Technologies Office that provides sales and support for this site. Valid values include:
|
Send Email Cc | blank | Yes | For all customers, this parameter configures the list of email addresses that will be copied when the SAM automatically sends license expiration notices. For customers with a Task-based license, this parameter also configures the list of email addresses that will be copied when SAM automatically sends the license notification at the beginning of each month to SMA Technologies. Enter one or more SMTP email addresses separated by semicolons ( ; ). |
Encrypt Task License Report | False | Yes | For customers with a Task-based license, this parameter determines if the SAM will encrypt the data for the license reports. Valid values include True and False.
|
Password Requirements
The Password Requirements category contains the requirements for OpCon Login passwords.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
(Password cannot be the same as the User Login ID) | True | N | This parameter is a hidden, static password requirement. Note: You may not set your password to match your login ID. |
Minimum number of lower-case characters required | 0 | Y | This parameter defines the minimum number of lower-case characters required in a password. |
Minimum number of upper-case characters required | 0 | Y | This parameter defines the minimum number of upper-case characters required in a password. |
Minimum number of days between password changes | 0 | Y | This parameter defines the minimum number of days before a user can change a password. Note: If the value is set to 0, this parameter is disabled. |
Requires numeric characters | False | Y | This parameter determines if the password must contain numeric characters. Valid values are True and False. |
Requires alpha characters | False | Y | This parameter determines if the password must contain alphabetical characters. Valid values are True and False. |
Requires special characters | False | Y | This parameter determines if the password must contain special characters. Valid values are True and False. |
Number of times a character can repeat consecutively | 2 | Y | This parameter determines the number of times a character can repeat consecutively in a password. Example: If value is set to 2, the password "jjj" would be invalid. Valid values range from 1 to 12. Setting the value to 0 disables the setting. |
Number of days a password is valid | 0 | Y | This parameter determines the number of days a password is valid from the time users changes their password. CAUTION: SMA Technologies recommends setting user accounts involved in batch processing to have the password that never expire. When turning this setting on, you should strongly consider all User Accounts set up for running batch processes. To prevent these users from expiring, you may update each of those user accounts to have the password never expire. Refer to User Accounts. Valid values range from 0 to 365. Setting the value to 0 disables the setting. |
Number of days before password expiration to warn user | 0 | Y | This parameter determines the number of days in advance of password expiration that the primary graphical user interfaces will warn users that their password is about to expire. Valid values range from 0 to 30. Setting the value to 0 disables the setting. |
Minimum number of characters | 8 | Y | This parameter defines the minimum number of characters allowed for every user's password in OpCon. Valid values range from 1 to 12. |
Number of passwords to retain in history | 0 | Y | This parameter determines the number of passwords for OpCon to retain in history. When a user changes their password, they will not be able to reuse any of the in the history. Valid values range from 0 to 20. Setting the value to 0 disables the setting. |
Number of failed logon attempts before account lockout | 0 | Y | This parameter determines the number of password attempts before the account is locked. Valid values range from 0 to 10. Setting the value to 0 disables the setting. |
HTML Documentation
The HTML Documentation category contains the setting for the web-based documentation.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
Root URL for Documentation | blank | Y | Defines the root URL to use to access the documentation from the local network. Applications such as the Enterprise Manager (EM) use this URL to access the documentation. Any desktop having EM must be able to reach this URL in order to access the OpCon documentation. |
Vision Settings
The Vision category contains the settings for the Solution Manager Vision module.
Parameter | Default | Dynamic (Y / N) | Description |
---|---|---|---|
Days of Vision History to Keep | 3650 | Y | Defines the number of days Vision data will be retained. |
Days in Past to Trigger Vision Actions | 1 | Y | Defines the number of days in the past to use for triggering Vision Actions. |
Days in Future to Trigger Vision Actions | 1 | Y | Defines the number of days in the future to use for triggering Vision Action. |