onc-1.0.mltbx

Resolve unhandled exception with invalid parameters.

Resolved naming inconsistencies

Indicates if the ONC Production server URL is used for service requests.

• Default is true.
• false is intended for internal ONC testing only.
• All external users should use false or leave blank.

Indicates if verbose script messages are displayed, such as request url and processing time information.

• Default is false.
• True is intended for script debugging.

The path that downloaded files are saved to.

• Default is 'c:/Temp'.
• Full path will be created if it does not already exist.

The web service request timeout in seconds

• Default is 60

A comman separated list of one or more filter criteria, used to return an exclusive set of location elements from the ONC locations endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• If excluded, all locations are returned.
• Valid filters
  • locationCode, locationName, deviceCategoryCode, deviceCode, propertyCode, dataProductCode, deploymentBegin, deploymentEnd, includeChildren
• See locations Discovery Service for more information on filter usage.

struct('locationCode','BACAX')

or

{'locationCode','BACAX'}

location[].deployments

A comman separated list of one or more filter criteria, used to return an exclusive set of device elements from the ONC devices endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}

• If excluded, all devices are returned.
• Valid filters
  • deviceCode, deviceName, locationCode, deviceCategoryCode, propertyCode, dataProductCode, deploymentBegin, deploymentEnd
• See devices Discovery Service for more information on filter usage.

struct('deviceCode','NORTEKADCP9917')

or

{'deviceCode','NORTEKADCP9917'}

The starting datetime for a data rating

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

• datetime is represented in Coordinated Universal Time (UTC) 

The ending datetime for a data rating.

• If None, the data rating was still in affect when the request was made
• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

• datetime is represented in Coordinated Universal Time (UTC) 

A comman separated list of one or more filter criteria, used to return an exclusive set of deviceCategory elements from the ONC deviceCategories endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• If excluded, all device categories are returned.
• Valid filters
  • deviceCategoryCode, deviceCategoryName, description, locationCode, propertyCode
• See deviceCategories Discovery Service for more information on filter usage.

struct('deviceCategoryCode','HYDROPHONE')

or

{'deviceCategoryCode','HYDROPHONE'}

A comman separated list of one or more filter criteria, used to return an exclusive set of properties elements from the ONC properties endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• If excluded, all properties are returned.
• Valid filters
  • propertyCode, propertyName, description, locationCode, deviceCategoryCode, deviceCode
• See properties Discovery Service for more information on filter usage.

struct('propertyCode','seawatertemperature')

or

{'propertyCode','seawatertemperature'}

A comman separated list of one or more filter criteria, used to return an exclusive set of data product & extension elements from the ONC dataProducts endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• If excluded, all data products are returned.
• Valid filters
  •  dataProductCode, extension, locationCode, deviceCategoryCode, deviceCode, propertyCode
• See dataProducts Discovery Service for more information on filter usage.

struct('dataProductCode','TSSD', ...
       'extension','json')
or
{'dataProductCode','TSSD', ...
 'extension','json'}

A comma separated list of filter criteria parameters, used to request data as a data product from the ONC dataProductDelivery endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• Required filters
  
  • For Site Device data request include locationCode and deviceCategoryCode
  • For Primary Sensor level data request include locationCode and propertyCode
  • For Sensor Level data request include locationCode, deviceCategoryCode and propertyCode
  • For Device (all properties) data request use deviceCode
  • For Device Property data request use deviceCode and deviceCategoryCode
  • Include begin and end (a date range)
  • Include dataProductCode, extension and appropriate data product options
• See locations Discovery Service, devices Discovery Service, deviceCategories Discovery Service, properties Discovery Service and dataProducts Discovery Service for available parameters (filters).

struct('locationCode','BACAX',...
'deviceCategoryCode','ADCP2MHZ',...
'dataProductCode','TSSD',...
'extension','csv',...
'begin','2016-07-27T00:00:00.000Z',...
'end','2016-08-01T00:00:00.000Z',...
'dpo_qualityControl',1,...
'dpo_resample','none',...
'dpo_dataGaps',0)

or

{'locationCode','BACAX',...
'deviceCategoryCode','ADCP2MHZ',...
'dataProductCode','TSSD',...
'extension','csv',...
'begin','2016-07-27T00:00:00.000Z',...
'end','2016-08-01T00:00:00.000Z',...
'dpo_qualityControl',1,...
'dpo_resample','none',...
'dpo_dataGaps',0}

The number of times to retry the service before the function aborts.

• If excluded, the default of 100 is used

