Maintain Working Datasources
  • 23 May 2024
  • 10 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Maintain Working Datasources

  • Dark
    Light
  • PDF

Article summary

This topic relates to the following sections:

About Working Datasources

In the scenario where a project uses a DEV and LOAD environment, the user creates additional Datasources for working database for each environment. Within a Development Area there may be multiple environments and each is assigned a Datasource. The DEV working datasources are created manually as part of the migration build - They are critical to the mapping of fields, reporting, and XML scripting.

The Development Area is assigned to the Subject Area within Project Setup and assigned to the Dataset imported for the same subject area by default. This value determines where the SQL tables are built for the Target and Working tables of the Mapping - as part of the DDL scripting, and the default (DEV) value is used.

This section of the system is extremely important. Each Development Area may contain multiple Environments. (Ex: wrkMDG_D and wrkMDG_L)

Prerequisites

As part of the build for a working datasource, the user manually adds the working database to the database using a prefix of WRK (this will include SQL Server, HANA DB, or Oracle Server).

The prerequisite steps are now complete.

This section refers specifically to working datasources created within the Development Areas section of the system.

A wizard is used to create the Migration Working Datasources. The user should build each datasource from within Development Areas as they build out the Environments.

View the following page by navigating to Administer > Setup > Development Areas from Syniti Migrate Homepage or from within the Guided Setup process. Select the development area in the Environment Datasources panel and a list of environments is displayed. Each Environment links to a working datasource as shown in the image below. If the link does not provide working datasources, they need to be built.

Development Areas

Click the Manage Datasources button to display the Instance in Working Databases page. Working datasources are provided in a grid in the Datasources panel. To add a working datasource to the Working Database, click the Add icon to start the wizard process from this page or on the Manage Development Areas page.

Development Areas: Manage Datasources

Add a Working Datasource

Click the Add icon to open the wizard for Create a New Datasource dialog box.

Usage Tab

This is a step-by-step setup that includes providing values to the Usage, Details, Connection, and Attributes tabs of the Wizard process.

The Usage tab determines the type of Datasource (Working). These are the databases used to convert and migrate the data - Stored in the Migration Working Database application, for example, WRKOTC, WRKPTP.

Working Datasource wizard: Add Datasource: Usage

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

Section

Field

Description

Usage

Datasource Purpose*

The value will display as Working. (Required)

Click the Next button to proceed to the Details tab.

Datasource Details Tab

The Details tab is standard for all Datasource Purpose types.

Working Datasources: Add Datasource: Details

Complete the fields mentioned in the following table for the working datasource:

Section

Field

Description

Details

Application*

The Application is provided as 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 to make the datasource Active/Inactive.

Note

Defaults as Active.

Details

Environment*

Select Environment for this datasource. (Required)

Details

Comments

Enter descriptive comments to support this datasource.

Note

Once required fields are entered, the Next button becomes active.

Click the Next button to proceed to the Connection tab.

Datasource Connection Tab

Connection details are entered into this tab of the Datasource.

Note

Fields on the Connection tab are contingent upon the Server selected. If no connection for this Datasource is selected, then the user could click Next immediately to move on to the Attributes tab. The default server is Migration Working Server.

Based upon the structure of this setup, should the Connection section be left empty, the following will happen:

  • If connection info is not provided, the connection status is set to Unknown (no test is performed). The datasource can be created later and added along with the server (which happens often in the field).

  • If the user provides server information (server and database names), but does not provide the username and password, the system attempts to test the connection using the credentials from the server and updates the status accordingly.

In the grid, if the user clicks to test a datasource that does not have server information, the system prompt the user to enter the connection info, and the validation status is set to unknown. This validation continues until the datasource server info is configured.

Select the Server from the list of servers created within the Guided Setup for Servers.

Working Datasources: Add Datasource: Connection

Once a Server is selected, the associated fields and requirements are updated. In this example, SQL Server is the database and the connection is made to the Migration Working Server. The fields and requirements may change depending upon the Server selected.

Complete the fields mentioned in the following table for this Datasource connection:

Section

Field

Description

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) (Required)

Connection

Default Schema*

Enter the Default Schema. (Ex: dbo) (Required)

Connection

Timeout(seconds)

If a timeout other than 30 seconds is needed for this Connection, enter one otherwise leave the default as blank.

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.

SAP Data Services

Datastore

Name of the Data Services Datastore from which Jobs will pull Source data. This Datastore is used in the Syniti Migrate automation XML for SAP Data Services.

