Overview
Demonstrates how to set up and use the Black Knight Tax Data for Title & Settlement (TTS) integration. This integration allows users to order up-to-date information on delinquent and current taxes. Details include amounts, due dates, lien status, contact information, and limited liability coverage. This integration can send and receive notes and documents to and from the file. Users can also send and receive action events through their workflow.
Begin here: Contact Black Knight by email at sales@bkfs.com for further information or to register for services. Inform the Black Knight consultant that the account will be for a Resware integration. Account information will be provided, including a username and password for the Resware-to-Resware partner mapping setup. Black Knight will schedule a call to review requirements for a successful collaboration.
Next: Complete the following set up steps.
Next: Provide Black Knight the username and password for the Black Knight partner employee, DocumentTypeIDs, and ActionEventDefIDs created to use for this integration.
Then: Test.
Version History
| Version | Date | ID | Description |
|---|---|---|---|
| 8.26+ | 04/05/2021 | 2023418 | Information and screenshots created in version 9.12 |
Enable Office Option
Admin/General Setup/Offices/Web Services
- Highlight the office using this integration and click Edit.
- Click to enable the Enable Resware to Resware Order Submission office option.
Add XML on Products
The Resware XML package must be added to each product that will use this integration.
Admin/Action Lists/Product Types/XML
- Click Add and select the Resware XML package.
- Click OK.
- Click Save, Close.
Create Partner Type
Admin/Partner Related/Partner Types
- Click Add.
- Set the Name to Tax Data Search.
- Set the Max Per File to 1.
- Select None as the Locale Restriction, which is the default.
- Click Save.
Create a Black Knight Tax Partner
Create a partner to use with this integration. This partner will need to be added to each file that will use this integration. It can be added to files automatically by adding the partner type to auto-add on the action list or by having another partner auto-add it, or it can be manually added to files as needed.
Admin/Partners
- Click New.
- Enter the Company Name as Black Knight Tax Search.
- Enter the partner’s information and set the Partner Type as Tax Search.
- Click XML Config and check both Enable XML Transmission of Notes and Documents and Don’t Also Send Notes and Documents via Email, then click Save.
- Click Save.
Create a Black Knight Partner Employee
Admin/Partners
- Highlight the partner edited above and click New in the partner employee area.
- Enter the First Name as Black Knight integration services.
- Enter the Email Address as AskBlackKnight@BKFS.com.
- Set the employee as the Primary Contact.
- Click Enabled in the Website Access area, which allows the web/API services to be utilized.
- Click Override Username and enter a Username such as BKFStax.
- Click Generate to populate a Password. This will ensure company-specific password requirements are met. Write down this password to use in the validation step.
- In the Office Access area, check Access for the offices where services will be provided. Optionally, check Default if an office will be the primary office.
- Click Save.
Note: The email, username, and password for the employee will need to be provided to Black Knight to ensure that documents are returned to Resware and that Black Knight can obtain the status of actions.
Password Validation
Website
After a password is set or reset for a partner employee, the employee is required to enter a new password the next time they access the website. To ensure this integration is set up correctly, log into the company’s Resware website with the username and password created in the previous step, and create a new password. Provide this new password to Black Knight. Note: This password is also used as the password for the Resware to Resware partner mapping password.
Note: It may be beneficial to set the expiration date of this password on the partner employee setup for an extended period. Check with company-specific password security protocols to verify that this will be acceptable or have a reminder in place to update this password as needed to ensure this integration’s service will not be interrupted.
Note: The Username and Password will need to be provided to Black Knight, which allows the documents to be returned to Resware on the file’s Documents panel.
Document Types
A Tax Statement document type may be used for this integration. This is a default document type (DocumentTypeID 9). If a different document type will be used that does not already exist, then follow these steps to create one. Make note of the DocumentTypeIDs and provide to Black Knight to return documents.
Admin/Document and Templates/Document Types
- Click Add.
- Enter the Document Type as BKFS Tax Report.
- Verify that the Default to Internal Only option is unchecked.
- In the Website area, check the Allow upload for Partner Typesoption.
- Either check All for all partner types.
- OR
- Check Select and click on Edit to choose which partner types are allowed to upload documents of this type.
- Click Add.
- Highlight the partner types, then click Add.
- Click Save.
Create Action Events
The following step creates action events in Resware to facilitate, through XML, providing additional notifications on a file. Black Knight will accept the following action events in this integration. These action events can be named as needed provided the ActionEventDefID (Code) is provided to Black Knight.
| Resware ActionEventDefID /Code | Name | Note |
|---|---|---|
| Order complete | Optional | |
Order update | Optional, or can be set to the Order complete code. | |
| Status update | ||
| Fee approval | Optional, can be set to the Status update code. | |
|
| Property verification | Optional, can be set to the Status update code. |
Admin/Action Lists/Action Events
- Click Add and enter the Name such as BK tax order complete.
- Click Save.
- Repeat steps to add the events from the list above to add to the workflow and this integration.
Note: For each action event created, enter the ActionEventDefID in the table above and provide to Black Knight. If the column is not visible in the grid, right-click in the grid to show the column.
Resware to Resware Partner Mapping
Order placement
Admin/Partner-Related/Resware to Resware Partner Mappings
- Click Add, then click Select to search for the partner added in the prior step.
- Enter the Username and Password as provided by Black Knight.
- Set the Service Type to Order Placement.
- Enter the URL as https://www.propertytaxdirect.com/Services/Resware/v4/Service.svc.
- Enter a 1 as the Client ID
- Enter a 1 as the OfficeID
- Set the Service Version to v4.
- Check the box for Don’t Send Sales Price or SSNs.
- Click Add All in the Transaction/Product Type Mapping area.
- Click Yes to set the remote IDs to the transaction types’ and product types’ IDs.
- Click Save.
- Click Add in the Primary Contact Mapping area and select the internal user that is the main contact.
- Set the Remote ID to the InternalUserID.
- Check the Default option.
- Click Save, Save.
Note: Black Knight does provide an environment for initial setup to test prior to launching to production. Replace the beginning of each URL with https://test.propertytaxdirect.com for each Order Placement, Note/Document, and Action Event service to use the test environment.
Action events
- Set the Service type to Action Event.
- Enter the URL as https://www.propertytaxdirect.com/Services/Resware/ActionEventService.svc.
- The Action Event Mapping area maps action events available to send to Black Knight. Each action event also needs to be added as an action in the workflow.
- Click Add.
- Select an Action Event.
- Enter the Code as the ActionEventDefID from the list in the prior step.
- Click Save.
- Repeat for each action event.
- Click Save.
Add Action Affects
The following steps will show how to create action affects. These can be added to the workflow to initiate the order with Black Knight or to send action events to Black Knight.
Admin/Action Lists/Action Groups
- Highlight the action group that will contain the action that should send the search and click Edit Actions.
- Highlight the action that should be used to send the request and click Edit Affects.
- Click Add in the Complete Task Marked Done Affects area.
- In 5 – Marking Done Sends XML, select the following:
- XML: Resware: Send Order
- Send To: Tax Data Search
- Click Save.
Add External Triggers for Action Events
The following steps will show how to create external triggers that will affect actions. These can be added to the workflow when Black Knight send action events to the file.
Admin/Action Lists/Action Groups/Edit Triggers
- Highlight the action group that will contain the action that will be affected click Edit Triggers.
- Click Add and select the function such as Search Data Added.
- In 1 – Marking Done Creates Action,select the following:
- Group: Black Knight Tax Data Search.
- Action: Order Complete
- Click Save
- Repeat these steps for any Black Knight action events (see optional action events in prior step) added and used for notification purposes.
- Click Save.
Examples on a File
File/General
Verify that at the Black Knight partner is on the file to successfully order a product. If not:
- Click Add Partner to add the Black Knight partner as needed.
Manual order placement
File/XML
- Select the XML Message to send an order request, then click Send.
A successful message will be returned from Black Knight showing the Black Knight file number created.
Automatic order placement
File/Actions
The Black Knight partner must be on the file to send order requests.
- Highlight the action being used to send the search request to Black Knight and click Mark Completed.
The search document(s) will be returned from Black Knight and added to the file when complete.
Action events
File/Actions
The workflow will show activity when notes and documents are returned by Black Knight.
XML activity
File/XML
This panel shows activity from the initial order placement to the documents being returned from Black Knight via manual order or from an action affect.
Search data
Search Data/Chain of Title/Taxes
Black Knight will populate this panel with the tax information related to the property for this file.
Documents
File/Documents
This panel will show any documents that are returned by Black Knight.