Indicates if the files will be downloaded or if only the url to the file will be returned

• false - Files are downloaded to the ONC class outPath property location
• true - Files will not be downloaded. The download URLs are available from the url property for each downloadResult in downloadResults in the returned struct
• If excluded, the default of false is used

Indicates if the metadata file associated with the data product request will be downloaded

• false - Metadata file is not downloaded
• true - Metadata file is downloaded
• If excluded, the default of false is used.

The status of the download process at the request. Possible values are:

• "running" - The data product request is running on the Task server.
• "complete" - The data product request Task has completed and file has been downloaded or url has been returned.
• "error" - An error, preventing the task execution or download from completing successfully, has occurred.

struct or array

A comma separated list of filter criteria parameters, used to request data as a data product from the ONC dataProductDelivery endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• Required filters
  
  • For Site Device data request include locationCode and deviceCategoryCode
  • For Primary Sensor level data request include locationCode and propertyCode
  • For Sensor Level data request include locationCode, deviceCategoryCode and propertyCode
  • For Device (all properties) data request use deviceCode
  • For Device Property data request use deviceCode and deviceCategoryCode
  • Include begin and end (a date range)
  • Include dataProductCode, extension and appropriate data product options
• See locations Discovery Service, devices Discovery Service, deviceCategories Discovery Service, properties Discovery Service and dataProducts Discovery Service for available parameters (filters).

struct('locationCode','BACAX',...
       'deviceCategoryCode','ADCP2MHZ',...
       'dataProductCode','TSSD',...
       'extension','csv',...
       'begin','2016-07-27T00:00:00.000Z',...
       'end','2016-08-01T00:00:00.000Z',...
       'dpo_qualityControl',1,...
       'dpo_resample','none',...
       'dpo_dataGaps',0)

or

{'locationCode','BACAX', ...
 'deviceCategoryCode','ADCP2MHZ', ...
 'dataProductCode','TSSD', ...
 'extension','csv', ...
 'begin','2016-07-27T00:00:00.000Z', ...
 'end','2016-08-01T00:00:00.000Z', ...
 'dpo_qualityControl',1, ...
 'dpo_resample','none', ...
 'dpo_dataGaps',0}

dpRequestId: 2046404

downloadTimes: {1x3 cell}

              10Mbps: 7.076623

              50Mbps: 1.4153247

              150Mbps: 0.47177488

A dataProductDelivery dpRequestId, which is returned by the dataProductDelivery service request method, or as the 'dpRequestId' property in the dpRequest returned by the requestDataProduct() method.

2046404

A dataProductDelivery dpRunId, which is returned by the dataProductDelivery service run method, or as the dpRunId property in the list returned by the runDataProduct() method.

4629218

The actual or estimated file count, which is returned from the dataProductDelivery request method

• If there is no estimated file count, use 0.
• If excluded, the default of 0 is used.

The estimated time in seconds, that it should take to run the request on the task machine.

• Used to determine how often the dataProductDelivery service is called to see if the task processing is complete.
• Estimated processing time is provided by the dataProductDelivery request method

The number of times to retry the service before the function aborts.

• If excluded, the default of 100 is used

Determines if the files will be downloaded or if only the url to the file will be returned

• false - Files are downloaded to the ONC class outPath property location
• true - Files will not be downloaded. The download URLs are available from the url property for each downloadResult in downloadResults in the returned struct
• If excluded, the default of false is used

Indicates if the metadata file associated with the data product request will be downloaded

• false - Metadata file is not downloaded
• true - Metadata file is downloaded
• If excluded, the default of false is used.

true

The status of the download process at the request. Possible values are:

• "running" - The data product request is running on the Task server.
• "complete" - The data product request Task has completed and file has been downloaded or url has been returned.
• "error" - An error, preventing the task execution or download from completing successfully, has occurred.

A comma separated list of filter criteria parameters, used to request data as a data product from the ONC dataProductDelivery endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• Required filters
  
  • For Site Device data request include locationCode and deviceCategoryCode
  • For Primary Sensor level data request include locationCode and propertyCode
  • For Sensor Level data request include locationCode, deviceCategoryCode and propertyCode
  • For Device (all properties) data request use deviceCode
  • For Device Property data request use deviceCode and deviceCategoryCode
  • Include begin and end (a date range)
  • Include dataProductCode, extension and appropriate data product options
• See locations Discovery Service, devices Discovery Service, deviceCategories Discovery Service, properties Discovery Service and dataProducts Discovery Service for available parameters (filters).

