Connectors Reference
Intelligent Plant’s Industrial App Store Connector enables Microsoft’s powerful analytics and visualizations to be applied to real-time and historical process data. Seamlessly integrate plant and corporate data and share with any colleague on any device, enabling faster, better, real-time decision making. The Industrial App Store Connector connects to Intelligent Plant’s Industrial App Store, while all data remains securely and safely on-premises. The plant data may be centralized in a corporate data lake or globally dispersed across many sites and historians. Either way, Industrial App Store Power BI Connector brings it all together and delivers to your fingertips.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Get data sources |
|
|
ias_tagsearch (string dsn, string name, [advanced]integer page, integer pageSize) |
Get tags |
|
Get snapshot |
|
|
Get processed data |
|
|
Get historical data |
|
|
Get plot data |
|
|
ias_getdata_raw (string dsn, string tag, string start, string end, integer points) |
Get raw data |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
Summary: Get data sources
Description: Retrieve available data sources.
Syntax:
IndustrialAppStore.ias_getdsns ()
Returns:
Type:array of (ias_getdsnsResponseItem)
Summary: Get tags
Description: Performs a tag search on the specified data source.
Syntax:
IndustrialAppStore.ias_tagsearch (string dsn, string name, [advanced]integer page, integer pageSize)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dsn |
string (The data source name to use for data query.) |
The data source name. |
True |
|
|
name |
string (Tag name filter to use. Default value is "*".) |
The tag name filter. |
True |
|
|
page |
integer(int32) (The page number of the matching results that should be returned.) |
The page number of the matching results that should be returned. |
True |
|
|
pageSize |
integer(int32) (Page size for the results.) |
Page size for the results. |
True |
Returns:
Type:array of (ias_tagsearchResponseItem)
Summary: Get snapshot
Description: Performs a snapshot data query on a single data source.
Syntax:
IndustrialAppStore.ias_getdata_snapshot (string dsn, string tag, [advanced][Optional]boolean nocache, [advanced][Optional]boolean includeProperties)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dsn |
string (The data source name.) |
Data source name to perform data query on. |
True |
|
|
tag |
string (The tags to query.) |
The tags to query. |
True |
|
|
nocache |
boolean (When true, specifies that cached snapshot values should not be used.) |
When true, specifies that cached snapshot values should not be used (i.e. a snapshot query will always be executed against the data source). |
False |
|
|
includeProperties |
boolean (When true, tag value properties will be included in the results.) |
When true, tag value properties will be included in the results. |
False |
Returns:
Type:ias_getdata_snapshotResponse
Summary: Get processed data
Description: Performs a multi-data source aggregated or processed data query.
Syntax:
IndustrialAppStore.ias_getdata_processed (string dsn, string tag, string start, string end, string function, string step, [advanced][Optional]boolean includeProperties)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dsn |
string (The data source name.) |
Data source name to perform data query on. |
True |
|
|
tag |
string (The tags to query.) |
The tags to query. |
True |
|
|
start |
string (The absolute or relative query start time.) |
The absolute or relative query start time. |
True |
|
|
end |
string (The absolute or relative query end time.) |
The absolute or relative query end time. |
True |
|
|
function |
string (Data function/aggregation to use when performing data query.)Values: [INTERP, AVG, MIN, MAX, PLOT] |
The data function to use. |
True |
|
|
step |
string (The sample interval for the query.) |
The sample interval for the query. |
True |
|
|
includeProperties |
boolean (When true, tag value properties will be included in the result.) |
When true, tag value properties will be included in the result. |
False |
Returns:
Type:HistoricalDataQueryResponse
Summary: Get historical data
Description: Performs a data query on the specified data source.
Syntax:
IndustrialAppStore.ias_getdata_historical (string dsn, string tag, string function, string start, string end, string step)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dsn |
string (The data source name.) |
Data source name to perform data query on. |
True |
|
|
tag |
string (The tags to query.) |
The tags to query and get data for. |
True |
|
|
function |
string (Data function/aggregation to use when performing data query.)Values: [INTERP, AVG, MIN, MAX, PLOT, RAW] |
The data function to use. |
True |
|
|
start |
string (Start time to use when performing the data query.) |
Start time for the query. |
True |
|
|
end |
string (End time to use when performing the data query.) |
The end time for the query. |
True |
|
|
step |
string (The sample interval.) |
The sample interval. |
True |
Returns:
Type:HistoricalDataQueryResponse
Summary: Get plot data
Description: Performs a plot data query on the specified data source.
Syntax:
IndustrialAppStore.ias_getdata_plot (string dsn, string tag, string start, string end, integer intervals, [advanced][Optional]boolean includeProperties)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dsn |
string (The data source name.) |
Data source name to perform data query on. |
True |
|
|
tag |
string (The tags to query.) |
The tags to query. |
True |
|
|
start |
string (The absolute or relative query start time.) |
The absolute or relative query start time. |
True |
|
|
end |
string (The absolute or relative query end time.) |
The absolute or relative query end time. |
True |
|
|
intervals |
integer(int32) (The number of intervals to use for the PLOT request.) |
The number of intervals to use for the PLOT request. |
True |
|
|
includeProperties |
boolean (When true, tag value properties will be included in the results.) |
When true, tag value properties will be included in the results. |
False |
Returns:
Type:HistoricalDataQueryResponse
Summary: Get raw data
Description: Performs a multi-data source RAW data query.
Syntax:
IndustrialAppStore.ias_getdata_raw (string dsn, string tag, string start, string end, integer points)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
dsn |
string (The data source name.) |
Data source name to perform data query on. |
True |
|
|
tag |
string (The tags to query.) |
The tags to query. |
True |
|
|
start |
string (The absolute or relative query start time.) |
The absolute or relative query start time. |
True |
|
|
end |
string (The absolute or relative query end time.) |
The absolute or relative query end time. |
True |
|
|
points |
integer(int32) (The maximum number of points to return per tag.) |
The maximum number of points to return per tag. |
True |
Returns:
Type:HistoricalDataQueryResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Data source name |
|
Data source description |
Summary:
Description: Data source description
Properties:
|
Name |
Type |
Summary |
|
Tag name |
|
Tag name description |
Summary:
Description: Tag name description
Properties:
|
Name |
Type |
Summary |
|
TagName |
string
|
TagName |
|
DisplayType |
string
|
DisplayType |
|
Values |
array of (ValuesItem)
|
Values |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
TagName |
string
|
TagName |
|
UtcSampleTime |
string
|
UtcSampleTime |
|
NumericValue |
number(float)
|
NumericValue |
|
IsNumeric |
boolean
|
IsNumeric |
|
TextValue |
string
|
TextValue |
|
Status |
string
|
Status |
|
Unit |
string
|
Unit |
|
Notes |
string
|
Notes |
|
Error |
string
|
Error |
|
HasError |
boolean
|
HasError |
|
Properties |
|
Properties |
Summary:
Description: Properties
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
datasource |
|
datasource |
Summary:
Description: datasource
Properties:
|
Name |
Type |
Summary |
|
tagname |
|
tagname |
Summary:
Description: tagname
Properties:
|
Name |
Type |
Summary |
|
TagName |
string
|
TagName |
|
UtcSampleTime |
string
|
UtcSampleTime |
|
NumericValue |
number(float)
|
NumericValue |
|
IsNumeric |
boolean
|
IsNumeric |
|
TextValue |
string
|
TextValue |
|
Status |
string
|
Status |
|
Unit |
string
|
Unit |
|
Notes |
string
|
Notes |
|
Error |
string
|
Error |
|
HasError |
boolean
|
HasError |
|
Properties |
|
Properties |
Summary:
Description: Properties
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Host |
string
|
The remote host that the data source definition was downloaded from. |
|
SupportedFeatures |
string
|
The features supported by the data source. |
|
Name |
|
Name |
|
TypeName |
string
|
The component type name. |
|
Description |
string
|
The component description. |
|
Status |
|
Status |
|
Settings |
array of (SettingsItem)
|
Settings |
|
Properties |
|
Properties |
|
AuthorizationRules |
array of (AuthorizationRulesItem)
|
AuthorizationRules |
Summary:
Description: Name
Properties:
|
Name |
Type |
Summary |
|
Name |
string
|
The component name. |
|
Namespace |
string
|
Namespace |
|
QualifiedName |
string
|
QualifiedName |
|
DisplayName |
string
|
DisplayName |
|
Aliases |
array of (AliasesItem)
|
Aliases |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
RunningStatus |
string
|
Current component status. |
|
HealthStatus |
|
HealthStatus |
|
IsInitialised |
boolean
|
IsInitialised |
|
IsDisabled |
boolean
|
IsDisabled |
|
DebugMode |
boolean
|
DebugMode |
|
UtcStartupTime |
string
|
UtcStartupTime |
|
UtcLastModified |
string
|
UtcLastModified |
|
Uptime |
string
|
Uptime |
|
Messages |
array of (MessagesItem)
|
Messages |
Summary:
Description: HealthStatus
Properties:
|
Name |
Type |
Summary |
|
IsHealthy |
boolean
|
IsHealthy |
|
Properties |
array of (PropertiesItem)
|
Properties |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Properties
Properties:
|
Name |
Type |
Summary |
|
Keep-Alive Data Queries |
string
|
Keep-Alive Data Queries |
|
Remote Type |
string
|
Remote Type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Id |
string
|
The unique identifier for the tag. If not specified, the name of the tag . |
|
Name |
string
|
The tag name. |
|
Description |
string
|
The tag description. |
|
UnitOfMeasure |
string
|
The tag's unit of measure. |
|
Properties |
|
Properties |
|
DigitalStates |
array of (DigitalStatesItem)
|
DigitalStates |
|
IsMetaTag |
boolean
|
Flag that specifies if the tag is a meta tag created by a driver. |
Summary:
Description: Properties
Properties:
|
Name |
Type |
Summary |
|
index |
|
index |
Summary:
Description: index
Properties:
|
Name |
Type |
Summary |
|
Value |
integer(int32)
|
Value |
|
Name |
string
|
Name |
|
Category |
string
|
Category |
|
Description |
string
|
Description |
|
DisplayIndex |
integer(int32)
|
DisplayIndex |
|
IsReadOnly |
boolean
|
IsReadOnly |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |