Home Schema Example JSON Schema

Data Source


Settings for configuring an Einstein data source.

 No Additional Properties

root anyOf item 0
Type: object

The following properties are required:

  • google_drive
root anyOf item 1
Type: object

The following properties are required:

  • ingestor
root anyOf item 2
Type: object

The following properties are required:

  • mock
root anyOf item 3
Type: object

The following properties are required:

  • microsoft_sharepoint
root anyOf item 4
Type: object

The following properties are required:

  • noop
root anyOf item 5
Type: object

The following properties are required:

  • noop_dialogue
root anyOf item 6
Type: object

The following properties are required:

  • s3
root anyOf item 7
Type: object

The following properties are required:

  • tabular

root allow_user_upload

Allow User Upload

Type: boolean

Whether this data source allows user upload. Defaults to false.

root convert_to_pdf

Convert To PDF

Type: boolean

Determines if a entries from this data source should be converted to PDF. Defaults to true.

root delete_deactivated_entries

Permanantly delete deactivated entries.

Type: boolean

Boolean flag to indicate that deactivated entries should be deleted. Defaults to false.

root recreate_entries

Recreate all entries.

Type: boolean

Recreate all entries skipping find and is_same in syncer (faster for large number of entries eg. 50k directory). Defaults to false.

root ui_flags
Type: object

root ui_flags deletable

Deletable

Type: boolean

Should UI be able to delete entries in this DataSource. Defaults to true.

root ui_flags user_created

User Created

Type: boolean

Indicates if the entries in the DataSource are user created or preset. Defaults to true.

root generate_pages

Generate file pages.json

Type: boolean

Determines if a file pages.json containing a mapping of text page number to text will be generated and uploaded to storages. Defaults to false.

root pdf_export_method

Method For PDF Export

Type: enum (of string)

The method used for converting office documents to PDF. Defaults to convertapi.

Must be one of:

  • "convertapi"
  • "libreoffice"

root chernobyl

Chernobyl

Type: object

Settings related to Chernobyl module.

 No Additional Properties

root chernobyl key

Key

Type: string

The corresponding Chernobyl MiniApp key in Jarvis.

Must be at least 1 characters long

root chernobyl fields

Fields

Type: array

Settings for fields to be used when syncing.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root chernobyl fields Field
Type: object
No Additional Properties

root chernobyl fields fields items key

Key

Type: string

Uniquely identifiable key used internally for this field. It will be used as the key when storing values associated with this field.

Must be at least 1 characters long

root chernobyl fields fields items encrypt

Encrypt

Type: boolean

If this field should be encrypted in the database (defaults to false).

root chernobyl synonyms_file

Synonyms File URL

Type: string

The URL for the synonyms file to use for synonyms transformation. Use only links to our own s3.

Must be at least 1 characters long

root eliza

Eliza (Dialogues)

Type: object

Settings related to Eliza (Dialogues) module.

 No Additional Properties

root eliza key

Key

Type: string

The corresponding Eliza provider key in Jarvis.

Must be at least 1 characters long

root rosters

Rosters

Type: object

Settings related to Rosters module.

 No Additional Properties

root rosters key

Key

Type: string

The corresponding Rosters Provider key in Jarvis.

Must be at least 1 characters long

root rosters synonyms_file

Synonyms

Type: string

The S3 uri to a synonyms YAML file used by the roster parser (uses default if not provided).

Must be at least 1 characters long

root rosters fields

Fields

Type: array

Settings for fields to be used when syncing.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root rosters fields Field
Type: object
Same definition as chernobyl_fields_items

root rosters fake_dates

Use Fake Dates

Type: boolean

Indicate DataSource to generate fake dates for entries (today).

root singhealth

SingHealth

Type: object

Settings related to singhealth datasources.

root singhealth institutions

Institutions

Type: array of string

The Singhealth institution names as it appears in the column to filter the rows by.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root singhealth institutions institutions items
Type: string

Must be at least 1 characters long

root google_drive

Google Drive

Type: object

Settings for using Google Drive as a data source.

 No Additional Properties

root google_drive credentials

Google Cloud Credentials

Type: object

The service account credentials.

root google_drive credentials type

Type

Type: const

Credential type. Must be service_account.

Specific value: "service_account"

root google_drive credentials private_key

Private Key

Type: string

Private key associated with the credential.

Must be at least 1 characters long

Additional Properties of any type are allowed.

root google_drive credentials additionalProperties
Type: object

root google_drive url

Google Drive URL

Type: stringFormat: uri

The unique URL of the Google Drive or folder.

Must be at least 1 characters long

root ingestor

Ingestor


Settings for using a ingestor as a data source.

root ingestor anyOf item 0
Type: object

The following properties are required:

  • content_uid
root ingestor anyOf item 1
Type: object

The following properties are required:

  • worker_keys
root ingestor anyOf item 2
Type: object

