Master Data File (data.JSON5)

The data.JSON5 file stores data on many customizable features of the Portal. This file typically focuses on form and form field content, portfolio, and invitations.

Although there are other ways to edit the contents of the file, such as using the Form Editorinterface, you may wish to edit the data.JSON5 directly. This guide will outline and explain the contents of the file.

Please note that this file can vary greatly. Please contact the service desk if your require support.

Location

You can find the data.JSON5 file in your institutions File Explorer or WebDAV under the folders private and then dashboard.

Sections

Profile

Once you have your file open, you will notice that the first key is profile. This will be in every data.json5 file.

It is the first form in the workflow that your customer will see. Typically, this form is used to collect information about your customer.

You will notice that there is the title key, this the form name.

There is also the fields array, this will contain fields that are to be filled out by customer such as name, phone number, email, etc. Please visit the Form Data Model to learn more about possible field configurations.

CODE

{
  profile: {
    title: 'Information',
    fields: [
    ...
    ]
  }
}

Invitations

This section contains the configuration for the invitations page on your portal.

Owners Array

Owners refers to assignees to the business accounts. These are user groups that can have a business account assigned to them. This array will be found in both the invitation and portfolio sections.

CODE

owners: [
            'admins',
            'managers',
            'officers'
        ],

Permissions Array

There will be a permissions array. This section determines which groups can view or send invitations. If add: true then the specified group can send invitations, if add: false, then they cannot.

CODE

permissions: [
            {
                groups: [
                    'admins'
                ],
                access: {
                    view: 'all',
                    add: true
                }
            }
]

Fields Array

Below this, you will find a fields array, this section is where you can configure which fillable fields you would like available before sending invitations such as name, website, and more.

Under the same section, you will also find the info-statements. These are configurations the paperwork that you are able to request when you send your invitations.

CODE

		fields: [
			{
				name: 'company',
				title: 'Company Name',
				type: 'text',
				import: {
					dst: 'profile.legal-name'
				}
			},
			{
				name: 'website',
				title: 'Website',
				type: 'url',
			},
			{
				name: 'notes',
				title: 'Notes',
				type: 'text'
			},
			{
				name: 'div-biz-info',
				title: 'Requested Business Information',
				type: 'divider',
				description: 'Select the documents and data you would like your client to provide',
			},
			{
				name: 'info-statements',
				title: 'Information / Statements',
				type: 'select',
				typeDisplay: 'full',
				multiple: true,
				values: [
					{value: 'profit_loss', title: 'Profit and Loss (YTD)'},
					{value: 'balance_sheet',title: 'Balance Sheet (YTD)'},
					{value: 'cash_flow', title:'Cash Flow Statement'},
					{value: 'bank_balances',title: 'Bank Balances and Transactions'},*/
					{value: 'bank_transfer',title: 'Banking Transfer Information'},
					{value: 'irs_1120',title: 'IRS Business Tax Form 1120'},
					{value: 'cra_t2',title: 'CRA T2 Corporation Income Tax Return'},
					{value: 'prepared_financials',title: 'Accountant Prepared Financial Statements'},
					{value: 'cash_flow_forecast', title: 'Cash Flow Forecast'},
					{value: 'notice_of_assessment', title: 'Notice of Assessment (previous 2 years)'}, // previous 2 years
					{value: 'cra_pd7a', title: 'PD7A Statement of Account for Source Deductions'},
					{value: 'bank_statements', title: 'Bank Statements (previous 2 months)'}, // from last 2 months
					{value: 'certificate_of_incorporation', title: 'Certificate of Incorporation'},
					{value: 'articles_of_incorporation', title: 'Articles of Incorporation'},

				],
			}
		],

Status Array

Towards the bottom, you will come across a status array. Please do not change the contents of this array.

Portfolio

Owners Array

Owners refers to assignees to the business accounts. These are user groups that can have a business account assigned to them. This array will be found in both the invitation and portfolio sections.

CODE

owners: [
			'admins',
			'managers',
			'officers'
		],

Permissions Array

Similar to the permissions array found in the invitations sections, this array determines which groups can view or send invitations. If add: true then the specified group can send invitations, if add: false, then they cannot.

CODE

permissions: [
            {
                groups: [
                    'admins',
                    'managers'
                ],
                access: {
                    view: 'all',
                    edit: true
                }
            },
            {
                groups: [
                    'officers',
                    'users'
                ],
                access: {
                    view: 'own',
                }
            }
        ],

Fields Array

You will find a fields array, this adds columns to the portfolio page found on your portal. This section also pulls values from the Profile form.

CODE

fields: [
            {
                name: 'website',
                title: 'Website',
                type: 'url',
            },
            {
                name: 'company',
                title: 'Company',
                type: 'address',
            }
        ]

Forms

This is where configuration for your forms will reside such as fields and permissions. For more details on editing this section, please visit the Form Data Model documentation.

Checkers are also formatted in this section. For more details, please visit our Checkers documentation.

CODE

forms: {
        formID: {
            title: 'Form Title',
            fields: [
                {
                    name: 'taxpayersDivider',
                    title: 'Taxpayers (Businesses or Individuals)',
                    type: 'divider',
                },
              ...
             ]
          }
       }