SAP Data Services

Datastore Rfc

Name of the Data Services Datastore used for an RFC connection from which Jobs will pull Source data. This Datastore is used in the Syniti Migrate automation XML for SAP Data Services.

Note

All Server and Datasource Passwords are encrypted while at rest in the Database providing a secure environment for client data and access through the Internet. Once the user name and password have been saved into a Datasource, only the Admin role has access to view the Password. The Show/Hide icon for viewing the password is not available to anyone who is not provided the Role of Admin.

Note

The section for XML is visible within Datasource details. If the ETL Tool <> Syniti Migrate (For example, Data Services). If the ETL Tool field on Administer > Setup > Parameters page is set to Syniti Migrate, the XML section is hidden.

Click the Next button to proceed to the Attributes tab.

New Datasource Attributes Tab

The tab for Attributes is the final step in the setup for a working datasource. Entries are optional and based upon the configuration settings wiithin Administer > Advanced > Attributes.

Working Datasources: Add New Datasource: Attributes

Complete the fields in the Attributes tab for this Datasource. Attributes and Stakeholders may be stored in this tab.

The value for the Owner field is required and defaults to the current user. Click the Finish button to save and close the wizard.

Errors During Save

Should the Datasource have issues from the setup, an error displays and the data is not saved.

Working Datasources: Add Datasource: Error message

Verify Connection(s)

Upon saving the new Datasource, the user should verify that the connection is active. Select the Datasource and click the Status icon to initiate a check against the system. If the connection is successful, the following message is displayed: Primary - Connection success.

If the Connection fails, the tables and columns are not imported and metadata does not process successfully. The Job Queue will run, but the data is not processed. This verification is extremely important with the setup of the Datasource and Snapshot.

Working Datasources: Verify Connection: Error Messages

Subsequent Tasks

Upon saving the new Datasource, the user should attempt to Import metadata (import the tables and fields as they exist in the tables in the system identified). Refer to section Catalog > Datasources > Adding & Editing Datasources > Import metadata for details of this subsequent process in Migration.

Edit a Working Datasource

To edit an existing Working Datasource, click on the Edit icon to display the Datasource Details page.

Working Datasources: Edit Details

Note

Once the Username and Password have been saved into a Datasource, only the Admin role has access to view the Password. The Show/Hide icon for viewing the password is not available to anyone who is not provided the Role of Admin.

The Details page for Datasource is very similar to Instance and Application. A panel on the left side with Details and a section on the right-side panel contains the 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 to make the datasource Active/Inactive.

Note

Defaults as Active.

Details

Environment ID*

Select an environment.

Details

Comments

Enter descriptive comments to support this datasource.

Syniti Catalog System

Import from Catalog Systems

Toggle to indicate that this datasource links to a Tenant 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 stops. Prevents excessive clocking. The default with no value is set by the Job Queue and Job Type, but generally defaults to 30 seconds

Connection

Username

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*

(Required) Select the Owner responsible for this Datasource. A link is provided to view more details.

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.

SAP Data Services

Create Snapshot Tables

Button to create all Snapshot Datasource Tables listed within the working Database system.

SAP Data Services

Build Import XML

Button to build the automation XML scripting for Datasource Import within the ETL.

SAP Data Services

View Import XML

Button to view the automation XML scripting for Datasource Import within the ETL.

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.

The user may add new Tables and Columns to the 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, Attributes, and Content Review. 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.

HelpIcon

Help

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

OptionsIcon

Additional Options

The Additional Options icon allows for selection of:

  • Import Metadata: Pulls data for all active table/fields listed for this Datasource. Filtering is based on the Import All toggle and criteria criteria setup in Administer > Advanced > Applications.

  • View Debug Logs: Displays the Debug Log for the most recent action for this datasource.

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

Click the Save  icon to complete the Datasource Details page.

Delete a Working Datasource

Should the working datasource is not needed, it may be deleted from the system if no tables are referenced.

Working Datasources: Datasource Tables Referenced
Working Datasources: Delete
Working Datasources: Delete Error message

Datasource Objects

On the right side of this page you can view the Datasource Tables tab. The Administrator or IT Lead is responsible for this tab’s data. The Datasource Tables and Datasource Columns panels are available in this tab. Refer to Catalog > Datasources > Adding & Editing Tables or Columns for more details on this topic.

Objects of working datasource


Was this article helpful?

ESC

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