General configuration
Module reference
The main configuration file for ProactivePack module is $PRODUCT_HOME/config/custom/Global.conf.
|
Parameter |
Description |
Default/typical value |
|
[Global] section |
||
|
functionality |
Used to organize the modules into different menu sections |
Administration |
|
AuditLevel |
Level for the audit (user activity) log. 0 = no audit 1 = basic audit (“user changed configuration”) 2 = advanced audit (“user changed configuration and the new configuration is <lots of details>”) |
1 |
|
CellName |
Name of the cell that is targeted by default from the different ProactivePack modules. Most modules can override this value in their specific configuration. |
N/A |
|
CompanyLogo |
A logo image for your company |
proactivepack.png |
|
CompanyName |
The very name of your organization |
(empty) |
|
DefaultGroupName |
The name of the user group to which an unregistered user is associated. (See “configuring security” section) |
Guest |
|
EventSlotsUseLabels |
A flag that indicates if event slots (primarily in the Quick Queries modules) are shown using a label or their internal value (E.G. Host <> mc_host). |
1 |
|
FooterLabel |
A message that appears in the page footer in place of the ProactivePack version number |
(empty) |
|
GlobalStatusFile |
Path to a custom script that animates the banner status icon. See Global status script |
None |
|
GroupLogoAllowed |
A flag indicating if a specific group logo can be used in each ProactivePack user group. |
1 |
|
GroupSkinAllowed |
A flag indicating if a specific group Skin can be used in each ProactivePack user group. |
|
|
McellHome |
The value must be the value of the $MCELL_HOME (%MCELL_HOME%) environment variable. It needs to be set explicitly as the web server typically does not have access to the system environment. Use quotes on Windows if there are spaces in the path. Use backslashes on windows and forward slashes on Unix. |
/opt/Impact/server/
|
|
MenuOrder |
Comma-separated list of top-level menu entries (functionalities). In case MenuOrder is set, the ProactivePack top-level menu will be reordered according to MenuOrder. |
|
|
PerlBin
|
The full absolute path (including filename) to the Perl compiler. If Perl is in the path, you can simply use the value « perl ». |
/opt/ActivePerl/bin/perl |
|
RootPathOverwrite |
Allow to provide a different path (below server name) for ProactivePack. |
(empty) |
|
RootServerOverwrite |
Allow to provide a different root server for ProactivePack, e.g. when placed behind a custom login server that builds redirections |
Empty. Example : https://portal.company.com |
|
TitleLabel |
Label as it appears in the browser tab |
ProactivePack |
|
TmpDirCleanupDays |
Number of days after which files created in the ./tmp folder are cleaned up. |
7 |
|
TraceLevelFile |
Trace level when writing to the file specified under the TraceFile parameter. 0 = no trace 1 = normal trace (default) 2 = verbose trace (not implemented) 3 = debug trace (not advised for regular use) |
1 |
|
UserToGroupFile |
Determines how authenticated users are mapped to groups. See the “Configuring Security” section for details. |
File:security/UserGroups.conf |
|
ExternalAuth |
Determines is external authentication is used. |
0 |
|
ExternalAuthType |
Type of external authentication to use if ExternalAuth is set to 1. Choices are : TSPS HELIX TSPS_SAML_IDP |
TSPS |
|
ExternalLoginURL |
URL of external authentication server. If the authentication type is TSPS,SAML or TSPS_SAML_IDP, the URL must correspond to the TrueSight Presentation Server hostname (and optionally port). |
|
|
BackgroundLogonImage |
In case if external authentication, background logon image is random but can be set using this configuration parameter |
MyImage.jpg |
|
MaxSessionTime |
maximum session duration, in hours. Default to 24. Users are automatically logged out after the period has ended. |
24 |
|
ModalAutoClose |
Timeout for automatic closur of modal upon success in seconds |
3 |
|
[Logging] section |
||
|
AuditFileNumber |
Number of archived audit files to keep before purging |
5 |
|
AuditFileSize |
Size of each audit file |
5242880 |
|
TraceFileNumber |
Number of archived trace files to keep before purging |
5 |
|
TraceFileSize |
Size of each trace file |
5242880 |
|
[Mail] section |
||
|
SMTP |
Hostname/IP address of the SMTP server |
|
|
smtp_port |
SMTP server port |
25 |
|
smtp_auth |
Flag indicating if SMTP server requires authentication |
false |
|
smtp_user |
SMTP username (optional) |
|
|
smtp_passwd |
SMTP password (optional |
|
|
sender_email |
|
noreply@proactivepack.com |
|
[SAML] section |
||
|
sp_baseUrl |
Servie provider base URL – should correspond to the local ProactivePack URL. |
Can be used to override the SP base URL provided in the SAML XML file |
|
[HELIX] section |
||
|
AccessKey |
Access key to use in BHOM |
|
|
AccessSecretKey |
Access secret key |
|
|
RESTAPIAuthenticationTokenDuration |
Token duration – do not change value |
900 |
|
RESTAPIHost |
BHOM URL |
|
|
Tenant |
BHOM tenant |
|
| [BigPanda] section | ||
|
OrgToken |
BP Organization token |
|
|
UserToken |
BP User token |
|
|
EnvironmentId |
BP Environment Id |
|
|
RESTAPIHost |
BP URL |
|
|
RESTAPIAuthenticationTokenDuration |
Token duration – do not change value |
900 |
Security
Application-wide, the following permissions can be set:
|
Parameter |
Description |
Default/Typical Values |
|
AllowConfigTextEditor |
1=allow usage of an embedded text editor to edit modules & group configuration files 0=forbid |
0 or 1 |
|
AllowViewAdminGuide |
1= Allow users to see / download Admin guide 0= forbid users to see / download Admin guide |
0 or 1 |
|
AllowFileUpload |
1=Allow users to upload files that will be stored under $PRODUCT_HOME/data/Global. These files may be used as external sources, etc. |
0 or 1 |
|
Configure |
1= allow access to the “ProactivePack administration” module 0= forbid access to the “ProactivePack administration” module
|
0 or 1 |
|
DateFormatAllowed |
1= Allow users to change the display format of date fields 0= Prevent users to change the display format of dates. In that case, the display language sets the date format |
0 |
|
GroupLogo |
Filename of the logo for the group user |
|
|
UserLogoAllowed |
1= allow users to user their own personal logo 0= forbid users to user their own personal logo |
0 or 1 |
|
UserSkinAllowed |
1= allow users to user their own personal skin 0= forbid users to user their own personal skin |
0 or 1 |
|
MaxSessionTime |
Global max sessions time duration for Group. Default to 24h. After sessions start plus MaxSessionTime user will be logged out |
24 |
BMC TSOM integration
mcell.dir configuration
ProactivePack uses a mcell.dir file to know about the cells that must be connected. Please note that by default this directory file is shared between the QUAL and PROD ProactivePack instances (This can be changed)
To do this:
· Copy/paste the cell entries you need from the TrueSight mcell.dir file
· Save the content by pressing the “save” button at the bottom of the screen.
TrueSight Event Management cells
Several ProactivePack features require the TrueSight event management cell to include additional resources.
These specific classes, collectors and rules are located in the $PRODUCT_HOME/Tools/kb folder of ProactivePack.
The classes must be loaded in the order set in the table below. For more details refer to the ProactivePack administration guide and to your TrueSight administrator.
|
Filename |
Content |
Usage |
|
classes/ProactivePack_Events.baroc
|
General event classes definitions |
Optional for QuickQueries and Data Replication
|
|
classes/ProactivePack_Data.baroc
|
General data classes definitions |
Optional for QuickQueries Required for Data Replication |
|
classes/Maintenance_Enums.baroc |
Blackout Enumeration definitions |
Mandatory for Blackout |
|
classes/Maintenance_Event.baroc |
Blackout Event classes definitions for Event Management cell |
Mandatory for Blackout |
|
classes/Maintenance_Custom_Event.baroc |
Optional set of Blackout class definitions that must be loaded in case custom blackouts are used AND must be managed from the CLI |
Optional for Blackout |
|
classes/Maintenance_Data.baroc |
Data classes definitions for Blackout |
Mandatory for Blackout |
|
classes/Maintenance_Impact.baroc |
Event and Data classes definitions for Impact Management cell |
Optional for Blackout |
|
|
|
|
|
rules/ProactivePack_QuickQueries.mrl
|
Rules to manage events sent by the db import script |
Optional for QuickQueries |
|
rules/Maintenance_Event.mrl |
Rules for event management |
Mandatory for Blackout |
|
rules/Maintenance_Custom_Event.mrl |
Set of rules that must be loaded in case custom blackouts are used AND must be managed from the CLI. |
Optional for Blackout |
|
rules/Maintenance_Impact.mrl |
Optional - Rules for Impact management. |
Optional for Blackout |
|
collectors/Maintenance_collectors.mrl |
Blackout Management specific collectors for event management. |
Optional for Blackout |
|
records/Maintenance_options.baroc |
Blackout options for both Event and Impact Management |
Mandatory for Blackout |
|
collectors/ProactivePack_cols.mrl |
ProactivePack collectors |
Optional for QuickQueries and Data Replication |
BHOM integration
The connection strings to BHOM must be supplied in the Global configuration. To do so, navigate to Administration => ProactivePack => Modules => Administration => ProactivePack => Edit, and fill-in the connection strings of BHOM in the HELIX section:
The account of the access key must have administrator access into BHOM.
Save the changes.
BigPanda integration
The connection strings to BigPanda must be supplied in the Global configuration. To do so, navigate to Administration => ProactivePack => Modules => Administration => ProactivePack => Edit, and fill-in the connection strings of BigPanda in the BigPanda section:
The account of the access key must have administrator access into BigPanda.
Save the changes.