Gigya Job Openings

Exporting Screen-sets

Skip to end of metadata
Go to start of metadata


Natively exporting Screen-Sets between sites is a feature of the Gigya Console. You can export any existing screen-set to any other site within your Gigya Console. It is a quick and stream-lined process to exchange your customized screen-sets between any of your active sites. This may be especially convenient if you have a highly customized set of screens that you currently use and want to use the same screens on another site that you maintain, while continuing to have the ability to use the UI builder as an editor. By using the Export Screen-Set feature you can continue to use the UI builder on the new site (provided you can use it on the original).

Note: If you have previously used the Advanced Customization tool on your screen-set and are unable to use the UI builder any longer, when you export it, the exported screen-set will also not be able to use the UI builder.
Note : The Screen-Sets tool is part of the Customer Identity  (RaaS) package, which is a premium platform that requires separate activation. If it is not part of your site package please contact your Gigya Customer Engagement Executive or contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's site.

Exporting Screen-Sets

These are the step-by-step instructions for Exporting Screen-Sets from one existing site to another within your Gigya Console.

If you already have a customized screen-set group that you would like to use on multiple site properties within your account:

  1. Copy the apiKey of the target site from your Admin Console dashboard.
  2. Enter the Screen-Sets tab of the console for the site you wish to export from.
  3. Navigate to the Screen-set you wish to export and click the corresponding Export button.

  4. Enter the apiKey of the target site in the Target API Key field of the Export Screen-Set window.

    1. If you have used the Export feature previously, the API Key you last used will appear pre-entered in the Target API Key field.

  5. Edit the Target Screen-Set ID, if different from the current screen-set name.
  6. Tick the Allow overwriting an existing screen-set with the same ID checkbox, if a screen-set with the same name already exists on the target site that you want to replace, i.e., if you are exporting a customized set of the 'default' screen-sets.

    To export a complete set of screen-sets, in order to continue to use the UI Builder on the set, you must export them using the current names. (e.g., Default-LinkAccounts, Default-ProfileUpdate, Default-ReAuthentication, Default-RegistrationLogin ).

    Exporting a complete collection of screen-sets (4 screen-sets) using a unique Screen-Set ID (different than the original you are exporting) will require editing of the source code of each set (using the Advanced Customization button) to reflect the custom naming scheme and you will no longer be able to use the UI Builder on those screen-sets!

  7. Press the Export button.
  8. A copy of your exported Screen-Set will now be listed within the Screen-Sets tab of the target site.
  9. To confirm the export was successful, navigate to the target site's Screen-Sets page and locate the imported Screen-set by the Screen-set ID you entered in the Export Screen-Set dialog.  If it appears in the target site's list of avaibable screen-sets, the export was successful.

Possible exporting errors

If there were any errors encountered during the export process, they will be presented after clicking the Export button of the Export Screen-set dialog.

Some possible errors include:

  • A screen-set with the same ID already exists on the target site. Use the 'allow overwriting' checkbox to overwrite it.

    • This will occur if there is an existing screen-set with the same ID already on the target site. To resolve this you can either give the new screen-set a unique ID or check the "Allow overwriting" checkbox to replace the one currently on the target site.

  • Invalid API key or missing permissions.

    • You entered the API incorrectly or you do not have the necessary permissions to export the screen-set. After verifying the API Key, if this error persists, you should contact the console administrator or contact Gigya Support via the Support tab of your Gigya Console, if you are the account administrator.

  • Please use the 'Duplicate' option to copy within the same site.

    • The API key you entered belongs to the same site you are trying to export from. Enter the API key of the target site located in the Admin Console dashboard (i.e., not the API Key of the site you are exporting from).

  • The API Key you specified belongs to a member site . Please use the API Key of the Master site instead.

    • You entered the API Key of a member site in an SSO Group configuration. The Screen-Set must be exported to the Master site. Please use the API Key of the Master site for the Site Group the target site is a member of.
      • The API Key of the Master site the member site belongs to will appear at the bottom of the error message, you may copy it from there for pasting into the Target API Key field when you close the error dialog.

  • Other errors.

    • In the event you receive an error other than those specified above, the server error will be displayed in place of the standard error notification.


Setting up the exported Screen-Set

It is important to note that you should export all the screen-sets within any given collection to the new site maintaining the same prefix ID (Screen-Set ID).

Once the screen-set is successfully exported to the new site, there are some important additional steps you need to follow to ensure proper functionality of the newly imported screen-set on the target site.

  • Mandatory states are not copied.

    • All fields are reset to their default values, i.e., any field that you set or unset to or from a mandatory field is now reset to its default and needs to be manually updated via the UI Builder.

  • In cases where you have custom fields within the screen-set, (e.g., data.x), all relevant fields need to be mapped.

    To map the custom fields follow the steps below:

    • Open any relevant screen-set in the UI builder.
    • Map all relevant fields to the correct data types.
    • Click Save.

      This process ensures that any missing schema fields are created within the new site and that they refer to the correct data types.

  • Manual setSchema configurations are not copied.

    • Any configuration that was manually done by setSchema, i.e., encryption, write access, etc., need to be reconfigured.

  • Site policies are not copied.

    • This includes password strength policy, regEx, etc. 
    • All Site Policies will need to be reconfigured.


Additional Information

For more information on Screen-sets and their customization please see the following guides.



  • No labels