jDataPortal()
Estimated reading time:
5 minutes
Function Summary
The jDataPortal function establishes a connection to an Interject Data Portal that will be used as the data source for the function it is embedded in. Data sets accessed utilizing the jDataPortal are stored in memory. This allows the data set to be accessed later without having to query the data again via the Data Portal.
For an example of this function, see Lab Dev: Customer Aging Detail .
For instructions on how to set up this function, see Setting Up the jDataPortal .
Function Arguments
DataPortalName The name of the Interject Data Portal that will be used as the data source for this function.
Type
String
Constraints
Max 255 char
If Blank
Function Error
DataResultNumber The index number of the data set requested. When multiple sets are returned from the data source, this parameter can specify the particular result set.
Type
Integer
Constraints
If Blank
Will return the first data set
Filter A valid SQL statement that normally follows a WHERE statement. This will filter the data.
Type
String
Constraints
Max 255 char; valid SQL statement
If Blank
Will not filter data
OrderBy A valid SQL statement that normally follows an ORDER BY statement. This will order the data.
Type
String
Constraints
Max 255 char; valid SQL statement
If Blank
Will not order data
CommandOverride A string indicating a different Stored Procedure or API to run. This feature can only be done by ClientAdmin or a SysAdmin roles .
Type
String
Constraints
Max 255 char
If Blank
Will not override
ConnectionOverride A string indicating a different data connection to run.
Type
String
Constraints
Max 255 char
If Blank
Will not override
=jDataPortal("NorthwindMultiRecord_Pull",2,"[CompanyName] Like '%s%'","[CustomerID] ASC")
Function Composition
Argument Name
Example Mapping
Explanation
Function Name
=jDataPortal
The name of this function.
Data Portal Name
NorthwindMultiRecord_Pull
This function will use the "NorthwindMultiRecord_Pull" Data Portal for the data source.
Data Result Number
2
This data connection will use the 2nd result set previously held in memory from previous calls.
Filter
[CompanyName] Like ‘%s%’
This data connection will only return records whose CompanyName contains an 's' character.
OrderBy
[CustomerID] ASC
The data result will be ordered by the column CustomerID in ascending order.
CommandOverride
Left blank to indicate to not override the command.
ConnectionOverride
Left blank to indicate to not override the connection.