Data Source Details (2.13)
This page provides details for each type of data source for InterSystems Data Studio™. For guidance on how to create, edit, delete and test a data source, see Defining Data Sources.
Please note that some data sources require credentials. Create credentials before creating these data sources.
Structured Data Sources
Structured data sources provide access to data in a defined format, such as delimited files, database tables, APIs, and feeds.
Bloomberg
A Bloomberg data source retrieves data from a Bloomberg data sourceOpens in a new tab . This source is only available within InterSystems Data Studio™ with the asset management module.
For a Bloomberg source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. Select the saved credential that authorizes use of this data source.
Required. Specify the expiration date of this data source.
Optional. The local FileDir data source folder where files are staged.
To use the File Manager interface for staged files, create a FileDir data source before creating this data source, and select it here. If you do not specify a FileDir source, the system stages files in a temporary folder, and the File Manager interface is not available.
Commcise
A Commcise data source retrieves Commcise dataOpens in a new tab. This source is only available within InterSystems Data Studio™ with the asset management module.
For a Commcise source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog.
Required. Select the saved credential that authorizes use of this data source.
Optional. The location of the certificate file used to obtain an access token from the Commcise Auth server.
Required. The email address used as the Commcise user ID.
Required. The authorization server to use when connecting to Commcise.
Required. Commcise API server to use.
ExcelSingleFileDir
An ExcelSingleFileDir data source provides access to data stored in Microsoft Excel files that are periodically written to a directory accessible by Data Studio. Apart from the file format, this data source is the same as FileDir.
FileDir
A FileDir source is a source that provides data via files, periodically written to a specific directory within the file system. The file should contain data separated by delimiters; a common example is a comma-separated value (CSV) file. Another common delimiter is the tab.
For a FileDir source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The directory in which these files will be found, relative to the system base path. Because this is a relative path, it should not start with / or \ (but any leading path separator is automatically removed).
To avoid confusion, this directory should not be used by any other data source.
When you create a FileDir source, the system automatically creates the directory named by Interface Path Location , as well as the subdirectories Samples , Source , Work , and Archive . Using the File Manager explains the purpose of these directories.
GLEIF
A GLEIF data source provides access to data from the Global Legal Entity Identifier Foundation (GLEIF). This source is only available within InterSystems Data Studio™ with the asset management module.
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Optional. The base URL for the GLEIF API endpoint.
Optional. A REST endpoint used to verify the connection. This value is appended to the API Server path.
Optional. The local FileDir data source folder where files are staged.
To use the File Manager interface for staged files, create a FileDir data source before creating this data source, and select it here. If you do not specify a FileDir source, the system stages files in a temporary folder, and the File Manager interface is not available.
Guardian
A Guardian data source provides access to The Guardian OpenPlatformOpens in a new tab news feed, provided by The Guardian News & Media LimitedOpens in a new tab ; see https://open-platform.theguardian.com/documentation/Opens in a new tab .
For such a data source, provide the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The API key needed to access this data source.
JDBC
A JDBC data source provides access to a database via a JDBC connection.
For a JDBC data source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The credential that defines the username and password to access the database. Select the applicable credential from the dropdown list.
Required. Enter the JDBC connection string needed to access the database.
Required. Select the database vendor and version.
If you select this check box, it will be possible to project tables from the selected database as foreign tables within Data Studio. This is useful when it is not feasible or reasonable to load data directly into Data Studio. For example, a table may be extremely large and might not be queried frequently. A foreign table is read-only but can otherwise be accessed in the same way as local tables.
If you select this check box, also specify JDBC Foreign Table Local Schema , which is the default name of the schema to contain any foreign tables from this data source.
NYSE
An NYSE data source provides access to NYSE-related data. This source is only available within InterSystems Data Studio™ with the asset management module.
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Optional. A description of the entity. The default value is US - NYSE.
NYT
An NYT data source provides access to a news feed APIOpens in a new tab provided by The New York Times CompanyOpens in a new tab ; see https://developer.nytimes.com/get-startedOpens in a new tab .
For such a data source, provide the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The API key needed to access this data source.
REST
A REST data source provides access to a RESTful endpoint. Use this type of data source to connect to APIs that expose data over HTTP. For this type of data source, supply the following details:
Required. The unique name of the data source. This is the name users see when browsing the Data Catalog.
Optional. Select the saved credential that authorizes access to this data source.
Optional. The API key or token required to access this data source.
Optional. The base URL for the REST API endpoint (for example, https://test.example.com).
Optional. A REST endpoint used to verify the connection. This value is appended to the API Server path (for example, /oauth2/token).
Optional. The local FileDir data source folder where files are staged.
To use the File Manager interface for staged files, create a FileDir data source before creating this data source, and select it here. If you do not specify a FileDir source, the system stages files in a temporary folder, and the File Manager interface is not available.
Optional. REST endpoints that require custom processing.
After creating the REST data source, navigate to Data Catalog > REST Registry to add additional metadata.
RSS
An RSS data source provides access to an RSS feed. For such a data source, provide the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The URL of the RSS feed.
Required. The length of time to wait, in seconds, for a response from the RSS feed URL before throwing an error.
S3Delimited
An S3Delimited data source provides access to an S3 bucket that contains delimited files.
For an S3Delimited data source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The credential that defines the username and password to access the given S3 bucket. Select the applicable credential from the dropdown list.
Required. The name of the S3 bucket to access.
Optional. The session token to use when accessing the S3 bucket.
Optional. Location of the folder from which to load files. You can optionally include %RUNDATE in the path for the ISO date to be injected at the time the files are loaded. The root folder is used if one is not provided.
Optional. Location of the folder from which to import file schemas. You can optionally include %RUNDATE in the path for the ISO date to be injected at the time the files are listed. The root folder is used if one is not provided.
Optional. Location of the folder to archive previously loaded files. You can optionally include %RUNDATE in the path for the ISO date to be injected at the time of the archiving. The root folder is used if one is not provided.
Optional. Location of the folder to write files to, in the case when a recipe promotes data to a file on the given S3 bucket.
SAP4HanaAPI
A SAP4HanaAPI data source provides access to SAP S/4HANA data through OData v2 APIs.
For a SAP data source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The credential that defines the username and password to access the given SAP server.
Select the appropriate credential from the dropdown list.
Required. The host name of the SAP server (for example, from https://{host}:{port}/sap/opu/odata/sap/... ).
Required. The port to use on the SAP server.
Required. The number of times to retry if the SAP server returns a 500 error.
Required. Specifies which schemas should appear as options.
Salesforce
A Salesforce data source provides access to a Salesforce instance via the Salesforce API. Depending on the selected authorization flow, some connection details may differ.
For a Salesforce data source, specify the following details:
Required. Select the appropriate authorization flow for your Salesforce instance. Choose either password or client_credentials. The choice you make will alter what details are necessary to provide when creating this data source.
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required for the password authorization flow. The credential that defines the username and password to authenticate the Salesforce API. Select the applicable credential from the dropdown list.
Required. Select the appropriate SDS Datasource (DS) Credentials record for the ClientId and Client Secret.
Required. Specify the server used for authentication (which does not have to be the same server on which Salesforce is running).
Required. Specify the server on which the Salesforce API is running.
Optional. Specify the web server port to use, if that is not the standard port number.
SftpDelimited
An SftpDelimited data source provides access to an SFTP server that contains delimited files.
For an SftpDelimited data source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The credential that defines the username and password to access the given SFTP server. Select the applicable credential from the dropdown list.
Optional. Passphrase for key file.
Required. The host name of the SFTP server.
Required. The port to use on the SFTP server.
Optional. Additional command options to use when connecting to the SFTP server.
Optional. Location of folder to load files from in SFTP server. You can optionally include %RUNDATE in the path for the ISO date to be injected at the time the files are loaded. The root folder is used if one is not provided.
Optional. Location of folder to place files promoted to SFTP server. The root folder is used if one is not provided.
Optional. The local FileDir data source folder where files are staged.
To use the File Manager interface for staged files, create a FileDir data source before creating this data source, and select it here. If you do not specify a FileDir source, the system stages files in a temporary folder, and the File Manager interface is not available.
Optional. Upload your certificate file. Either click Select files... to open your computer’s file explorer, or drag and drop files into the section of the screen that says Drop files here to upload.
Unstructured Data Sources
Unstructured data sources provide access to document files stored in external systems such as S3 buckets and SFTP servers.
S3Document
An S3Document data source provides access to an S3 bucket that contains document files.
For an S3Document data source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Optional. The credential that defines the username and password to access the given S3 bucket. Select the applicable credential from the dropdown list.
Required. The name of the S3 bucket to access.
Optional. The session token to use when accessing the S3 bucket.
SftpDocument
An SftpDocument data source provides access to an SFTP server that contains document files.
For an SftpDocument data source, specify the following details:
Required. The unique name of this data source. This is the name that users see when they browse the Data Catalog .
Required. The credential that defines the username and password to access the given SFTP server. Select the applicable credential from the dropdown list.
Optional. Passphrase for key file.
Required. The host name of the SFTP server.
Required. The port to use on the SFTP server.
Optional. Additional command options to use when connecting to the SFTP server.
Optional. Upload your certificate file. Either click Select files... to open your computer’s file explorer, or drag and drop files into the section of the screen that says Drop files here to upload.
