Redirecting to default login.. Resware to Resware Partner Mapping
  1. Home
  2. Features
  3. Resware to Resware Partner Mapping
Searching...

Resware to Resware Partner Mapping

Contents

Overview

This demonstrates how to set up Resware to Resware partner mappings between two offices or Resware instances to send orders from one to the other. A common use for setting up Resware to Resware partner mappings for two offices within the same installation of Resware is when there are two separate offices that perform different functions on the same order (e.g.

One office handles the title side and one office handles the escrow side). Resware can receive the order from the client in the title office and send the order to the escrow office automatically; creating the order in the escrow office does not have to be done manually.

Version History

Version

Date

Mantis

Description

Pre 9.0

02/15/2021

 

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(s)

A partner is needed that can be used independently for each office to send and/or receive order information in Resware. If the same installation of Resware will be sending and receiving orders between two separate offices, then both the sending and receiving partners will need to be created.

In this article, the example provided will show two partners created. The first partner will be the receiving partner as a client partner type in a search office designated as office 1. The second partner will be the sending partner as a search partner type in a title company office designated as office 2. Each partner will utilize the Resware to Resware Partner Mapping functionality to send and receive information between each office within the same installation of Resware.

Admin/Partners

  • Click New.
  • Enter the Company Name.
  • Set the Partner Type. NOTE: Set as Client to receive orders.
  • 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, Save.

Office 1: Receiving Partner (client)

Office 2: Sending Partner (any partner type)

Create Partner Employee(s)

Create a partner employee on each partner created and grant the employee the appropriate website roles.

Admin/Partners

  • Highlight the partner created above and click New in the partner employee area.
  • Enter a First Name such as XML integration services.
  • Enter a valid Email Address.
  • 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 XMLClient.
  • 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.
  • Uncheck Use 2FA. Two-factor authentication is not applicable with this automated functionality.
  • In the Website Roles area, enable the roles for the items needed.

NOTE: It is recommended as a best practice to only enable the roles specific to the services that are specifically provided.

  • In the Office Access area, check Access for the office(s) where services will be provided. Optionally, check Default if an office will be the primary office.
  • Click Save.
  • Repeat steps to create an employee for the sending partner type.

Office 1: Receiving Partner (client partner)

Office 2: Sending Partner (any partner type)

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.

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 utilized in the setup of the Resware to Resware mapping for the remote installation or provided to an integration partner, when applicable, which allows the documents to be returned to Resware on the file’s Documents panel.

Document Types

Admin/Documents & Templates/Document Types

When using the Note/Document service in Resware to Resware partner mapping, documents with mapped document types can be sent to a remote system. If document types do not already exist that can be used, then follow these steps to create new document types. Make note of the DocumentTypeID‘s to provide to the remote Resware system or third-party partner.

  • Click Add.
  • Enter the Document Type.
  • Verify that the Default to Internal Only option is unchecked.
  • Verify that the Default to Secured option is unchecked.
  • In the Website area, check the Allow upload for Partner Types option.
    • Either check All for all partner types.

OR

  • Check Select and click on Edit to choose which partner types can upload documents of this type.
    • Click Add.
    • Highlight the partner types, then click Add.
  • Click Save.

Action Events

Create Action Event

Admin/Action Lists/Action Events

When using the Action Event service in Resware to Resware partner mapping, actions events can be sent and received to and from a remote system to facilitate, through XML, additional functionality or services on a file. If action events do not already exist that can be used, then follow these steps to create new action events.

  • Click Add and enter the Name.
  • Click Save, Close.

Create an Action Affect to Send an Action Event

Admin/Action Lists/Action Groups/Edit Actions

An action affect must be used on an action to send action events. Select an existing action on an action group or add an action to an action group, then follow these steps to add an action affect.

  • Highlight the action that should send the action event and click Edit Affects.
    • Click Add in either Start Task Marked Done Affects or Complete Task Marked Done Affects.
      • In the 5 – Marking Done Sends XML area:
        • Select Resware: Send Action Event.
        • Select the appropriate Send To: partner type. This is the partner type of the partner created above.
        • Select the action event that should be sent to the remote Resware system.
    • Click Save, Save.

Create a Trigger to Receive an Action Event

A trigger must be set up to receive action events from another file or remote system. Select an existing action group or add an action group, then follow these steps to add a trigger. The received action event trigger can then be set up to create an action, create a group, start or complete an action, and/or define a value when a task is completed on a file.

