Applications
  • 25 Mar 2024
  • 6 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Applications

  • Dark
    Light
  • PDF

Article summary

This topic relates to the following sections:

About Applications

As a prerequisite to adding a datasource to Syniti Migrate, within Knowledge Platform the Connection and Agent for the datasources must be setup, and the within Syniti Migrate the Applications may require configuration.  Applications provide additional field information for each type, and the tables and columns are a subset list of the data relevant for imports from that Application. 

Should the Datasource be set up as Import All not Active, then the system looks to the list of tables within Applications to refresh the metadata.  Also, if the Application stores many datasources with same set of tables, then this setup allows the user to import the same set of default tables into each of the datasources as a group. 

Within the Applications section, the system is delivered with a standard set of Applications (Ex: ECC, FLATFILE, JDE, S4H, Syniti Migration, and Custom). These delivered Applications are not configurable (they do not allow change or delete). Added Applications allow for Active/Inactive, change, and delete within this section. These settings come with the system and it is not advisable for the team to make changes to the delivered Applications.

Applications contain the tables and columns that are relevant to the import process. Users may mark the tables as Active or Inactive and assign them to Import Groups to set the list of imports for the Applications. This regulates the quantity of data pulled into the system (not every table is pulled for the datasource).  Columns are only necessary should the intent be to pull in a subset of the columns available for that table, otherwise, all columns are assumed to be relevant. 

Note

If the user should mark an Application as Inactive, it will no longer display within the Datasources Hierarchy or Application pages.  Only those Applications that have no active Datasources will be able to save as Inactive.  Should the user mark an Application as Inactive that contains an active Datasource, an Error message will display preventing the save of data.

Dependencies & Prerequisites

Before working in Applications, steps must be completed in Syniti Migrate to enable the availability of the metadata for design. These steps include:

  • Create Datasource Connections and Connectors within Knowledge Platform for the System Datasource table(s).

  • Create the System Datasource within Catalog > Datasources and import the metadata for the tables and columns.

Working in Applications

View the following page by navigating to Administer > Advanced > Applications from the Syniti Migrate home page.

null
Applications: List

Adding an Application

From within the main Applications page, click on the Add   icon in the Applications panel to open the Application page.  Refer to Catalog > Datasources > Adding & Editing Applications when adding a new Application as this is the same page that is used in that section of the manual.  The tables and data are shared. 

null
Applications: Add New Application

Fill in the fields within Application details section within left side panel as shown below.

Section

Field Name

Description

Details

Name*

The name of the Application. (Required)

Details

Description*

The Application description. (Required)

Details

Prefix

Enter any Prefix is applicable for this Application.

Details

Vendor

Enter the Vendor name for this Application.

Details

Website

Enter the website URL if one is applicable.

Details

Active

Toggle switch to make the table Active/Inactive.

Note

Defaults as Active.

Technical Details

SAP

Toggle to active if table is stored in SAP.

Technical Details

Table Extract SQL

Allows filter by SQL scripting for Table extract.

Technical Details

Column Extract SQL

Allows filter by SQL scripting for Column extract.

Technical Details

Check Table SQL

Allows filter by SQL scripting for Check Tables. (Value Mapping)

Technical Details

Extract Notes

Enter text to provide notes on this extract.

Content Review

Review Status

Select from the drop-down list the current status. (Required)

Note

Defaults as 'NS - Not Started'

Content Review

Reviewed By

This is a display only field - updated by the cycle of review.

Content Review

Reviewed On

This is a display only field - updated by the cycle of review.

Audit

Various

These are the system generated values for metrics reporting and auditing the work.

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

Edit an Application

To edit an Application, click on the Edit   icon on the left side of the Applications panel to edit.  Refer to Catalog > Datasources > Adding & Editing Applications when editing an Application as this is the same page that is used in that section of the manual.  The tables and data are shared. 

null
Applications: Edit Application

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

Delete an Application

The Syniti Migrate system comes with pre-installed Applications that are set to not allow for deletion.  The Delete icon is grayed out rather than dark.  Most likely it is safer to mark an Application as Inactive rather than delete it.  This maintains the history of the application and prevents down stream issues. 

When marking an Application as Inactive, the system provides a validation against active Datasources that may be attached to the Application.  If there are active Datasources attached, an Error message displays to indicate that the toggle switch may not be altered to Inactive. 

Add an Application Table

Each Application will provide a list of the associated tables for that Application.  These tables may be set to Active or Inactive, and they may be set as a Check Table. 

Each Applications table will be added by clicking on the Add   icon on the top right corner of the Default Application Tables panel to open the Application Table window.

null
Applications: Applications Table Add

Field Name

Description

Table*

The name of the Applications table. (Required)

Description

The table description.

Table Type*

Enter a text entry for the Table Type. Ex:TRANSP, TABLE (Required)

Import Group

Enter the Group Name for this table.  Used for objects that use many tables to group them together.  Ex: BusinessPartner, Material Master, etc.

Active

Toggle switch to make the table Active/Inactive.

Note

Defaults as Inactive.

Active For Value Mapping

Toggle for a check table.

Note

Defaults as Inactive.

Snapshot System Where Clause

Enter the SQL scripting for filter of Where Clause for this table to use during Repopulate of data using the Syniti Replicate system. See NOTE.

Table Comments

Enter text to provide additional comments for the table.

Note

The Snapshot System Where Clause filters data from the System Datasource to the Snapshot Datasource using Syniti Replicate.

Note

If the replication exists in Syniti Replicate prior to adding a value to this field, the next repopulate attempts to add the Where Clause to the replication and save the change.

Note

Once the Where Clause has been stored in the replication, this job may be run from either Syniti Replicate or from Syniti Migrate with the same outcome.

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

Edit an Application Table

To edit an Applications Table, click on the Edit   icon on the left side of the Applications Table to open the Applications Table Details window.

null
Applications Table: Edit

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

Add Columns for a Table

In the rare case that the table contains many columns, some of which are not relevant, the user may want to only refresh from a subset of columns.  In this case, columns are added and then each column that is relevant is marked as Active to provide a subset of table columns.

The user should have built out the Datasource, Added the Table, and then Imported the metadata for this table prior to completing these steps.

To add the columns for a table listed in an Application, highlight the table, and then click ADD COLUMNS   button.  The system pulls in every column for that table highlighted.  This action works only if the table is already listed in the Application as a Datasource and has columns.  This step is to reduce the number of columns from all to partial. 

If the table is registered and successfully refreshes metadata, then this step is successful. 

Note

Very rarely is this process needed.  For tables that are VERY large, as example BSEG, with many columns, this step would be practical.  But, for most tables this step is not needed. 

null
Applications: Add Column: Warning message

The system warns that this table must exist within Datasources for the columns to be able to copy into this page.  Click OK button to proceed. 

If the action is successful, the columns display within the panel for Columns.  The Key fields automatically are marked as Active.  The user should now mark individually each column that should be Active.  All columns, other than the Key Fields, default as Inactive so that the user has a subset to manage in this effort. 

Note

Regardless of whether the table selected is Active or Inactive, the ADD COLUMNS action runs if the button is clicked. Only the Key fields will show as active once columns have been added.

null
Applications: Add Columns: Display

The user may view the details for each column by clicking View Details  icon.  None of the fields on the View Application Column window may be edited. 

null
Applications: View Column Details


Was this article helpful?

What's Next
ESC

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