Documentation/Using the platform

Admin setup

Everything in the Setup and Admin sections of the menu: branding, global settings, users, permissions, the property table, integrations and custom insights.

All documentation pages

Everything that configures your company's account lives in the Setup and Admin sections of the left menu. Work through it in roughly this order when you first set up; come back to individual sections as your team and portfolio change.

Ask your administrator

Only Administrators can see the Setup and Admin sections of the menu. This page describes what they can change for you, so you know what to ask for.

Appearance settings

Add your logo

  1. Go to Admin → Appearance settings.
  2. Under Logo, select Choose file and upload your logo — or use your website's icon instead.
  3. Select Save.

Set chart colors

  1. In Appearance settings, go to Colors.
  2. Select a color's hex value and enter your own. Use + Add color to add one, or X to remove one.
  3. Check the pie chart preview, then select Save.

Under NavBar theme you can also switch the navigation bar between Light and Dark.

Global settings

Set the start of your fiscal year and the start of your reporting week, then select Save.

The fiscal year setting changes the whole platform

Every fiscal-year figure, for every user, follows this setting. Confirm it with your finance team before you change it.

Managing users

Admin → Manage users lists everyone in your company with their email, role, property access, status and last login. Search to find a user; select a user to act on their record.

Add a user

  1. Select Add user.
  2. Enter their first name, last name and email.
  3. Choose a role: Administrator, Editor or Viewer. See Roles & permissions.
  4. Choose their property access (see permissions below).
  5. Decide whether to email an invite and activate them now. If not, you'll need to return later and tick User active.
  6. Select Save.

Adding users in bulk

  1. On Manage users, select Export to download your current users, or Download template for a blank file.
  2. Add or edit users in the file.
  3. Select Import, choose the file, decide whether to email invitations, and import.

Editing, deactivating and deleting users

  • Edit — select the user and the pencil icon to change their name, email, role, property access or status.
  • Deactivate — untick User active. They can no longer log in, but their account and history are kept and they can be reactivated.
  • Delete — select the red trash can and confirm. Prefer deactivating unless you are sure.

Password resets

Select a user and the envelope icon to re-send their invite, which lets them set a new password. Users can also reset their own from the login page with Forgot your password?

Managing permissions

A permission defines a set of properties. Assign one to a user to control which properties they see; set one as a report's or dashboard's access restriction to control who can open it. (Older guides call this property access.)

Create a permission

  1. Go to Admin → Manage permissions and add a new one.
  2. Give it a name.
  3. Choose None, All properties, a hand-picked list, or a filter on a property attribute.
  4. Select Save.

One permission that fits every manager

Rather than one permission per property manager, create a single permission that matches each user to their own properties: filter on the Contact's email attribute and match it to the User email. Then enter each manager's email in the Contact's email column of the property table. Each manager sees exactly the properties they are listed against.

Turning on MCP access

MCP access lets users query Revolution RE from Claude or ChatGPT. It is switched on per permission:

  1. Go to Admin → Manage permissions.
  2. Select the permission and choose Edit.
  3. Tick Allow MCP access and select Save.

Everyone with that permission can now query, from Claude or ChatGPT, the properties they are already allowed to see — and nothing more.

Each user then connects their own Claude or ChatGPT account, signing in with their Revolution RE login. Their property access and permissions carry through unchanged, so they can only reach the properties they can view in Revolution RE. See Connecting Claude and Connecting ChatGPT.

Managing properties

Setup → Manage properties holds the property table — every property and its attributes. Attributes drive portfolio filters, permissions and email groups.

  • From your PMS, refreshed nightly: name, code, address, city, state, zip, latitude and longitude, country, region, PMS.
  • Entered by you: Own/Comp, alias, and any columns you add.

Add an attribute column

  1. Select Edit columns, then Add column.
  2. Name it and choose its type: text, number, date, year, yes/no, percentage or dollar.
  3. Select Save, and Save again to close. Fill in the column for each property.

