Adding & Editing Report Datasources
  • 25 Mar 2024
  • 5 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Adding & Editing Report Datasources

  • Dark
    Light
  • PDF

Article summary

This topic relates to the following sections:

Prerequisites

As part of the build of a Datasource, the user must manually add the working database to the Database Server (this includes SQL Server, HANA DB, or Oracle Server). The prerequisite steps are now complete.

About Report Datasources

The initial system setup provided by using Guided Setup, builds the Environments (DEV or LOAD) and then assigns for each environment a Reporting Cache datasource and a Migrate datasource. These datasources are not stored within the Syniti Knowledge Platform system Data Catalog. They are created and stored locally in Syniti Migrate within the Environments and assigned to the Servers created within Guided Setup. Once the Migration Working Server is setup, these datasources are created and linked to that server. The Report datasources store table data of the reports generated during each ETL processing run. A Report Datasource is created for each Environment to store a snapshot of these reports. Refer to section Adding & Editing Migrate Datasources for details of that process.

A wizard is used to create the Migration Working Datasources and Report Cache Datasources. The user should build each datasource from within Administer > Setup > Environments as they build out the Environments.

View the following page by navigating to Administer > Setup > Environments from Syniti Migrate Homepage or access by using the Guided Setup.

null
Environments

Select the environment and click Edit icon to view details. Click the + Add icon next to the Report Cache Datasource to initiate the create wizard process.

null
Environments: Edit: Create working datasources

Add a Report Datasource

Click Add + icon next to Report Cache Datasource to open the wizard for Create a Report Cache datasource window.

Create a Report Cache Datasource

The Report Cache Datasources are created using two panels of fields - Details and Connection.

null
Datasource wizard: Add New Datasource

As the user completes field values, supportive fields then become available for entry. The fields vary by response of a prior field.

Section

Field

Description

Details

Datasource Name*

Enter the Datasource Name. (Required)

Details

Description

Enter the description of the Datasource.

Details

Comments

Enter descriptive comments to support this datasource.

Connection

Server

Enter the Migration Working Server.

Refer to section Administer > Setup > Servers for details.

Connection

Database Type

Field not relevant.

Connection

Database Name*

Enter the Database Name. (Required) Contingent upon Server

Connection

Default Schema*

Enter the Default Schema. (Required) Contingent upon Server

Connection

Timeout(seconds)

The number of seconds this Datasource refreshes before it is stopped. Prevents excessive clocking. The default with no value is set by the Job Queue and Job Type, but generally defaults to 30 seconds.

Connection

User Name

This field is contingent upon the setup of the Datasource Server and value may become required.

Connection

Password

This field is contingent upon the setup of the Datasource Server and value may become required.

Click on the Show/Hide icon to view the Password entered.

Note

Fields in the Connection section are contingent upon the Server selected. The server should be the Migration Working Server.

From within the grid, if the user clicks to test a datasource that does not have server information, the system prompts the user to enter the connection info, and the validation status is set to unknown.

Edit a Report Datasource

View the following page by navigating to Administer > Setup > Environments from Syniti Migrate Homepage or access by using the Guided Setup. Click on the Report Cache link to open that datasource in Edit mode.

null
Environments: Link to Edit Report Cache Datasource
null
Datasources: Edit Details

The Details page for a Report datasource is very similar to other datasources in that there is a left side panel with Details, and the tabbed section on the right side panel that contains associated object data.

Section

Field

Description

Details

Application*

Select the Application. (Display Only)

Details

Instance*

Select the Instance. (Required)

Details

Datasource Name*

Enter the datasource name. (Required)

Details

Description

The description of the datasource.

Details

Active

Toggle for datasource Active/Inactive.

Note

Defaults as Active.

Details

Comments

Enter descriptive comments to support this datasource.

Syniti Catalog System

Import from Catalog Systems

Toggle to indicate that this datasource links to an Agent and Connection within Knowledge Platform Data Catalog system.

Connection

Server

Select from the drop-down list the available Datasource Server.

Refer to section Administer > Setup > Servers for details.

Connection

Database Name*

Enter the Database Name. (Contingent upon Server)

Connection

Default Schema*

Enter the Default Schema (Ex: dbo) Contingent upon Server

Connection

Timeout (seconds)

The number of seconds this datasource refreshes before it is stopped. Prevents excessive clocking. The default with no value is set by the Job Queue and Job Type, but generally defaults to 30 seconds

Connection

User Name

This field is contingent upon the setup of the Datasource Server and value may become required

Connection

Password

This field is contingent upon the setup of the Datasource Server and value may become required.

Click on the Eye icon to view the Password entered.

Stakeholders

Owner*

Select the Owner responsible for this Datasource. (Required)

Metadata

Import All

Toggle to flag import metadata for all tables of the Datasource.

Metadata

Last Refresh Date

Displays the last date of a refresh to import metadata for this Datasource.

SAP Data Services

Datastore

Source data. This Datastore is used in the Syniti Migrate automation XML.

Migration Details

Report Flag

Toggle to indicate that this datasource is set as Datasource Purpose of Report.

Migration Details

Working DB Flag

Toggle to indicate that this datasource is set as Datasource Purpose of Working.

Migration Details

Snapshot Flag

Toggle to indicate that this datasource is set as Datasource Purpose of Snapshot.

Audit

Various

These are the system generated values for auditing the work.

 

ID

Datasource GUID

 

SKP Asset ID

Displays the Asset ID for the datasource provided by Data Catalog.

At this point, the user may add new Tables and Columns to the existing Datasource. They may also edit the details section to update field values.

The left side of the Datasource Details page contains the Datasource Details fields. These fields are supportive of the Datasource Details, Connections, Metadata Import, Usage, and Attributes. At the header of this left side panel there are quick use icons as shown below:

Icon

Name

Use

SaveIcon

Save

The Save icon saves the current entries.

CancelIcon

Cancel

The Cancel icon leaves the current page without saving changed data.

Help

The Help icon links to the page in Syniti help text to provide detailed explanation of this section and use.

Additional Options

The Additional Options icon allows for selection of:

  • Import metadata - pull data for all active table/fields listed for this Datasource. Filtering is based upon criteria setup in Administer > Applications

  • View Debug Logs - Display the Debug Log for the most recent action for this datasource.

  • View History - Provides a list of changes for this datasource.

When finished with edits, click the Save  icon to complete.

Delete a Report Datasource

Should the additional migrate datasource not be needed, it may be deleted from the system if it does not have any tables referencing it. It is a required field of the Environments, so replacement with another valid migrate datasource is necessary. Refer to section Delete a Datasource within the Adding & Editing Datasources section for details of deletion.

Datasource Tables and Columns

On the right side of this page is the Tab for Tables & Columns. The Administrator or IT Lead is responsible for this tab of data. This page provides two panels - one for Datasource Tables, and then one for Datasource Columns. Refer to section Adding & Editing Tables or Columns for details.

Subsequent Steps

Upon saving the new datasource, the system automatically attempts to import metadata (import the tables and fields as they exist in the tables in the system identified). Should this step not complete as expected, refer to section Catalog > Datasources > Adding & Editing Datasources > Import metadata for details of this subsequent process in Migration.


Was this article helpful?

ESC

Eddy, a generative AI, facilitating knowledge discovery through conversational intelligence