Admin/Action Lists/Action Groups/Edit Triggers

  • Highlight the action group that should receive the action event and click Edit Triggers.
    • Click Add.
      • Select the XML: Received Action Event trigger.
      • Select the Action Event that should affect the trigger.
      • Optional: External triggers can be optional.
      • Select at least one affect or section to save the affect. The numbering of the sections is indicative of the order in which the sections will be executed. For further information on triggers, see the help in Resware or the Actions article available in the customer portal.
        • 1 – Marking Done Creates Action: This creates an action dynamically.
        • 2 – Marking Done Created Group: This creates an action group dynamically.
        • 3 – Marking Done Affects: This is used to affect an existing action.
        • 4 – Marking Done: This allows a value to be set when.
    • Click Save, Save.

Resware to Resware Partner Mapping

If Resware to Resware mappings are being utilized between two offices in the same Resware installation, two partner mappings will need to be created: One for the sending office partner and one for the receiving office partner.

Order Placement

The Order Placement Service Type needs to be set up for any partner that will be sending orders to Resware.

  • Click Add, then click Select to search for the partner added in the prior step.
  • Enter the Username. This is the username of an employee of the partner on the remote Resware system or office. If this is a third-party partner integration, this will be provided by the partner.
  • Enter the Password. This is the username of an employee of the partner on the remote Resware system or office. If this is a third-party partner integration, this will be provided by the partner.
  • Set the Service Type as Order Placement.
  • Enter the URL. Sample URL: https://client.com/OrderPlacementService/v4/Service.svc

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

  • Enter the Client ID. This is the ID of the client on the remote Resware system. If an admin user does a search for this client in Admin/Partners on the remote Resware system, this is the SystemID.
  • Enter the OfficeID. This is the office where orders will be place in the remote Resware system.
  • Set the Service Version. This is the service version that will be sent. The highest version available in both Resware installations should be the version used. If setting to a third-party partner integration, use the version in their instructions.
  • Check the box for Don’t Send Sales Price or SSN’s to prevent sending sensitive information.

Client Mapping (optional)

This is only needed if the client on the source file should appear as the client’s client on the remote file.

  • Click Add to select the Client. This is the client in the sending system. The selected client will map to a client’s client in the remote Resware system. When sending an order, if the client is not mapped, the remote system will not set a client’s client on the file.
    • Set the Remote ID. This is the ID of the client’s client in the remote Resware system to which the client should be mapped. In version 9.7 and higher, this will be set by default with the source client’s ID.

Transaction/Product Type Mapping

This is used to map the transaction/product types from the sending system to the receiving system.

NOTE: When using this functionality to communicate between two files in the same Resware installation, RemoteID’s will automatically be populated and will not need to be changed, since transactions and products are shared between offices in the same instance of Resware. Click Add to create a transaction/product type pair.

  • Select the Transaction Type. This is the transaction type in the sending system.
  • Select the Product Type. This is the product type in the sending system.
  • Set the Remote Transaction ID. This is the ID of the corresponding transaction type in the remote Resware system. In version 9.7 and higher, this will be set by default to the source ActionListTransactionTypeID.

NOTE: The Resware admin for the remote Resware installation can find this ID by navigating to Admin/Action Lists/Transaction Types and showing the ActionListTransationTypeID column.

  • Set the Remote Product ID. This is the ID of the corresponding product type in the remote Resware system. In version 9.7 and higher, this will be set by default to the source ActionListProductTypeID.

NOTE: The Resware admin for the remote Resware installation can find this ID by navigating to Admin/Action Lists/Product Types and showing the ActionListProductTypeID column.

  • OptionalID’s. This is a space-delimited list of optional action group ID’s that can be ordered on the remote Resware system for this transaction/product type. If both ID 1 and 2 can be ordered, enter 1 2.

Or

  • Click Add All to add all the transaction/products that have not already been added. The RemoteID’s will be defaulted to the source transaction/products.

NOTE: These may need to be edited to update with the remote Resware SystemID’s.

Underwriter Mapping (optional)

This is only needed if the file on the remote system should be forced to use a specific underwriter.

  • Click Add to set an individual underwriter.
    • Set the Underwriter. This is the underwriter in the sending system. When sending an order, if an underwriter is not mapped, the remote system will not receive an underwriter for the file and will choose an underwriter based on the remote system’s settings.
    • Set the Remote ID. This is the ID of the underwriter in the remote Resware system to which the underwriter should be mapped. In version 9.7 and higher, this will be set by default to the source SystemID.