For example, add a yes/no column Allows pets, tick it for the right properties, and anyone can filter the portfolio to pet-friendly properties.

Changes to PMS-fed columns don't stick

Columns that come from your PMS are overwritten every night. Edit them in your PMS, not here.

Onboarding and offboarding a property

When a property joins your portfolio:

  1. Let it arrive. Properties in your PMS appear after the nightly sync. For one that isn’t in your PMS, see Adding a property by hand.
  2. Set its attributes, such as management company, own or comp, and the date it joined your portfolio.
  3. Check its portfolios. Dynamic portfolios pick it up from its attributes; add it to static portfolios by hand. See Saving a portfolio.
  4. Check who can see it. Permissions that select properties by attribute include it automatically. Add it to any permission that lists properties one by one. See Managing permissions.
  5. Map its financials. If it brings GL codes your account tree doesn’t have yet, add them. See Updating an account tree.
  6. Check its first night of data on its property dashboards.

When a property is sold, set an inactive date rather than hiding it, so its history stays and past reports don’t change. See below.

Adding a property by hand

Select add property and enter the property type, unit count, name, street address, city, state and zip code, then save.

A property was sold: set an inactive date, don't hide it

ActionUse whenEffect
Set an inactive dateThe property is sold or transferredIts history stays in the platform, so same-store comparisons and past reports stay correct
HideYou never want to see the property in the system againIt disappears from the active view; restore it from the Hidden view

Importing and exporting

Select properties and use import or export to update attributes in bulk. Search, or filter any column by selecting its header. Property codes, used in restricted embeds, are in the Code column.

Property photos

Select the thumbnail in a property's first column and upload an image. Photos then appear on the Properties dashboard and can be added to any dashboard with an Image card set to Display property image if available.

Keeping the table current by email

Attributes that live in another system — a CRM, say — can be kept current by emailing an Excel or CSV export on a schedule. Contact support to set up the mapping. Once set, it updates on every file, as long as the file's columns don't change; if a column moves or changes meaning, the mapping needs updating.

Managing integrations

For companies that hold their own PMS integration, Admin → Manage integrations is where integrations are added, edited and suspended, financial accounts are mapped, account trees are maintained, system emails are generated, and sync and compute history are kept. Budgets, pro formas and other financials are uploaded here too.

Custom insights

An insight is a base data point used in reports. In Admin → Manage insights you can add your own:

TypeWhat it isYou set
DerivedA calculation from existing insightsID (no spaces), name, description, format, and a definition: goal, add, subtract, multiply, divide, delta or constant, plus the data points
ManualA figure you provide yourselfID, name, description, value type, dimension (none, by bedrooms, by unit type) and grain (daily or monthly)

Upload data for a manual insight

  1. Go to Admin → Insight data and select Add data.
  2. Select Generate sample input file, choose the properties, find your insight with the filter, and set how many days or months to cover.
  3. Download the template, fill it in, and drag it back in under Add data.

Custom insights appear under Datum → Custom when adding a report column.

To bring in data from an entirely separate system — marketing spend, say — ask support about ad hoc insights. Our team maps your report once, and each scheduled file updates the insight automatically.

Insight data

Admin → Insight data lists every insight in the system. From here you can add historic or custom data, download your daily insights, drill into any property or the portfolio, and go back in time to see earlier values.

Need help? Ask Merlin from Help inside the app, email support@revolutionre.com, or use Help → Submit a request.

Contact support
Text version
  1. When a property joins your portfolio, an Administrator takes it through six steps.
  2. Much of it is automatic: anything that selects properties by attribute picks it up.
  3. Then check its first night of data on its property dashboards.
  4. When a property is sold, set an inactive date in Manage properties.
  5. Its history stays, so past reports and same-store comparisons stay correct.
  6. Don’t hide a sold property. Hide is for properties you never want to see again.

Step-by-step guides

Each guide below walks through one task on screen, one step at a time. Select a step in the guide to move through it, or use the arrows. The questions under each guide answer what people most often ask about that task.