The following properties are required:

  • content_uri
  • worker_key
root ingestor anyOf item 3
Type: object

The following properties are required:

  • content_uris
  • worker_key
root ingestor anyOf item 4
Type: object

The following properties are required:

  • content_uri__startswith
  • worker_key
root ingestor anyOf item 5
Type: object

The following properties are required:

  • content_uri__regex
  • worker_key

root ingestor content_uid

Content UID

Type: string

UID of the IngestorContent to sync (may change on ingestor wipe, use content_uri and worker_key instead).

Must be at least 1 characters long

root ingestor content_uri

Content URI

Type: string

URI of the IngestorContent to sync (use with worker_key).

Must be at least 1 characters long

root ingestor content_uris

Content URI List

Type: array of string

List of URIs of the IngestorContent to sync (use with worker_key).

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root ingestor content_uris content_uris items
Type: string

Must be at least 1 characters long

root ingestor worker_key

Worker Key

Type: string

Worker key of the IngestorContent to sync (use with content_uri).

Must be at least 1 characters long

root ingestor content_uri__startswith

URI Starts With

Type: string

Prefix for the IngestorContent content URI.

Must be at least 1 characters long

root ingestor content_uri__regex

URI Match for Regex

Type: string

Regex filter for IngestorContent content URI.

Must be at least 1 characters long

root ingestor worker_keys

Worker Keys

Type: array of string

The worker keys of IngestorContent to sync.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root ingestor worker_keys worker_keys items
Type: string

Must be at least 1 characters long

root ingestor active_sheets

Active Excel Sheets

Type: array of string

The sheet names that should be synced.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root ingestor active_sheets active_sheets items
Type: string

Must be at least 1 characters long

root ingestor start_from_row

Start From Row

Type: integer

The excel row to start parsing from (the first row should default to the column header, defaults to 1).

root mock

Mock

Type: object

Settings for Mock data source. This is used in unit tests and not be used in real life.

root microsoft_sharepoint

Microsoft Sharepoint

Type: object

Settings for using Microsoft Sharepoint as a data source.

 No Additional Properties

root microsoft_sharepoint credentials

Microsoft Sharepoint Credentials

Type: object

Sharepoint client secret

root microsoft_sharepoint credentials grant_type

grant_type

Type: const

Grant permission type. Must be client_credentials

Specific value: "client_credentials"

root microsoft_sharepoint credentials client_secret

client_secret

Type: string

Client secret generated from MS Azure AD.

Must be at least 1 characters long

root microsoft_sharepoint credentials scope

scope

Type: const

Scope of the token generated. Must be https://graph.microsoft.com/.default

Specific value: "https://graph.microsoft.com/.default"

root microsoft_sharepoint credentials client_id

client_id

Type: string

client_id generated from MS Azure AD.

Must be at least 1 characters long

root microsoft_sharepoint credentials tenant_id

Tenant id

Type: string

Tenant id of the app.

Additional Properties of any type are allowed.

root microsoft_sharepoint credentials additionalProperties
Type: object

root microsoft_sharepoint url

Sharepoint Drive url

Type: stringFormat: uri

Url of sharepoint drive id that contains all the files.

Must be at least 1 characters long

root noop

Noop

Type: object

Settings for using a Noop data source. This is useful as a dummy data source for user uploaded entries.

root noop_dialogue

Noop Dialogue

Type: object

Settings for using a Noop dialogue data source. This is useful as a dummy data source for user uploaded entries.

root s3

S3


Settings for using S3 as a data source. Access control will depend on permissions being assigned to the Hippocrates task role: staging-hippo-ecs_task_role-20180611204658589300000001 and product-hippo-ecs_task_role-20180620231135019400000002.

 No Additional Properties

root s3 oneOf item 0
Type: object

The following properties are required:

  • uri
root s3 oneOf item 1
Type: object

The following properties are required:

  • uris

root s3 uri

URI

Type: stringFormat: uri

The s3:// URI to the bucket along with key prefix. A trailing slash is always added.

Must be at least 1 characters long

root s3 uris

URIs

Type: array of string

The s3:// URIs to the buckets along with key prefix. A trailing slash is always added.

Must contain a minimum of 1 items

All items must be unique

No Additional Items

Each item of this array must be:

root s3 uris uris items
Type: string

Must be at least 1 characters long

root tabular

Tabular interface

Type: object

Settings for using a tabular interface as a data source.

root tabular anyOf item 0
Type: object

The following properties are required:

  • url
root tabular anyOf item 1
Type: object

The following properties are required:

  • urls

root tabular url

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

root tabular urls

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root tabular urls urls items
Type: string

Must be at least 1 characters long

root tabular sheet_name

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

root tabular status_column

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

root tabular headers

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root tabular headers headers items
Type: string

Must be at least 1 characters long

root tabular skip_header_row

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

root tabular additionalProperties
Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.