struct('locationCode','BACAX',...
       'deviceCategoryCode','ADCP2MHZ',...
       'dataProductCode','TSSD',...
       'extension','csv',...
       'begin','2016-07-27T00:00:00.000Z',...
       'end','2016-08-01T00:00:00.000Z',...
       'dpo_qualityControl',1,...
       'dpo_resample','none',...
       'dpo_dataGaps',0)

or

{'locationCode','BACAX', ...
 'deviceCategoryCode','ADCP2MHZ', ...
 'dataProductCode','TSSD', ...
 'extension','csv', ...
 'begin','2016-07-27T00:00:00.000Z', ...
 'end','2016-08-01T00:00:00.000Z', ...
 'dpo_qualityControl',1, ...
 'dpo_resample','none', ...
 'dpo_dataGaps',0}

The number of times to retry the service before the function aborts.

• If excluded, the default of 100 is used

The url to be downloaded

http://data.oceannetworks.ca/api/dataProductDelivery?method=download&token=<YOUR_TOKEN_HERE>

&dpRunId=<YOUR_RUN_ID_HERE>&index=<YOUR_INDEX_HERE>

The full path of the file to be downloaded to.

• If excluded, the file name from the content disposition in the header is used, along with the onc class object outPath to create a full file name path.

Determines how the method and called method should print messages to the console. If downloading data products in a multi-threaded pattern, messages written to the console can overlap and progress dots can be written out of context

• If excluded, the default of False is used.

The status of the download process at the request. Possible values are:

• "running" - The data product request is running on the Task server.
• "complete" - The data product request Task has completed and file has been downloaded or url has been returned.
• "error" - An error, preventing the task execution or download from completing successfully, has occurred.

The url to a JSON data product delivery result

http://data.oceannetworks.ca/api/dataProductDelivery?method=download&token=<YOUR_TOKEN_HERE>&dpRunId=<YOUR_RUN_ID_HERE>&index=<YOUR_INDEX_HERE>

A comma separated list of filter criteria parameters, used to request data and metadata from the scalardata endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• filters must include locationCode and deviceCategoryCode
• filters can optionally Include begin and end (a date range)
• See locations Discovery Service and deviceCategories Discovery Service  for more information on filter usage.

struct('locationCode','TWDP', ...

or

{'locationCode','TWDP', ...
'deviceCategoryCode','TSG', ...
'begin','2016-09-01T00:00:00.000Z', ...
'end','2016-09-01T08:00:00.000Z'}

The encoding of the response output.

• Object - Data is a list of dictionaries with sampleTime, value and qaqcFlag for a given sensor.
• Array - Data has 3 arrays for a given sensor. Array of sampleTime, array of values and array of qaqcFlags
• If excluded, the default 'Object' is used.

The amount of metadata detail that is included in the response output.

• Minimum - Provides only basic property information. Response includes serviceMetadata dictionary only.
• Full - Provides all property information. Response includes both metadata and serviceMetadata dictionaries.
• If excluded, the default 'Minimum' is used.

The maximum number of rows of scalar data that will be returned for each sensor

• Maximum is 100,000
• If excluded, the default 100,000 is used

The recorded time of the observation

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

• datetime is represented in Coordinated Universal Time (UTC) 

struct

or

cell array

A comma separated list of filter criteria parameters, used to request data and metadata from the rawdata endpoint.

• A list of filter/value pairs in the following format struct('<filter_1>','<value_1>','<filter_2>','<value_2>',...) or {'<filter_1>','<value_1>','<filter_2>','<value_2>',...}
• filters must include locationCode and deviceCategoryCode
• filters can optionally Include begin and end (a date range)
• See locations Discovery Service and deviceCategories Discovery Service  for more information on filter usage.

struct('locationCode','TWDP', ...
'deviceCategoryCode','TSG', ...
'begin','2016-09-01T00:00:00.000Z', ...
'end','2016-09-01T08:00:00.000Z')

or

{'locationCode','TWDP', ...
'deviceCategoryCode','TSG', ...
'begin','2016-09-01T00:00:00.000Z', ...
'end','2016-09-01T08:00:00.000Z'}

The maximum number of rows of raw data that will be returned

• Maximum is 100,000
• If excluded, the default 100,000 is used

The recorded time of the observation

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

• datetime is represented in Coordinated Universal Time (UTC) 

If the there is more data in the range of the request. For example if 1,000 records are returned (because the rowLimit=1000) but there should be 200,000 rows as defined by the filter criteria.

• 0 = False
• 1 = True