What would you like to know more about?

Show Page Sections

Configuring Tools

Learn how to configure tools, including seeing which pages house tools, managing user access to tools, adding a new tool, and more.

Every MinistryPlatform system has access to many tools in the application. SPoCs are responsible for ensuring users have appropriate access to these tools.

See Tool Availability by Page

See the tools available on each page in MinistryPlatform.

CAUTION: SPoCs should not adjust which pages each tool is available on; the tool might not function as expected.
  1. In the navigation menu, click System Setup > Tools/Actions.
  2. Open the tool record.
  3. Click the Permitted Pages tab to see which pages the tool displays on.

Grant User Access to Tools

Users won't have access to any tools until a SPoC provides access through security roles.
  1. In the navigation menu, click Administration > Security Roles.
  2. Either create a new security role or open a security role to edit.
  3. Go to the Tools Permitted tab.
  4. Click New Role Tool.
  5. Search for and select the tool you want to grant access to.
  6. Click Save.
  7. Go to the Users tab.
  8. Review the users to ensure the appropriate users are indicated are listed. If needed, add more users.

Users should refresh their web browser for the security role's update to take effect.

Note: For more information, see Security with Tools and Reports.

See User Access to Tools

See which tools are available to each user.

  1. In the navigation menu, click Administration > Users.
  2. Click Reports and select User Permissions: Reports & Tools.
  3. Set the report parameters as needed.
  4. Click View Report.

Add a New Tool

If a new tool is not listed on the System Setup page, a SPoC can contact Support or add the new tool manually.

Add the Tool
  1. In the navigation menu, click System Setup > Tools/Actions.
  2. Click New Tool.
  3. Enter the tool name.
  4. Enter the path for the launch page (for example, ...cloudapps.ministryplatform.cloud/Tools/Family).
  5. Click Save.
Add Permitted Pages
  1. Open the tool you just created.
  2. Click the Permitted Pages tab.
  3. Click New Tool Page.
  4. Select the page you want this tool to display on.
  5. Click Save.
  6. Repeat this process as necessary to add all the pages you want the tool to display on.

Configure an Existing Tool

If an existing tool is replaced by a new version with a different file name, a SPoC can contact Support or configure the tool manually.

  1. In the navigation menu, click System Setup > Tools/Actions.
  2. Open the tool.
  3. Click Edit Record.
  4. Edit the launch page (for example, ...cloudapps.ministryplatform.cloud/Tools/Family).
  5. Click Save.

Tool Configuration Settings

These configuration settings control various aspects of tools, and you can edit them.

Note: Most applications reset and reload new settings after 24 hours. As a result, your configuration setting changes may not take effect immediately.
CORETOOLS, AgeGroupMemberRoleID
Specifies the default group role ID for the age/grade group added by the Add/Edit Family Tool.
TOOLS, AgeGroupTypeID
The Add/Edit Family Tool will use groups with this type in the Age or Grade Group drop-down list.
CORETOOLS, AllowAddFamilyDonorCreation
No description.
TOOLS, BackgroundCheckCallbackPassword
Background check callback: basic auth password.
TOOLS, BackgroundCheckCallbackUsername
Background check callback: basic auth username.
CORETOOLS, BankOneNameID
No description.
TOOLS, CertificationsApiKey
Private API key provided by certifications provider such as MinistrySafe for interacting with their API.
TOOLS, CertificationsTestMode
When set to true, this configuration setting directs certification requests to the testing or staging environment for MinistrySafe.
CORETOOLS, DefaultAddPaymentTypeID
The default payment type to be selected by the Add Payment tool.
TOOLS, EnableStockImages
When set to true, this enables the stock image search on the Template Editor tool. The default value is false.
CORETOOLS, GMapsAPI
Optional; used by the Contact Log tool.
CORETOOLS, gridPageSize
No description.
CORETOOLS, PortalPath
No description.