Required importer fields for uploading new data

Article author
Aleks Petrovic
  • Updated

Note: This guide on required fields applies to uploading new data only. If you're updating existing data, please refer to the instructions on updating data in bulk.

LearningBanner_Settings-Config.png

User Required Fields

  name     email    license 

License types must be the following:

FIELD
DESK
CUSTOMER
CONTRACTOR

 

Product Required Fields

name type code

Type, means one of the following letters must be chosen.

Materials = M 
Labour = R
Equipment = E
Subcontracted = S
Expense = X

 

Client Required Fields

  name 

 

Properties

  name    address    client or client_id 

The Client you specify here must be in the system before you import properties. You can either use the client name if the name is unique in the system, otherwise, you can either, provide an extra column called client_primary_contact which contains the primary contact name or change the column name to client_id and use the Uptick client id. Client id can be found by viewing the client in Uptick and grabbing the number from the browser url. 

Address will be the display address, the property will need to have a validated address confirmed after import as this can't be done via importer.

Remove the ref column and the system will automatically populate the properties with the next available, unique ref.

branch will need the branch's name

account_manager need the user's email address

billingcard will be the billingcard's ref

Remove status column to default to ACTIVE

Remove access_schedule column to default to NEEDS REVIEW 

 

Property Contacts

  property     name 

Property must contain the Uptick property ref

If you wish to add the contact's role, you must input one of the following selections:
The 5 options for role are:
- propertymanager
- onsitemanager
- owner
- accesscontact
- tenant

Add the word True into requires invoice, report, quote or notification to import it as it as selected.

 

Tasks

  client     name 

If you want to add a property it must contain the Uptick property ref


Contractors

name  email  primary_contact


Assets

  type    property 

Property must contain the Uptick property ref

Type must contain the asset type name exactly how it's written in your system (capitals and spaces). The asset type has to be active.

If you want to apply the variant, simply add the variant name exactly how it's written in your system (capitals and spaces). The variant has to be active.

Base date/ date field to be in format YYYY-MM-DD. Eg. 2021-08-21 for the 21st of August, 2021. 

 

ESMs

  type    property 

Property must contain the Uptick property ref

Type must contain the type name exactly how it's written in your system (capitals and spaces). The type has to be active.

 

Asset Types

  name  


Remark Types

  No required importing fields  

If you are applying a type, it must contain the asset type name exactly how it's written in your system (capitals and spaces). The asset type has to be active.

To apply a severity, simply add one of the following numbers:

0 = Informational
1 = Recommendation 
2 = Non conformance 
5 = Non-critical 
10 = Critical

The Remark Type Label is the 'quick label' that appears to the techs when they are selecting which remark to apply to an asset. Description and Resolution will go into more detail about the remark. 


Remarks

type_id OR type_label   asset_id or asset_ref or asset_barcode  

Type can either contain the Remark Type id or label. If using the Label, the column title needs to be type_label and if you are using the id, the column titles needs to be type_id. Remark Type label can be found in the Remark Type list on the control panel, id can be found by viewing one of those Remark Types and grabbing it from the url.

Asset can either contain the Asset's id, ref or label - as long as this choice is unique only to this asset in your system. If using the Asset's Ref, the column title needs to be asset_ref, if you are using the Asset's barcode, the column title needs to be asset_barcode etc. Asset id can be found by viewing the asset and grabbing the id in the browser's url.

To apply a severity, simply add one of the following numbers:

0 = Informational
1 = Recommendation 
2 = Non conformance 
5 = Non-critical 
10 = Critical

To bulk make remarks inactive via the importer, on top of keeping the id and the required fields, also keep the is_active column blank and add today's date in the inactive_date column.

 

Routine Services

property   type   annual_test_date start_date

Property is your property ref

The annual_test_date and start_date need to have the following format: YYYY-MM-DD

Type is your Routine Type Name found in the Control Panel i.e.

Automatic fire sprinkler systems (2012). This must be written exactly how it's spelt in your system (capitals and spacing)
When importing new Routine services, if you set TRUE in this create_default_levels column, all default levels will be applied to the imported routines. If you set FALSE, only the routine service, without its levels will be applied.

 

Routine Service Levels 

routineserviceleveltype routineservicetype property

You MUST have the Routine Service imported before you can import the levels on them.

Property is your property ref

routineserviceleveltype is your level name i.e. Annual

routineservicetype is your routine type name i.e. Fire Hose Reels (2012)

 

When importing a spreadsheet of estimated durations to your routines, please use the format hh:mm:ss i.e. 02:00:00 is 2 hours.

 

 

Billing Contracts

name   type   recurrence invoice_mode property send_invoice start_date next_due price (Importing only) product (importing only)

Name is name of billing contract (free text)

