BBIS Power Tools Documentation

Overview

The BBIS Power Tools customization is intended to be easy to use and self-explanatory.

This document provides details on behaviors that may not be immediately apparent.

Check out the Brochure (PDF) for an even higher-level summary.

Installation and Configuration

Watch a video of the installation here

Once you've purchased BBIS Power Tools, unzip the downloaded file.

Inside, you'll find a bbappfx folder, and under that, more folders with the same file structure as your Blackbaud CRM server.

Simply copy the \bbappfx\ folder to your server.

Then, log into BBCRM and navigate to Administration>Application>Catalog Browser. Once you are there, filter for a type of "Package" and an author of "Styons Software".

Load the BBIS Power Tools package. Click Refresh Shell Navigation in the upper-left corner of your screen.

To register your product, go to Administration>SSC License Keys. Enter your license key, and click "Save". Now the product is fully installed.

User Management

Click on Web>BBIS User Management to access the User Management page. Once you are there, you will see a list of all your BBIS users.

Filters

By default, only active users are shown. You can include inactive and/or deleted users by clicking "Filters" and checking their respective boxes.

The list of users is a ListBuilder, which means you can click on the column header of any column to apply any additional filters you like.

Create User

When you click "Create User", a dialog appears with several options. Most of these are self-explanatory, but there are a few things worth noting:


User name: If you enter a user name that is already in use (even by a deleted or inactive user), then you will receive a warning message. Duplicate user names are not allowed.

Password: By default, the password will be masked. You can show the password by clicking the 'show/hide' button.
Time Zone: If you are in one of the following time zones, then the form will default to your local time zone:
EST, CST, MST, PST, AKST, HST, CST, London (GMT), Hong Kong (HKT)
If you are in any other time zone, then the form will default to EST. You can manually select a value appropriate to the time zone of the user you are creating.
Constituent: You can link to any constituent, including organizations and groups. If you add a constituent from within the lookup window, then standard dedupe logic will attempt to prevent duplicate constituent entry.

Delete

When you delete a user, it will do a "Soft Delete". In other words, it will set a deleted flag to "True". The user record will still exist in the database, and it can be undeleted if desired.

Activating Accounts

If you flag an account as "inactive", the user will still be able to log in.
They will experience limited functionality on your site, and their user record will be flagged with an "inactive" tag.
To disable access to your site, use the "Lock out" feature.

Email Viewer

Click on Web>Email to access the email page. Once you are there, you will see a set of filters and a datalist.

Filters

Filter by appeal, email name, or date sent.

The statistics shown in the list are the same as those in the BBIS honeycomb report.

Create User

When you click "Create User", a dialog appears with several options. Most of these are self-explanatory, but there are a few things worth noting:


User name: If you enter a user name that is already in use (even by a deleted or inactive user), then you will receive a warning message. Duplicate user names are not allowed.

Password: By default, the password will be masked. You can show the password by clicking the 'show/hide' button.
Time Zone: If you are in one of the following time zones, then the form will default to your local time zone:
EST, CST, MST, PST, AKST, HST, CST, London (GMT), Hong Kong (HKT)
If you are in any other time zone, then the form will default to EST. You can manually select a value appropriate to the time zone of the user you are creating.
Constituent: You can link to any constituent, including organizations and groups. If you add a constituent from within the lookup window, then standard dedupe logic will attempt to prevent duplicate constituent entry.

Delete

When you delete a user, it will do a "Soft Delete". In other words, it will set a deleted flag to "True". The user record will still exist in the database, and it can be undeleted if desired.

Activating Accounts

If you flag an account as "inactive", the user will still be able to log in.
They will experience limited functionality on your site, and their user record will be flagged with an "inactive" tag.
To disable access to your site, use the "Lock out" feature.

Diagnostic Tools

Error Viewer

The error viewer is a view into the raw "Error" table in the database. This table is used by BBIS to record internal system messages.
It automatically captures details about unhandled exceptions that occur in custom parts, too.

Filters

You can filter by date and error contents. The "Contains" filter will search for your text in the "Message", "Stack Trace", and "Additional Information" columns.
The filter automatically adds a "Like" operator to both sides of your search term. In other words, it will find your term if it occurs anywhere in any of those three columns.

WS Request Log Viewer

The WS Request Log Viewer is a window into the WSREQUESTLOG table in the database. This table captures extremely detailed information about requests to, and responses from, Blackbaud CRM endpoints. This even includes CRM "talking to itself", when internal operations are performed.
By default, this log is turned off.
To turn it on, you will need to edit your web.config file. Within that file, search for "WSREQUESTLOG". Un-comment the logrequests key. This change will take effect immediately, and it will have a performance impact. Thererfore, it is not a good idea to leave the log turned on in a production environment for very long.

Filters

You can filter by windows user, request, reply, error message, and date. All of the text filters will automatically add a "Like" operator to both sides of your search term. In other words, it will find your term if it occurs anywhere in the filtered column.