Help Manual - CDM Source

Documentation on SSIS CDM Source component

Using the CDM Source Component

The CDM Source Component is an SSIS data flow pipeline component that can be used to read/retrieve data from Common Data Model (CDM) Data. The data from the source objects are read based on schema description files from the CDM folder.

This component includes the following two pages to configure how you want to read data.

  • General
  • Columns

General Page

The General page of the CDM Source Component allows you to specify the general settings of the component.

SSIS CDM Source component - General

Connection Manager

The CDM Source Component requires a connection in order to connect to the CDM folder. The Connection Manager drop-down will show a list of all connection managers that are available to your current SSIS package.

This component will support the following connection managers:

  • Local File
  • FTPS Connection Manager
  • SFTP Connection Manager
  • Amazon S3 Connection Manager
  • Azure Blob Connection Manager
  • Azure Data Lake Storage Connection Manager
  • Azure Files Connection Manager
  • Box Connection Manager
  • Dropbox Connection Manager
  • Google Cloud Storage Connection Manager
  • Google Drive Connection Manager(since v21.2)
  • Hadoop Connection Manager
  • OneDrive Connection Manager
  • SharePoint Connection Manager (offered with the SSIS Integration Toolkit for Microsoft SharePoint)
  • WebDAV Connection Manager
Manifest Folder Path

Choose the Manifest Folder Path that contains the data and description files. Based on the connection manager chosen, the ellipsis (…) button when clicked will open the storage path.

Manifest Type

The Manifest Type can be chosen from the below two options

  • Model 
  • Manifest 
Default Manifest

The Default Manifest would be chosen from the folder path based on the manifest Type specified in the previous field.

Note: Click on the lock icon to make this field editable, and then click on the ellipsis button to select another default manifest file to change the default one.

Source object

The Source Object will be available to select based on the manifest type and the default manifest. These would be the entities described within the schema document.

Partition

The Partition for the data can be specified here. This would be to choose a specific partition or portion of data as specified in the schema description file.

Output Timezone (Since v23.1)

Output Timezone option specifies how CDM datetime values are retrieved. There are 3 options available:

  • Unspecified
  • Local
  • UTC
Refresh Component

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata. 

Expression fx Icon

Click the blue fx icon to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Icon

Click the Generate Documentation icon to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Column Page

The Columns page of the CDM Source Component shows you all available attributes from the Source Object that you specified on the General page.

CDM Source Component - Columns

On the top left of the grid, you can see a checkbox, which can be used to toggle the selection of all available fields. This is a productive way to check or uncheck all available fields.

The Columns Page grid consists of:

  • CDM Field: Column that will be retrieved from the Source Object.
  • Data Type: The data type of this field.