Data and insights

Using the platform / Admin setup / Data and insights

Understand insights

Learn what an insight is: the base data points, such as occupancy or average rent, that every report column, graph and dashboard is built from.

Common questions

What is an insight?

An insight is a base data point, such as occupancy, leased percentage or average rent. Every report column, graph and dashboard card is built from insights.

Where can I find a library of available data points?

When you add a column to a report, the Datum list shows every insight, grouped by category. Administrators can also browse them all in Admin → Insight data.

Where can I see the definition of a data point?

In any report, hover over a column heading. The definition appears, including how it's calculated.

How far back does property data history go?

It depends on the history your property management system provided when you were connected. Administrators can look back at earlier values in Admin → Insight data. For a specific date range, ask support.

Can I use an insight in a report or dashboard?

Yes. Add it as a report column, then show that report on a dashboard as a table or a graph.

Example use cases

  • An asset manager checks the definition and history of an occupancy insight before using it in a portfolio report.
  • An analyst confirms a property has enough history to support a trend analysis.

Using the platform / Admin setup / Data and insights

Understand custom insights

See how custom insights let Administrators add their own metrics, calculated from existing insights or uploaded, so everyone can report on them like any other data point.

Heads-up: Manage insights is now under Admin in the left menu.

Common questions

What is a custom insight?

A metric your company adds on top of the standard insights. There are two kinds: derived, a calculation from existing insights, and manual, figures you upload.

Who can create custom insights?

Administrators, in Admin → Manage insights. Once created, anyone who builds reports can use them.

Where do custom insights appear in reports?

Under Datum → Custom when you add a report column.

Can I bring in data from another system, like marketing spend?

Yes. Ask support about ad hoc insights. The team maps your file once, and each scheduled file then updates the insight automatically.

Example use cases

  • An asset manager wants a revenue-per-occupied-unit metric that isn't in the standard list.
  • An operations lead wants renovation counts, kept in a spreadsheet, reported next to occupancy.

Using the platform / Admin setup / Data and insights

Create a manual insight

Create a manual insight to hold figures your team provides itself, such as renovation counts or marketing spend, so they can be reported alongside PMS data.

Heads-up: Manage insights is now under Admin in the left menu.

Common questions

What is a manual insight?

A figure you provide yourself rather than one that comes from your PMS. You upload its values in Admin → Insight data.

What do I set when I create one?

An ID (no spaces), a name, a description, the value type, a dimension (none, by bedrooms or by unit type) and a grain (daily or monthly).

What's the difference between a manual and a derived insight?

A manual insight holds values you upload. A derived insight is calculated from insights that already exist.

How do I add values to it?

Generate a sample input file in Admin → Insight data, fill it in and upload it. See Upload manual-insight data.

Example use cases

  • A property management team tracks weekly tours from a CRM export.
  • An asset manager tracks capital project spend by month for each property.

Using the platform / Admin setup / Data and insights

Upload manual-insight data

Load values for a manual insight from a template file, for the properties and dates you choose.

Heads-up: Insight data is now under Admin in the left menu.

Common questions

How do I upload data for a manual insight?

Go to Admin → Insight data and select Add data. Generate a sample input file, fill it in, and drag it back in under Add data.

Where do I get the template?

Select Generate sample input file, choose the properties, find your insight with the filter, and set how many days or months to cover. Then download it.

Can I load historic values?

Yes. Insight data is where historic and custom data is added. Set the date range the template covers.

Can the upload happen automatically?

For data that lives in another system, ask support about ad hoc insights. Each scheduled file then updates the insight.

Example use cases

  • Finance uploads monthly capital expenditure for each property.
  • A regional manager loads quarterly resident survey scores.

Using the platform / Admin setup / Data and insights

Create a derived insight

Build a new metric from existing insights with a formula, such as a goal, sum, difference, ratio or change over time.

Heads-up: Manage insights is now under Admin in the left menu.

Common questions

What is a derived insight?

