Default Screen-sets

Skip to end of metadata
Go to start of metadata

Gigya provides a collection of screen-sets by default. The collection contains four screens identifiable by their "Default-" prefix. Each screen-set in the collection is composed of a series of screens for use in a particular situation, see the table below for a description of the function of the default screen-sets. 

Lite Registration and Subscription Management are premium platforms that require separate activation. For inquiries, contact your Account Manager by filling a support form. You can access the support page by clicking Support on the upper menu after logging into your Gigya Console.

  • Add New Collection - When you create a new collection, the default screens-sets and the screens they contain will automatically be created with the collection prefix (ID) that you choose.  
  • Default CSS - Every screen-set collection uses the same CSS in all its screen-sets. To view the CSS open the Screen-set and select "Screens Style". 
  • Working Example - You can view a live demonstration of the default screen-sets in our Working Code Examples. To view documentation on the predefined flow of the default screen-sets, see Registration-as-a-Service.  To view their code, see the Gigya Administration Console (login required).

Screens in the Default Screen-Sets 

In the following table you can see a list of the screen-sets provided in each of the default collections. See the table below to view the screens contained in each screen-set. Note that there may be differences between mobile and web screens which have the same name.

Default Screen-Sets

Collection PrefixScreen-Set nameDescription of the screen-setNames of the screens in the screen-setNames of the screens in the screen-set menuDescription of the screen

Default-

RegistrationLogin

Screens used in registration and login.gigya-login-screenLoginBasic login screen.
gigya-register-screenRegistrationNew user registration screen.
gigya-complete-registration-screenRegistration CompletionScreen requesting additional information from a newly registered user.
gigya-forgot-password-screenForgot PasswordScreen allowing a user to reset their password.
gigya-forgot-password-success-screenForgot Password SentScreen notifying the user that the password reset email was successfully sent.
gigya-reset-password-screenReset PasswordScreen allowing the user to reset their password.
gigya-reset-password-success-screenReset Password SuccessScreen notifying the user that their passwrod has been reset.
gigya-password-change-required-screenMandatory Pwd ChangeMandatory password change screen (forced by the site policy).
gigya-verification-pending-screenVerification PendingScreen allowing an unverified user to request a fresh verification email.
gigya-tfa-registration-screenTFA RegistrationTwo factor authentication initialization screen.
gigya-tfa-verification-screenTFA VerificationTwo factor authentication request for verification screen.
gigya-verification-sent-screenVerification SentEmail verification pending screen.

LinkAccounts

Screens used when connecting an account to a social network.gigya-link-account-screenLink AccountScreen asking the user to confirm that a previously opened account is also theirs.
gigya-forgot-password-screenForgot PasswordScreen allowing a user to reset their password.
gigya-forgot-password-success-screenForgot Password SentScreen notifying the user that the password was successfully reset.

ProfileUpdate

Screens used when updating a user profile.gigya-update-profile-screenUpdate ProfileUpdates the User profile
gigya-tfa-edit-screenTFA EditTwo factor authentication edit screen.
gigya-change-password-screenChange PasswordEnter a new password screen.

ReAuthentication

Screens used when reauthenticating a user.gigya-reauthentication-screenReauthenticationScreen requesting that the user login to confirm their identity.
gigya-forgot-password-screenForgot PasswordScreen allowing a user to reset their password.
gigya-forgot-password-success-screenForgot Password SentScreen notifying the user that the password was successfully reset.

LiteRegistration

Screens used with Lite Registration and Subscriptions.gigya-subscribe-with-email-screenSubscribe with emailScreen asking the user to register to a pre-defined subscription.
gigya-subscribe-thank-you-screenThank youScreen thanking the user for signing up to the subscription.


Upgrading to the New Screen-Set Collections

Our new screen-sets add additional functionality, in particular user re-authentication and improved control over account linking options for users logging-in with social networks. Sites that were defined before August 31st 2015 use an outdated set of screen-sets that contain separate sets for both mobile and desktop applications. Sites that use these older screen-sets can continue using the existing screen-sets or, optionally, upgrade to the new screen-set collections.

Migrating to the new screen-sets is a three stage process:

  1. The new default screen-sets need to be created in the Gigya Console.
  2. The site policies need to be updated to use the new screen-sets.
  3. You need to update the API calls on your site.

The following instructions explain the process in detail. They assume that you have not made any changes to the default screen-sets and that your Log-In Identifier policy is set to "Email" (on the Policies page of the Gigya Console).

1. Gigya Console: Create the Default Screen-Sets

  1. Go to the Gigya Admin Console's Screen-sets page at https://console.gigya.com/site/partners/Settings.aspx#cmd%3DUserManagement360.ScreenSets (login is required).
  2. Click the Add New Collection button.

     
  3. Set ID to "Default", create a brief Description for reference and press the Add button. 

2. Gigya Console: Update Site Policies

Go to the Gigya Admin Console's Policies page at https://console.gigya.com/site/partners/Settings.aspx#cmd%3DUserManagement360.Policy (login is required).

Set Default Screen-set to (both):

  1. Web: Default-RegistrationLogin 
  2. Mobile Web: Default-RegistrationLogin


  3. Press the Save Settings button.

3. Your Site: Update API Calls

All APIs that reference screen-sets by name, in particular accounts.showScreenset, should reference the new screen-sets, for example: 

accounts.showScreenSet({"screenSet":"Default-RegistrationLogin"});

 

For details of the correct links, see the Default Screen-Set Flows.

Note: If your site is implemented using a CMS or EComm platform, you'll need to change the screen-set IDs in your platform's administration. Please refer to the Gigya module implementation guide of your specific platform.

 

Important Notes

If you make the Email Address a required field, you must also ensure that there is an Email field on the Registration Completion screen of your Screen-Sets.

If you enable Require Email Verification, then you must also make the Email Address a required field and be sure it is set as required in the site's schema and also ensure that an Email field exists on the Registration Completion screen of your Screen-sets.

Failure to include fields on the Registration Completion screen mapped to the appropriate schema field and set as required (as defined in your Site Policies or via checking the 'Required' checkbox in the items Properties of the UI Builder), will make it impossible for some users to register on your site if their chosen provider does not natively provide the required information (i.e., Twitter does not return an email address).