Maintain Working Datasources
  • 25 Mar 2024
  • 9 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 is 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 of 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 to specifically 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 and within the panel Environment Datasources and a list of environments will display. Each Environment will link to a working datasource as shown in the image below.

null
Development Areas

Click the MANAGE DATASOURCES  button to open the Datasource Instance Working Databases for the Development Area selected. 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.

null
Development Areas: Manage datasources

Add a Working Datasource

Click Add  icon open the wizard for Create a new datasource window.

Datasource 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 will determine the type of Datasource (Working). These are the databases used to convert and migrate the data - Stored in Migration Working Database Application Ex; WRKOTC, WRKPTP

null
Datasource wizard: Add New Datasource: Usage

As the user completes field values, supportive fields will then 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 on the NEXT  button to proceed to the page tab - Details.

Datasource Details Tab

The Details tab is standard for all Datasource Purpose types.

null
Datasources: Add New Datasource: Details

Fill in the details 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 will become active.

Click on the NEXT  button to proceed to next page tab - Connection.

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, so if there were no connection for this Datasource, the user could click on Next immediately to pass onto the tab for Attributes. The server is the Migration Working Server.

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

  • If the user does not provide any connection info, the connection status is set to 'unknown' (no test is performed). This allows the user to create a datasource and fill in the server later (which happens often in the field).

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

From within the grid, if the user clicks to test a datasource that does not have server information, the system will now prompt the user to enter the connection info, and the validation status will be set to unknown. This will persist until the datasource actually has server info configured.

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

null
Datasources: Add New Datasource: Connection

Once a Server is selected, the associated fields and requirements will update. In this example, SQL Server is the database and the connection is one made to the Migration server. The fields and requirements may change depending upon the Server selected.

null
Datasources: Add New Datasource: Connection: SQL Server

Fill in the Details 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.

XML

Datastore

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

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 will have access to view the Password going forward. The Show/Hide  icon for viewing the password will not be available to anyone who is not provided the Role of Admin.

Note

The section for XML will be visible within Datasource details IF the ETL Tool <> Syniti Migrate (EX: Data Services). If the ETL Tool field within Administer > Setup > Parameters page is set to Syniti Migrate, the XML section will be hidden.

Click NEXT  button to proceed to the Attributes page 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.

null
Datasources: Add New Datasource: Attributes

Fill in the Attributes fields for this Datasource. There may be Attributes and Stakeholders stored on this tab.

Select the value for Owner which is required, and click FINISH button to Save and close the wizard.

Errors during Save

Should the Datasource have issues from the setup, an error will display and the data will not save.

null
Datasources: Add Datasource: Error message

Verify the Connection(s)

Upon saving the new Datasource, the user should verify that the connection is active. Select the Datasource and click on Connection  Icon to initiate a check against the system. If the connection is successful a message will display "Primary - Connection success".

null
Datasources: Verify Connection

If the Connection is not successful, the tables and columns will not import and metadata will not process successfully. The Job Queue will run, but no outcome of data will be present. This verification is extremely important as well as the setup of the Datasource and Snapshot.

null
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.

null
Datasources: Edit Details

Note

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

The Details page for Datasource is very similar to Instance and Application 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 to make the datasource Active/Inactive.

Note

Defaults as Active.

Details

Environment*

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 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 will refresh 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.

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.

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 will contain the Datasource Details fields. These fields are supportive of the Datasource Details, Connections, Metadata Import, Usage, Attributes, and Content Review. Each section of this panel will store valuable information. At the header of this left side panel there are quick use icons as shown below:

Icon

Name

Use

SaveIcon

Save

The Save icon will save the current entries.

CancelIcon

Cancel

The Cancel icon will leave the current page without saving changed data.

HelpIcon

Help

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

OptionsIcon

Additional Options

The Additional Options icon will allow for selection of:

  • Import metadata - pull data for all active table/fields listed for this Datasource. Filtering will be 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 Working Datasource

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

null
Datasources: Datasource: Delete
null
Datasources: Datasource: Delete Error message

Datasource Objects

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 one for Datasource Columns. Refer to section Catalog > Datasources > Adding & Editing Tables or Columns for more details on this topic.


Was this article helpful?