A calculation from existing insights. It updates as the data it's built from changes.

Which calculations can I use?

Goal, add, subtract, multiply, divide, delta or constant, applied to the data points you choose.

What do I need to fill in?

An ID (no spaces), a name, a description, a format, and the definition: the calculation and its data points.

Can a goal be a derived insight?

Yes. Defining a goal as a derived insight lets you use it as a column in any report.

Example use cases

  • An asset manager defines other income per unit as other income divided by units.
  • An analyst creates the gap between leased and occupied percentages as its own metric.

Using the platform / Admin setup / Data and insights

Explore unit attributes

See the details held for each unit, such as occupied or vacant, bedroom count, unit type and make-ready status, and where you can use them.

Common questions

What are unit attributes?

Details of individual units: whether each is occupied or vacant, its bedroom count, its unit type and its make-ready status.

Where can I use unit attributes?

In Unit and Lease sheets, and as the dimension of a Dimension sheet, for example unit type, bedrooms or status.

Where do unit attributes come from?

Your property management system, refreshed with the nightly sync. Correct them in your PMS.

Can I compare units across several properties?

Unit sheets cover one property at a time. To compare across properties, use a Dimension sheet by unit type or bedrooms.

Example use cases

  • A property manager checks the make-ready status of every vacant unit.
  • An analyst compares rent by bedroom count across the portfolio.

Using the platform / Admin setup / Data and insights

Explore lease attributes

See what's recorded for each lease, such as its start and end dates and status, and how to report on it.

Common questions

What are lease attributes?

The details recorded for each lease, such as its start and end dates and its status.

Where can I report on lease details?

In a Lease sheet, with one row per lease, or in a Dimension sheet grouped by lease start or end, status or move-out reason.

How do I see how many leases end each month?

Add a Dimension sheet grouped by lease end.

Where does lease data come from?

Your property management system, refreshed nightly.

Example use cases

  • A property manager reviews upcoming lease expirations to plan renewal outreach.
  • An asset manager looks at move-out reasons across the portfolio.

Properties

Using the platform / Admin setup / Properties

Hide a property

Hide a property you never want to see again, and learn when an inactive date is the better choice.

Heads-up: For a sold property, set an inactive date instead of hiding it, so same-store reports stay correct.

Common questions

How do I hide a property?

In Setup → Manage properties, select the property and hide it. It disappears from the active view.

Should I hide a property we sold?

No. Set an inactive date instead. Its history stays in the platform, so same-store comparisons and past reports stay correct.

When should I hide a property?

Only when you never want to see it in the system again, such as a duplicate or a test property.

Can I get a hidden property back?

Yes. Restore it from the Hidden view. See Restore a hidden property.

Example use cases

  • An Administrator removes a duplicate property created during setup.
  • An Administrator handling a sale sets an inactive date rather than hiding the property.

Using the platform / Admin setup / Properties

Restore a hidden property

Bring a hidden property back into the active view from the Hidden view of the property table.

Common questions

Where do hidden properties go?

To the Hidden view of the property table, in Setup → Manage properties.

How do I restore a hidden property?

Open the Hidden view, select the property and restore it. It returns to the active view.

Who can hide or restore properties?

Administrators, because the property table is in Setup.

Example use cases

  • An Administrator restores a property that was hidden by mistake.
  • A property comes back under management and needs to reappear in reports.

Using the platform / Admin setup / Properties

Add a property attribute

Add a column to the property table, such as Allows pets or Fund, so everyone can filter, group and set permissions by it.

Common questions

How do I add a custom field to my properties?

In Setup → Manage properties, select Edit columns, then Add column. Name it, choose its type, save, and fill it in for each property.

What types of attribute can I add?

Text, number, date, year, yes/no, percentage or dollar.

What can I do with an attribute?

Filter the portfolio, build dynamic portfolios, create permissions and group rows on Property sheets. A contact column also becomes an email group.

Why did my change to a PMS column disappear?

