User and Company Properties

A User Property associates an attribute with an individual user. A Company Property associates an attribute with a company or client, and is typically used by Partner accounts to facilitate dashboard, Klip and data source re-use across client accounts by allowing the parent to assign client-specific attributes which can be used to control the data queried and displayed in the client accounts.

User and Company Properties can be used like any other variable, except they are set on user login, not by a User Input Control Klip. Like a variable, they can be used in a dynamic data source query or to filter the data displayed in a Klip. User/Company Properties apply dashboard-wide.

To view or add User and Company Properties, you must be signed into the account as an administrator.

User Properties

There are four built-in User Properties in Klipfolio:

  • user.emailAddress
  • user.firstName
  • user.lastName
  • user.isAdmin

In addition, custom User Properties may be defined. To add a custom User Property:

  1. Go to the Users menu and select the Users tab.
  2. Click a user name, then click Properties. The four built-in User Properties and any other previously defined custom User Properties are listed.
  3. Click Add New User Property, fill in the Property Name and User's Value and click Create Property.

This new User Property will now appear for all users, however, the corresponding User's Value will be set to null until they are explicitly filled in.

Watch now to see an example of using custom User Properties.

Company Properties

There are two built-in company properties in Klipfolio:

  • company.id
  • company.name

In addition, custom Company Properties may be defined. To add a custom Company Property:

  1. In the parent or any client account, go to the Account menu and select the Company tab.
  2. Click Properties. The two built-in Company Properties and any other previously defined custom Company Properties are listed.
  3. Click Add New Company Property, fill in the Property Name and Company Value and click Create Property.

This new Company Property appears only for the current account. These steps must be performed for all accounts (parent and clients) that require this company property.

Company Properties for Clients

The primary purpose of Company Properties is to enable Partner accounts to create Klips and data sources that can be imported as is between parent and client accounts. Often, generic dashboards, Klips and data sources are created in the parent account for import to client accounts.

The following example describes the high-level steps to create a data source and a Klip that can be imported into client accounts and used as is. This example assumes you are familiar with variablesdynamic data sources and importing dashboards, Klips and data sources.

A. In the parent account:

  1. Create a User Input Control Klip that sets a variable named companyID. Set the Values subcomponent to a list of all clients' company IDs. This will be used to allow the parent account to select and view all client data.
  2. Create a dynamic data source that uses the companyID variable: {props.companyID}.
  3. Create a Klip that uses the dynamic data source created in the previous step and add it to a dashboard.

B. In each client account:

  1. Create a Company Property named companyID and assign it the client-specific value.
  2. Import the dashboard from the parent (this will bring with it its Klips and data sources) into the client.
  3. Add the imported dashboard to the client's dashboard view. The imported dynamic data source will automatically use the companyID assigned as a Company Property and return the client-specific data used in the imported Klip.

Using a dynamic data source based on a Company Property

Using the Google Analytics Profile ID associated with each client, the Partner can control the data queried and displayed in a specific client account by using a Company Property. In this example, each data source in a client account using the Company Property named gaProfile will import the values associated with that Google Analytics Profile ID.

To create a dynamic data source query using a Company Property:

Set up a company property, such as gaProfile, in the client account, as shown below.

 

Then create a dynamic data source query that uses the dyanimic property (such as gaProfile) as shown below:

https://www.googleapis.com/analytics/v3/data/ga?ids=ga:{props.gaProfile}&dimensions=ga:date&metrics=ga:users

When the data source is imported into the Client account, the dynamic property (in this case, gaProfile) in the data source query is populated with the value assigned to the gaProfile in Company Properties of the client. 

NOTE: If the original data source does not have access to the client-specific data, the data source will need to be reconfigured. For data sources that require authentication (such as OAuth), the data sources imported into a Client will also need to be reconfigured since the new instance of the data source (after import) uses the same authentication as the original data source. 

To reconfigure a data source:

  1. Go to the Library and click the Data Sources tab.
  2. Select the data source to be reconfigured.
  3. Click Reconfigure Data Source. An Authentication screen appears. You need your authentication information for the particular service (such as Google Analytics, Twitter or Facebook) associated with your data source.  

Learn more