LogoLogo
Maica's Homepage
Admin Guide
Admin Guide
  • Welcome to Maica Administration
  • Getting Started
    • Check your Salesforce Hosting
    • Licence Agreement
    • The Maica Release Process
    • Find your Maica Edition
    • The Implementation Process
  • Data
    • Data Objects
      • Agreement Item
      • Appointment
      • Availability
      • Booking Item
      • Checklist
      • Client Note
      • Connection
      • Contact
      • Delivery Activity
      • Funding
      • Funding Item
      • Invoice
      • Invoice Line Item
      • Location
      • Log
      • Payment Request
      • Preference
      • Price List
      • Price List Entry
      • Resource
      • Resource Participant
      • Service Agreement
      • Service Agreement Leave
      • Service Agreement Statement
      • Service Booking
      • Shift
      • Support Category
      • Support Item
      • Timesheet
      • Timesheet Entry
      • Unavailability
    • Permission Sets
    • Reference Data
      • Reference Data Template
      • Import Template
    • Data Import Utility
      • NDIS Support Catalogue
      • Data Import Flows
  • System Processes
    • Billing Invoice Generation
    • Timesheet Generation
    • Recurring Schedules
    • Travel Claiming and Expenses
    • Public Holiday Configuration
    • Configuring Maica Components
      • Appointment Services
      • Support Items
      • Support Categories
      • Overnight and 24 Hour Availability
  • Enable Maica Actions
  • Scheduled Jobs
  • Maica Timezone Management
  • Integrations
    • Create a Site
    • Xero Integration
      • Support Item Configuration
    • Stripe Integration
    • NDIS Notifications
  • Settings
    • Renewal Management
    • Claim Management
      • NDIS
        • Handle BPR Results & Remittance Files
        • BPR File Import Flows
      • Aged Care
    • Invoice Management
    • Support Item Management
    • Integration Management
      • NDIS Integration
      • Stripe Integration
      • Xero Integration
    • Connections Management
      • General Settings
      • Reciprocal Settings
    • General Settings
    • Planner Management
    • Rostering Management
    • Service Management
    • Timesheet Management
    • Validation Management
    • Travel Management
    • Billing Management
    • Maps Management
    • Participant Notes
Powered by GitBook

Further Maica Resources

  • Homepage
  • Features
  • FAQs
On this page
  • What is a Reference Data Template?
  • How do I populate my template?

Was this helpful?

Export as PDF
  1. Data
  2. Reference Data

Reference Data Template

Learn about the Reference Data Template required to Import your Data into Maica

PreviousReference DataNextImport Template

Last updated 8 months ago

Was this helpful?

What is a Reference Data Template?

Maica provides you with a spreadsheet template in which you may enter your data. This template is called the Maica Reference Data - Import Templates and it contains a number of tabs for typical Data Objects in Maica that Reference Data may be beneficial for.

Each Data Object has a unique set of fields that need to be populated, hence the corresponding tab is specific to any particular Object. Within each tab, each row in the spreadsheet corresponds to a Salesforce record, while the columns correlate directly to Salesforce attributes.

It is crucial that the first row within each tab is not modified. Modifying or adding columns in the first row will result in errors when attempting to import your data into Maica.

The template's objective is to allow you to bulk load the necessary reference data for Maica to get you up and running.

You can download two versions of the template below:

Template Type
Description

This is a blank template ready to be populated with your data.

This a template with pre-populated data that you can refer to when populating your own template.

To download a Template, click on the Template Name in the table above. Once you have opened it, simply create your own copy and start populating it.

How do I populate my template?

As mentioned above, Maica objects contain attributes of varying Data Types. So, to begin populating a Reference Data Template, lets use an example object: Appointment Services.

When preparing your reference data for loading, there are several formatting requirements that you must follow to guarantee that your data is loaded successfully.

In the downloadable template above, each column will come pre-populated with a value for each column letting you know what Data Type is expected. Remember, each column represents an attribute of the specific object. Below shows the pre-populated columns and rows for the Appointment Services object:

Here we can see Line 1 contains the attributes of the Appointment Services object, and Line 2 contains the required Data Type to input in order to populate that attribute.

So, in order to populate the attributes, we first must understand the Data Types. The table below explains each Data Type in more detail:

Data Type
Description

Object API Name

Related Record Name

Any column that references the Name value of a related Object represents a lookup field linking the record to another related record. In the Reference Data loading process we use the Name value from the related object to search for, find and relate the loaded record. In the above example, this is shown in the Related Client Note Template Name. Note, this may be called Participant Note in your Maica instance. If there is more than one record with the same Name value, the import for this row will fail. (The flow can be easily extended to reference IDs of records for loading purposes if required.)

Text Value

Rich Text Value

As per the Text Value but allows loading in of HTML formatted text.

Number Value

Picklist Value

Multi-Select Picklist Values

As above, but allows for many values to be loaded. Each value must be valid and be separated by a semicolon ;.

Date Value

This field only accepts valid Date format values. Your Salesforce Org setting will determine the acceptable default date format, but typically this will be dd/mm/yyyy or mm/dd/yyyy.

Date/Time Value

This field only accepts valid Date/Time format values. Your Salesforce Org setting will determine the acceptable default date/time format, but typically this will be dd/mm/yyyy, hh:mm:ss.

Boolean Value

Only valid TRUE values will be accepted (field is set to FALSE by default). (TRUE, true, True, 1, yes, Yes, YES).

Now, these Data Types must be practically applied to the attributes shown in Line 1. In order to understand the formatting or values of any field, you can follow the below steps:

1. Head to the Setup

For our example we are using the Appointment Service Object. First, you must go to the Setup by clicking the Cog (as shown below) followed by clicking Setup.

2. Find the Object in the Object Manager

Once in the Setup, head to the Object Manager by clicking the following.

Then, use the Quick Find to search for the required Data Object. In this case: Appointment Service.

3. Find Attribute in Fields & Relationships

After you have selected the required object, click the Fields & Relationships tab and find the attribute you are wanting to understand the formatting or values for. For example, let's say within Appointment Services tab of our template you want to populate the Available Sections column. You can see from the template that the Data Type for this column is Multi-Select Picklist Values, but you may be wondering what these values are. So, in the Fields & Relationships of Appointment Services, find Available Sections and select it, as shown below.

Within Maica you can also find or confirm the Data Type for any Field, as shown above.

4. Find associated Values to populate your Template

After you have found the required Field, in this case Available Sections, scroll down to see the Values and their associated API Name, as shown below.

Now, you can see the required information to populate your column within the Template.

For any Picklist, always use the Values API Namewhen populating your template.

Please see below for an exmaple of how this column would be populated within the Template with the correct values and formatting.

If you require custom Picklist values, you can add them in the Values section of the Data Object by simply clicking New.

This column represents the Data Object you are loading for and must be populated with a valid API name of a Maica Object. It’s required on every row to tell the which object to retrieve and write the values to.

This field accepts free text values, however it is important to check if there are any length restrictions. To do so: Go to Setup > Object Manager > {Object Name} > Fields & Relationships and look at the field you are populating. This process is further explained .

This field accepts numbers values, however it is important to check if there are any length restrictions or if decimals are allowed. To do so: Go to Setup > Object Manager > {Object Name} > Fields & Relationships and look at the field you are populating. This process is further explained .

This field only accepts valid available and active values from the Object Picklist. check the field under Setup > Object Manager > {Object Name} > Fields & Relationships > {Field Name} to check for valid, active values. This process is further explained .

Ensure you always refer back to the required formatting of the Data Type when populating the template, as shown .

above
Blank Template
Populated Template
import flow
below
below
below