Church Community Builder (CCB) Setup Background Screening using CCB Application Programming Interface (API)

Transcription

1 Church Community Builder (CCB) Setup Background Screening using CCB Application Programming Interface (API) Here is a summary/checklist of the steps required to enable background screening integration. A detailed procedure follows, with examples. 1. Sign in to CCB 2. Navigate to System Settings for API 3. Add a New API User for automated integration with background screening 4. Grant access for the new API user, to selected CCB Services 5. Confirm whether CCB custom text fields 11 and 12 are available for use by integration 6. Forward the following to your integration services representative a. Your API URL b. New API user login credentials (Username and Password) You will need Adminstrator rights in CCB to complete the following procedure. If you do not have Adminstrator rights, you will need bring this procedure to the person(s) at your site with that access, obtain their assistance to complete the procedure. to and 1. Sign into CCB, using an administrator account. Locate the "gear" symbol in the upper-right of the CCB window. Select this symbol, and then select API from the resulting pop-down 2. You should now see a page that has a Summary tab and a Users tab. On the Summary tab is Your API URL. Copy/paste this URL to a document or a new message. You will forward this to your services representative at the end of this procedure 3. Next, click the Add a new API User button under Actions. This brings you to a form where you enter the user information. Copy and paste from below in this document if able, and click Save when finished. Write the password down in another document or in an , and then copy and paste it into the new cloudmills APIs User, so that you can forward it to me along with your CCB hostname URL. Choose a random string of characters for the password, including upper and lower-case letters, numbers, and a few special characters from the following list:!@$%*.,?-_+=: 1 Page

2 CloudMills Integration Services cloudmills -password- 4. CloudMills Bradley Rhine (510) At the top of the the API User Information form is another tab called Services. Once the API is created, proceed to grant this access by check-marking individual services. This grant deliberately limited to only those features that are required by integration. When finished, be to click the Save button user user list is sure 6. If you know which custom fields are in use at your site, please forward this information to your services representative. If you do not know, your services representative will use the new API user credentials to look up this information for you 2 Page

3 7. That's it! Forward Your API URL, the API Username and the API Password to your services representative, being careful to protect the password from disclosure to others Additional Information - What to Anticipate Once integration is enabled on your instance of CCB, you may begin to notice some new features in the application. The following is a summary of the changes that happen with screening integration enabled, and what happens when a background screen is initiated. Integration places its visible features on the Individual Person Profile page, near the bottom, under Custom Fields. Once your integration is enabled, you will see two specific Custom Field element labels: Backgrnd Screen and Screen Result. Custom Field labels are limited to only 15 characters in CCB, which is the reason for the abbreviation. These fields may be in a different sequence, but should be close to each other. The following images provide examples. The screening integration convention is to use text custom fields 11 and 12. If these are not available, alternatives will be chosen. 3 Page

4 Screening integration performs an initialization step, which generates an individualized URL for each person. This URL is then stored on the Backgrnd Screen field. This Order Now URL allows an administrative user to open a Background Screen Order form. 4 Page

5 Background Screen Order form image Once an order is submitted, the screening application returns a status of App-Pending, which is then displayed on the Screen Result custom field. 5 Page

6 Finally, once the background screen is complete, a URL becomes available, which links to the report within the screening application. This link can be used as a shortcut to the report. The report link remains available in CCB for at least 30 days. After this, the custom fields may be re-initialized to enable a new background screen order in the future. Additional Information - For Technicians, About Custom Fields The following commands provide examples of how to check the CCB Custom Fields configuration, and how to change this configuration. These commands use standard features of the CCB API, and are representative of the steps your services representative will perform to enable screening integration on CCB. {user}:{password} are replaced with actual API Username and Password for the CCB instance {your-host} is replaced with the actual URL hostname for the CCB instance 6 Page

7 CLIENT SPECIFIC PULL OF CUSTOM FIELDS 1. Read existing Custom Field configuration curl -u '{user}:{password}' \ -X GET ' 2. Modify Custom Field configuration for use by screening integration curl -u '{user}:{password}' \ -X POST ' --data 'udf_text_11_label=screen+result&udf_text_11_admin=true' curl -u '{user}:{password}' \ -X POST ' --data 'udf_text_12_label=backgrnd+screen&udf_text_12_admin=true' <name>udf_ind_text_4</name> <label>cst Score</label> <name>udf_ind_text_5</name> <label>backgrnd Screen</label> <name>udf_ind_text_6</name> <label>screen Result</label> <name>udf_ind_text_7</name> <label></label> 7 Page