Difference between revisions of "Reload Blueprint"

Latest revision as of 22:57, 14 February 2017

Blueprint is a module for Reload that dredges statistical data about your GroupWise system without placing any load on the production server.

[edit] Install Blueprint

Blueprint comes with every install of Reload, but will not be active by default.

Install Blueprint by clicking the Blueprint button on the top bar of the Reload Web Administration. A new tab, Blueprint Log, will appear.

[edit] Upgrading Blueprint

Blueprint will check for upgrades every 3 days. It will download a small manifest file to determine if there has been a version change and if so it will download and install the update.

If the Reload server does not have access to the internet then the update can be downloaded from http://download.gwava.com/download.php?product=Blueprint&version=current

Copy the file to the Reload Server and place in

/opt/beginfinite/blueprint/upgrade

At a command prompt, type:

blueprint upgrade

[edit] Blueprint Command Line Options

Blueprint can be controlled from the command line

For a list of options, type:

blueprint

• View Blueprint Agent Log - Syntax: blueprint log
• Run Job Syntax: blueprint job start <GWAVA Reload profile name>
• Stop Job Syntax: blueprint job stop
• Stop One Profile's Current Running Job: blueprint job stop <GWAVA Reload profile name>
• Remove "Stop All Jobs" Syntax: blueprint job stop
• Single User Syntax: blueprint job start post1 "tkratzer"
• Single User - Live P.O. Syntax: blueprint live job start post1 "tkratzer"
• Report Job Status: blueprint status
• Configure Post Office Syntax: blueprint -r <Reload profile name> -c <GroupWise post office name>
• Upgrade Blueprint: blueprint upgrade (Check status before using this command, do not use when a blueprint job is running!)
• Report Version: blueprint -v

[edit] License Blueprint

Reload comes with a 30-day trial of Blueprint. Contact Sales for a Blueprint validation key. Enter the validation key into http://licenses.gwava.com to download a license PEM file.

• Browse to the Reload Web Administration page
• Select License from the Tools dropdown menu and press Go
• Click on "Click Here to License Blueprint for Reload"
• Browse to the PEM file and click on "Submit License File"
• Allow Reload a few minutes to consume the license

[edit] Configure Blueprint

• Browse to the Reload Web Administration Console
• Select the "Configure" tab
• Open the Blueprint for Reload panel by clicking on the Blueprint logo

By default, "Send Blueprint Reports to Email" is enabled, but the address to receive the reports needs to be configured, another address can be configured as a CC to also receive reports:

• Open General Settings
  • Set "Preferred Internet Domain Name"
• Open Summary Report Settings
  • Set "Summary Report TO Address"
• Open Users Report Settings
  • Set "Users Report TO Address"
• Open Resources Report Settings
  • Set "Resources Report TO Address"

Confirm that the Post Office name is correct in each profile:

• Browse to the Reload Web Administration Console
• Select the Post Office Profile
• Select the "Configure" tab
• Open the Post Office and POA Settings panel
• Set "Post Office Name" to the name of your Post Office

[edit] Advanced Settings

Blueprint has a number of advanced features

[edit] Personal Mailbox Reports panel

• Send Mailbox Reports to Active Users

Mailbox reports can be sent to active users. An active user has new items in the last 90 days.

• Personal Mailbox Report FROM Address

These mailbox reports can come from a custom email address.

• Send Only To Users in The Inclusion List

The inclusion list is a simple ASCII text file saved as:

/opt/beginfinite/blueprint/conf/individual_report_inclusion_list.conf

• Exclude Users in The Exclusion List

The exclusion list is a simple ASCII text file saved as:

/opt/beginfinite/blueprint/conf/individual_report_exclusion_list.conf

• Include Custom Message in Personal Mailbox Reports

A custom message can be added to the Personal Mailbox Report email, perhaps to warn a user they are reaching their storage limit

• Custom Message Text File

Be default, the custom message is saved as:

/opt/beginfinite/blueprint/conf/custom_content.txt 

[edit] Threshold Highlighting

The reports can be configured to highlight certain conditions that can be configured here.

• Highlight "All Mailbox & Calendar Items" Over a Certain Threshold
• Highlight "All Items Under X Days" Over a Certain Threshold
• Highlight "All Items Over X Days" Over a Certain Threshold

[edit] Generating Blueprint Reports

You can generate a Blueprint report manually by going to "Reload Web Administration | <profile> | Backups | Reload & Blueprint Job Control | Start a Blueprint Report Job"

[edit] View Blueprint Reports

You can have Reload send you the reports via email, as configured above, or you may view the reports from the Reload Web Administration Console.

• Browse to the Reload Web Administration Console
• Select the Post Office Profile
• Under the Overview tab, in the "Post Office Profile Status & Information" panel, click on Blueprint Reports

You can choose to view or download the reports:

• Summary Report
  • View Summary Report
  • Download All Reports
• User Reports
  • View HTML Report
  • View CSV Database
  • Download CSV Database
• Resources Reports
  • View HTML Report
  • View CSV Database
  • Download CSV Database