Documentation Index

Fetch the complete documentation index at: https://skthelp.syniti.com/llms.txt

Use this file to discover all available pages before exploring further.

My Profile

Prev Next

Note

Do not change the values in the following fields on the My Profile page. They are deprecated and are not used, but changing their values can cause issues:

  • Password

  • Re-enter Password

  • Full Name

  • Email

This information is stored in the Syniti Knowledge Platform on the My Account page, accessed when you select My Account from the Profile menu.

Change Locale

Locale sets the date format that displays on pages in Syniti Migrate.

To change your Locale for your Migrate profile:

  1. Click the User Profile  icon and select My Profile.

  2. Select your default region from the Locale list box.

    Note

    The Locale sets the language used to translate page-level columns into the selected language. Refer to Internationalization Translations for details about adding and editing column translation.

  3. Click Save.

Create a Migrate Public API Token

Note

Previously known as the report refresh token, the Migrate Public API Token now supports integration with any external system. Both the  report-refresh-token and api-key headers are accepted for backward compatibility, though api-key is the recommended approach for new implementations.

This token, which is specific to the user and the tenant, is used to access Migrate APIs and integrate with external systems, for example, accessing Data Services systems for Migration Reporting. The reporting APIs must be secure. The communication between Data Services and the reporting APIs must have a type of password access for security. The token is that security.

Migrate Public APIs are tenant-specific. To access public APIs reference documentation, replace <tenant_name> in the following URL with your tenant name: https://<tenant_name>.migrate.syniti.com/swagger/index.html

To create a Migrate Public API token:

  1. Click the User Profile  icon and select My Profile.

  2. Under Migrate Public API Token, click the Create New Token button to generate a new API token. This token GUID can be used in Data Services to provide security for running reporting.

  3. Click the Continue button on the Validation warning.

    Note

    Store this Migrate Public API token in a secure location, as you cannot view the token after it is initially created. Migrate hashes this token against the token stored, and if they don't match, it does not run the reports in the integrated systems.

    This new Authorization Policy is in effect only in the Migration Reports Refresh area. If a user has authenticated via a token, then they are allowed to hit these endpoints.. That is the only area of Migrate that these tokens grant access to.

    Note

    In Data Services, you must add this token in the User Specific Variables section.

Using the Public API Token

You can use this token to authenticate API requests by including it in the HTTP header:

  • Recommended: Use the api-key header: api-key: <your-token>

  • Legacy: Use the report-refresh-token header: report-refresh-token: <your-token>

Both headers are supported for backward compatibility.

Data Services Integration (Legacy)

  1. In Data Services, create the WebService Datastore.

  2. Add the Migrate Public API Token to the Standard HTTP Header Fields section as shown below. After clicking the detail for the Standard HTTP Header Fields option, paste the Migrate Public API Token into the Default Value field.

    • Header Name: api-key (or report-refresh-token for legacy systems)

    • Default Value: <your-public-api-token>

      Datastore for xAppMigrate_WebService

  3. Click OK.

Theme Settings

The Theme Settings toggle sets the entire Migrate module to view in high contrast. The default of this field is inactive. Set the toggle to active to change the pages for view in high contrast setting.

This action changes the look of every page within Migrate to be shown with this same white / black contrasting color for Accessibility Features. Refer to section High Contrast Color Palette for details of Accessibility for High Contrast.