Columns that come from your PMS are overwritten every night. Edit those in your PMS. Only the columns you add keep your edits.

Can I fill in attributes in bulk?

Yes. Export the property table, update it, and import it again.

Example use cases

  • An asset manager adds a Fund column so reports and portfolios can be filtered by fund.
  • An Administrator adds a Regional Manager email column to drive an email group.

Using the platform / Admin setup / Properties

Manage property attributes

Rename, hide or delete the attribute columns you've added to the property table.

Common questions

How do I rename an attribute column?

In Setup → Manage properties, select Edit columns, change the column's name, and save.

Can I hide a column without deleting it?

Yes. Hiding keeps the column and its values but takes it out of view.

What should I check before deleting an attribute?

Whether any portfolio, permission or email group uses it. Deleting removes the column and its values.

Can I edit columns that come from my PMS?

Their values are overwritten every night, so change them in your PMS.

Example use cases

  • An Administrator renames a column from Mgr to Regional Manager.
  • After a reorganisation, an Administrator removes columns nobody uses.

Using the platform / Admin setup / Properties

Add property photos

Upload a photo for each property so it shows on the Properties dashboard and in image cards.

Common questions

How do I add a photo to a property?

In Setup → Manage properties, select the thumbnail in the property's first column and upload an image.

Who can add property photos?

Administrators, because the property table is in Setup.

Where will the photo show up?

On the Properties dashboard, and on any dashboard with an Image card set to Display property image if available.

Example use cases

  • Marketing adds exterior photos so investor dashboards look polished.
  • An asset manager wants each property easy to recognise on its dashboard.

Using the platform / Admin setup / Properties

Find where property photos appear

See where a property's photo shows up once it's uploaded.

Common questions

Where do property photos appear?

On the Properties dashboard, and in any Image card set to Display property image if available.

Why don't I see a photo for my property?

No photo has been uploaded for it yet. Ask your Administrator to add one in the property table.

Do photos appear on property dashboards?

Yes, where the dashboard has an Image card set to show the property image. Each property shows its own photo.

Example use cases

  • A property manager notices a property has no photo and asks for one to be added.
  • An analyst plans where photos will appear on an investor dashboard.

Using the platform / Admin setup / Properties

Add property photos to a page or dashboard

Show each property's own photo on a dashboard with an Image card.

Common questions

How do I show the property's photo on a dashboard?

Edit the dashboard, select + Add card, choose Image, and set it to Display property image if available. Then save.

Will one card show a different photo for each property?

Yes. On property dashboards, the card shows the photo of whichever property is open.

Can I use my own image instead?

Yes. An Image card can show an uploaded image instead.

Example use cases

  • An asset manager adds a photo header to each property's overview dashboard.
  • An investor relations team makes property pages more visual.

Branding

Using the platform / Admin setup / Branding

Set company colors

Set the chart colors used across the platform to match your brand.

Heads-up: Appearance settings is now under Admin in the left menu.

Common questions

How do I change chart colors?

Go to Admin → Appearance settings, then Colors. Select a color's hex value and enter your own, check the pie chart preview, and save.

Can I add or remove colors?

Yes. Use + Add color to add one, or X to remove one.

Who can change company colors?

Administrators.

Do the colors apply to everyone?

Yes. They're part of your company's appearance settings, so they apply to everyone's charts.

Example use cases

  • Marketing aligns the chart palette with the brand guide.
  • An asset manager prepares dashboards for an investor meeting.

Using the platform / Admin setup / Branding

Choose a navigation style

Switch the navigation bar between light and dark.

Heads-up: Appearance settings is now under Admin in the left menu.

Common questions

Can I change the navigation bar color?

Yes. In Admin → Appearance settings, under NavBar theme, choose Light or Dark and save.

Does the choice apply to everyone?

Yes. It's part of your company's appearance settings.

Who can change it?

Administrators.

Example use cases

  • An Administrator picks the dark bar so the logo stands out.
  • Marketing matches the navigation to the company website.