Login

Articles in this section

Yardi (7s or higher) Integration

Overview

Updater is a qualified integration of yardi.  This document contains:

  1. Yardi 7S requirements
  2. Instructions on how to integrate Updater directly with Yardi 7S
  3. A breakdown of what resident information is required to create an Updater invite
  4. An explanation of how we create invites based off of specific resident information

Once the integration is configured, we connect on a daily basis and programmatically pull information for any new residents that are moving into your properties.  We then use that information to create Updater invites for each resident.

Yardi 7S requirements

  1. Voyager 7S with interfacesPlv24.1, InterfacesILSGuestCardPlv23, and interfacesCommonDataPlv21 (although v19 works) or higher are required to complete integration
    1. Your Yardi account manager can determine if you have the correct interfaces Plug-in version and assist you with implementation if needed.
  2. You must have System Administrator access to complete this setup

Setup

  1. Contact Yardi Technical Support to obtain Updater add-on package
    1. Load the vendor package to add Updater into your Voyager database
  2. Download Yardi Interface Setup Guides from Yardi Client Central

    Voyager Core Administration and Setup Guide

    ILS Guest Card Interface Setup Guide

    Common Data Interface Setup Guide

  3. Use the guides above to configure each interface or contact your Yardi account manager for assistance. 

Using Yardi Documentation

  1. Start by creating a property list of all properties named "Updater Property List"

Documentation 'Voyager Core Administration and Setup Guide'

  1. Note: We will never invite residents from properties that aren't approved
  2. Configure Updater Vendor for ILS/Guest Card Interface

Documentation 'ILS/Guest Card Interface Setup Guide' > 'Vendor Configuration' (Chapter 2) > 'Vendor Configuration for ILS/Guest Card'

  1. Go to "Interfaces" from the side menu, select "Configuration", select "Review Interface Vendors"
  2. Choose "ILS/Guest Card" from Entity Type drop-down
  3. Submit
  4. Select Updater from the available vendors list
  5. Select the following ILS/Guest Card Options:
    1. Activity in the last: 30 days
    2. Schema: v4.0
    3. Floor plan: Unchecked
    4. Export all guest cards: Checked
    5. Export federal identification: Unchecked
    6. Update prospect agent: Unchecked
    7. Import/Export Types: Select All for both tenant and prospect
  6. Save

Setup Interface User for Updater

Documentation 'ILS/Guest Card Interface Setup Guide' > 'Vendor Configuration' (Chapter 2) > 'Interface User Setup'

MORE INFO: 'Voyager Core Administration and Setup Guide' > 'Adding, Reviewing and Editing Security Groups'

  1. Create menu set for interfaces
  2. Create security user group
  3. Link user group to menu set
  4. Set permissions as follows:
    1. Permission level: Most Restrictive
    2. Access type: Read/Write
  5. Configure Properties for Updater

Documentation  'ILS/Guest Card Interface Setup Guide' > 'Property Interface Configuration' (Chapter 3) > 'Bulk Property Configuration"

  1. Select "Interfaces", select "Configuration", select "Bulk Property Configuration"
  2. Select the property list you created for Updater
  3. Select interface type "ILS/Guest Card"
  4. Select Updater from "Available Agencies"
  5. Save
  6. Access type: Read/Write 
  7. Configure Updater Vendor for Common Data Interface

Documentation: 'Common Data Interface Setup Guide' > Vendor Configuration (Chapter 2)

  1. Go to "Interfaces" from the side menu, select "Configuration", select "Review Interface Vendors"
  2. Choose "Common Data" from Entity Type drop-dow
  3. Adjust 'Display Rows' to 500
  4. Submit
  5. Select Updater from the available vendors list
  6. Select the following Common Data Configuration settings:
    1. Ignore Exclude Units Flag: Unchecked
    2. Export Document Number: Unchecked
    3. Permission Access:
      1. Name: Read
      2. Address: Read
      3. Phone Numbers: Read
      4. SSN: None
      5. Vehicle: Read/Write
      6. Ledger: None
      7. Lease Charges: None
      8. Lease Offers: Read
      9. Scheduled Lease Renewals: Read
      10. Rentable Items: None
      11. User Defined: Read
      12. Pets: Read/Write
      13. Date of Birth: None
      14. Driver's License: Read/Write
      15. Email: Read
    4. Import/Export Attachment Types (select following):
      1. Roommate Attachment
      2. Tenant Attachment
        1. If you do not see these Attachment types available, then they will need to be added
        2. From the Voyager System Administration side menu, select System > Attachment Types.  The Attachment Types screen appears.
        3. Set up an attachment type for each correspondence category that you use
        4. In a blank Object Type field, select an object type Tenant.
        5. In the corresponding Description field, type the Attachment.
        6. In a new blank Object Type field, select an object type Roommate.
        7. In the corresponding Description field, type the Attachment.
      3. Click Save
    5. Save
    6. Provide Updater with needed access credentials

This next part includes the information you'll need to share with UPdater so that we may connect to your Yardi integration, please share this information with your CSM and/or the Implementations Team.

Documentation: 'ILS/Guest Card Interface Setup Guide' > 'Web Service Setup' (Chapter 6) > 'Web Service Access'

  1. Voyager URL (Updater appends the appropriate web service extension to the Voyager URL)
    1. Example:

      Web Service URL:

      https://www.yardiasp14.com/53423cop/webservices/itfilsguestcard.asmx 

      https://www.yardiasp14.com/53423cop/webservices/itfresidentdata.asmx

       

  2. Interface username and password
    1. Example:

Interface user: Updater

Password: Companyprop1

3. Database name

    1. Example:

Live Database: knzs_live

4. Server name (SQL Server, NOT web server) 

    1. Must be exactly the same as the Database Name if Yardi-hosted

Please send Updater the following information:

  1. Yardi Web service url:
  2. Interface Username & Password
  3. Database Name
  4. Server Name

Required resident information

Creating an invite is simple, there are just a few required fields that you'll need

  • One address - The old or new address of the resident (both is better!)
  • Email address of the resident
  • First & Last name of the resident
  • A date related to the move
  • We do not access any financial or security information

How we create invites

We take into account the following info when creating invites.

  • Move-ins: Invites are created when the resident status becomes 'Approved' (upon lease execution) or 'Current'.  Including roommates.
    • We schedule the invite based on 'Move-in Date' or 'Lease From Date' depending on which is available
  • Guarantors do not received an Updater invite
  • All invites are sent -3 weeks prior to the estimated move date.

Note

As an additional step in the integration setup, you may be required to install an upgrade known as 708_ResidentiaIP17.11.  After the initial setup, our team will determine if the upgrade is required based on how your resident information is stored in Yardi.  If so, our team will detect it and we'll ask Yardi to apply the upgrade.  Yardi will contact you directly from there, ask for approval to open a ticket in Client Central, and then install the upgrade for you.  This is meant to be a one-time action.

 

 

 

 

 

 

 

Related articles