NOTE: The Resware admin for the remote Resware installation can find this ID by navigating to Admin/Partners, searching for the underwriter partner, and showing the SystemID column.

Or

  • Click Add All to add all of the underwriters that have not already been added. The RemoteID will be defaulted to the source partner’s SystemID.

NOTE: This may need to be edited to update with the remote Resware SystemID.

Primary Contact Mapping

This is used to map the internal user receiving the order to the primary partner employee that is sending the order in the remote system.

  • Click Add to set the internal user that is the main contact.
  • Enter the Remote ID as the primary partner employee’s SystemID. In version 9.7 and higher, this will be set by default to the InternalUserID.
  • Default. Check this to make this internal user the default primary employee of the client for files created in the remote Resware system. Only one contact per partner can be set as the default.

Or

  • Click Add All to add all the internal users that have not already been added. The RemoteID will be defaulted to the source internal users’ InternalUserID’s.

NOTE: This may need to be edited to update with the remote Resware primary partner employees’ SystemID’s.

  • Click Save.

Action Event

This is used when actions need to be affected in the remote system. For example, if an action needs to be created, started, or completed in the remote system, an action event in the source system will need to be created. An action trigger will also need to be created in the remote system to receive the action event and affect the desired action. If actions will not be created or affected in the remote Resware system, then action events do not need to be mapped. Action events need to be created prior to mapping (see the section above).

The action event service type needs to be set up for any partners that will be sending action events to a remote Resware system.

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

Action Event Mapping

  • Click Add to set an action event.
    • Enter the Code as the ActionEventDefID from the action event from the remote Resware system’s action event. In version 9.7 and higher, this will be set by default as the source ActionEventDefID.

Or

  • Click Add All to add all the action events that have not already been added. The Code will be defaulted to the source action events’ ActionEventDefID’s.

NOTE: This may need to be updated with the remote Resware’s ActionEventDefID’s.

File Info

This service is used to send some file information to a partner. The information included is the estimated settlement date, actual settlement date, disbursement date, sales price, and the loan amount.

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

Note/Document

This service is used for sending notes and/or documents to a partner in a remote system. A document mapping will need to be set up for each type of document that will be sent to the remote system. The Resware admin for the remote system will need to go to Admin/Documents & Templates/Document Types and get the DocumentTypeID for each document type that will be sent to the remote system.

Admin/Partner-Related/Resware to Resware Partner Mappings

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

  • Set the Coordinator Type ID. This is the coordinator type on the file in the remote system to which the notes and documents will be assigned. It is set to 1 unless otherwise specified.

NOTE: This can be overridden by other entities in the remote system. (see help section for further information)

  • Sanitize Note Body (visible if HTML is disabled in Resware): If enabled, Resware will remove any HTML from the note body before sending.
  • Sanitize Note Body HTML(visible if HTML is enabled in Resware): If enabled, Resware will remove any HTML from the note body before sending.
    • Clean XML From Body (visible if HTML is enabled in Resware): If Sanitize Note Body HTML is enabled and Clean XML From Body is enabled, Resware will remove any XML from the note body before sending.

Document Type Mapping

  • Click Add to add a Document Type.
  • Enter the Remote ID as the DocumentTypeID. In version 9.7 and higher, this will be set by default to the source’s DocumentTypeID.

Or

  • Click Add All to add all the document types that have not already been added. The RemoteID will be defaulted to the source document types’ DocumentTypeID’s.

NOTE: This may need to be updated with the remote Resware’s DocumentTypeID’s.

  • Click Save.

Search Data

This service is used to send search data to a partner in a remote system. This does not need to be set up to receive search data from a remote Resware installation.

Admin/Partner-Related/Resware to Resware Partner Mappings

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

  • Service Version: If set, this is the version of the service that will be sent to the remote system. This is for backwards compatibility and is used when a remote system uses an older version of Resware. It should be set to the highest service version available in the remote system. If this is not set, service version v1 will be used. If it’s not set to V2, the BookPageSourceTypeID sent will always be 1, which is usually book/page for most customers. 
  • Send bold, italics, and underlines in lien and easement languages (visible if the Resware option for Allow HTML for Easements, Restrictions, Liens, Requirements, and Recording Documents is enabled): If checked, bold, italics, and underlines in the lien, requirement, easement, and restriction language will be sent to the remote system.