Type needs the word Fixed or Do & Charge depending on the type of contract you are after

Recurrence is any of the following options, written EXACTLY how they written below (capitals and all):

- Monthly

- Bi-monthly

- Quarterly

- Half-yearly

- Annual

Invoice mode is any of the following options, written EXACTLY how they written below (capitals and all):

- Advance

- Arrears

- Half & half

Property must contain the Uptick property ref

Send Invoice, Start Date and Next Due is your dates of when your first invoice is generated for this contract, the billing period start (can be before or after the next due which will dictate if the contract is billing in advance or arrears) and when the contract next needs an invoice generated.

 

IMPORTING FIXED CONTRACTS ONLY:

Add a column for Price, this will be the total sell price (EX GST) you are charging per invoice.

Add a column for Product, this will be the product and product's description that is used on your invoice. ALL Routines will be covered by this Product and Price.

 

If you are wanting to use the priceincrease_policy column, you'll need to input any of the following single letters:

- N (No price increase)

- A (Automatic)

- M (Manual)

If your priceincrease_policy is A, you must also input priceincrease_auto_next_date and priceincrease_auto_percentage. Make sure you apply the decimal value (0.03) for a 3% increase.

 

 

Prices

  pricetier     product   unit_price

This importer is vital for customers needing to bulk update sell prices to their products for price adjustment or just an easy way to add new price structures for different clients and properties. 

This process is much more simple than our other importers.

Once your products are in the system, simply go to Billing > Product Catalog > Pricebooks > View the Pricebook you wish to update or add sell pricing to > scroll to the bottom of the page and hit 'Download'. Using that CSV, update the unit_price column. Once you are happy with the unit_price column, simply save as a CSV file, then go to Tools > Importer > pick Importer Type = Prices and import. The column titles are already what they need to be to import them in.


Service Contracts

  property     service     contract_date     start_date     next_due_date  

Property must contain the Uptick property ref

Service must contain the service's name


Keys

  name  

You can link this to a property by adding the property ref should you choose to.


Suppliers

  name     email  

 

Prompt questions

id ref   assettype     routineservicetype   label

 

Routine Service Type is the routine type name in your system found in the Control Panel > Routine Type. This is capital and space sensitive. The asset type above MUST be set up as being applicable to this Routine Service Type.

type is the type of question it is (defaults to Remark if nothing is chosen), choose from the available options - please use capitals as guided:

ASSERTION

REMARK

TEXT

INTEGER

DECIMAL

DATE

CHOICE

HEADER

order it is advised to add so the order of the questions are dictated for your mobile app users, otherwise this will be imported with random ordering.

Asset Type is the asset type name in your system - this is capital and space sensitive.

limit_to_variants is the variant names you wish to apply this question to. If left blank, this question will be applied to all variants of this asset type. Variants must be active and applicable to this asset type. If you want to include multiple variants, simply put each variant name on a separate line in the same cell i.e.

2.0KG CO2

3.5KG CO2

remarktype will be the remark type label you wish to force the technician to create if the prompt fails. If this is not filled out, they will be able to pick from all the available remark types like normal.

Routine Service Level Type is a routine type level names in your system i.e. Annual, Six-monthly that you wish to apply this question too. This is capital and space sensitive. If left blank, this question will be applied to all levels applicable to this asset type.

If the question type is CHOICE, this is when you need the config, choice_keys and choice_values columns as you need to be able to import the available choices for your field staff to select. See the following example for guidance:

Screen_Shot_2021-09-08_at_11.12.03_am.png

Things to note: keep the config column, but leave blank. choice_keys must have no spaces or capitals. choice_values are the options your field staff see, and is completely free text. 

Read the Setup section of our prompts help article to find out more about what the different types of prompt questions mean.

 

Accreditation types (In your Control Panel)

  No required importing fields    

For the property_specific column, simply add TRUE or FALSE if this accreditation is property specific and you wish to be able to add this a required accreditation on a property.

 

Accreditation (People > Accreditations)

  No required importing fields    

property must contain the Uptick property ref

technician must be the technician's name in the Uptick system

accreditationtype must be the name of your accreditation - you must only have one accreditationtype called this.

 

Accreditation Requirement - For importing required accreditations against a property, client, routine (Sprinklers) or a routine level type (Annual Sprinklers)

  No required importing fields    

accreditationtype must be the name of your accreditation - you must only have one accreditationtype called this.

property must contain the Uptick property ref

client must contain the client's name - this client's name must be unique in the system

routineservicetype is the routine type name in your system found in the Control Panel > Routine Type. This is capital and space sensitive. 

routineserviceleveltype is a routine type level names in your system i.e. Annual, Six-monthly. This is capital and space sensitive. 

 

 

 

Was this article helpful?

0 out of 1 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.