Lien Type Mapping, Requirement Type Mapping, Easement Type Mapping, & Restriction Type Mapping

The mapping of liens, requirements, easements, and restrictions are done in separate grids on this panel, however, the process is the same. Therefore, the instructions will be shown for liens and can be repeated for requirements, easements, and restrictions.

  • Click Add to add a Lien Type.
  • Enter the Remote ID as the LienTypeID. In version 9.7 and higher, this will be set by default to the source’s LienTypeID.

Or

  • Click Add All to add all the lien types that have not already been added. The RemoteID will be defaulted to the source lien type’s LienTypeID’s.

NOTE: This may need to be updated with the remote Resware’s LienTypeID’s.

The following chart shows the Remote ID types:

Type

Remote ID

Lien

LienTypeID

Requirement

LienTypeID

Easement

EasementTypeID

Restriction

EasementTypeID

Signing

This service is used for partners who will be sending signing information to a remote system. Signing types will need to be mapped. If signing data will not be sent, this does not need to be set up.

This service needs to be set up to send signing data to a partner. This does not need to be set up to receive signing data from a remote Resware installation.

Admin/Partner-Related/Resware to Resware Partner Mappings

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

Signing Type Mapping

  • Click Add to set a Signing Type.
    • Enter the Remote ID as the SigningTypeID. In version 9.7 and higher, this will be set by default as source’s SigningTypeID.

Or

  • Click Add All to add all the signing types that have not already been added. The Remote ID will be defaulted to the source signing types’ SigningTypeID’s.

NOTE: This may need to be updated with the remote Resware’s SigningTypeID’s.

Signing Complete

This service is used to send signing complete updates to a partner. No mapping is necessary for this service.

NOTE: The URL needs to point to a secure site (https). client.com is replaced with the remote partner’s web address.

Add Action Affects

The following steps will show how to create action affects. Affects can be added to the workflow to initiate sending XML to a remote Resware installation.

Admin/Action Lists/Action Groups

  • Highlight the action group that will contain the action that should send the XML task 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:
    • Set XML such as ResWare: Send Order. 
      • NOTE: Other options include:
      • Resware: Send File Info
      • Resware: Send Search Data
      • Resware: Send Signing
    • Set Send To such as Searcher
  • Click Save.

For action events, highlight the action group that will contain the action that will send the action event and click Edit Actions.

  • Highlight the action that will be used to send the action event 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 Action Event.
    • Send To: Searcher
    • Action Event: Select the action event from the dropdown menu.
  • Click Save.
  • Repeat the above steps for each action event set up for this integration.

Examples on a File

Office 2: Sending Partner (any partner type)

Any partner type can send an order request to a remote system if they are on the file and set up to use the order placement service. The partner must be on the file prior to sending the order request.

Placing an Order

File/General

Verify that at the partner is on the file to successfully send and order. If not:

  • Click Add Partner to add the partner as needed.

Office 1: Receiving Partner (client)

In the office that receives the XML order, the General panel has the file number from the office that sent the order set as the Client’s File #, the File Origin displays XML, and the Opened By field displays the employee that placed the order.

XML Activity

File/XML

  • Select the XML Message to send an XML request, then click Send.

The initial order request message will be returned from the remote Resware system showing the file number created.

This panel shows activity from the initial order placement to the documents being returned from the remote system via manual order or from an action affect.

Automated XML

An XML message can also be set up to be sent via an affect of an action in the workflow.

NOTE: This process is similar for sending any of the XML events such as action events, file info, order, search data, search data, and signing.

File/Notes

Notes and documents are sent via XML in the same manner that they are normally sent. Notes and documents are not sent from the XML panel. To send a note, go to the Notes panel. A note will be sent via XML if the partner has the Enable XML Transmission of Notes and Documents flag set on their profile.

File/Documents

To send a document, go to the Documents panel or attach a document while sending a note.

NOTE: If the XML transmission of the note or document fails, a message will display on the Tasks tab on the user’s home page.

  • Click on Click in the Detail column for information on why the XML failed.

These panels show any notes and documents that are returned by the remote system.

Updated on January 5, 2022

Need Support?

Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Submit a Support Request