GAM Activation Process

Official Content
This documentation is valid for:

When GeneXus Access Manager is activated (Enable Integrated Security property is set to TRUE), the GAM external objects that interact with the GAM API are always consolidated, but importing the GAM Examples into the KB is optional.

So, after enabling Integrated Security in the KB, a "GAM Activation Process" dialog box is displayed asking the user to choose whether to import the objects that are part of the GAM Web Backoffice and the example objects for Smart Device applications.

The user can also configure if he wants these examples to be automatically updated when a new build or upgrade of GeneXus is installed or if he wants to be prompted for it.

GAM objects are distributed in three sections (detailed below), but the GAM activation process only takes into account the GAM Web Backoffice  and the Examples of Smart Device objects (the GAM API  is always updated in the KB).

The three sections or categories of GAM objects are as follows:

Activating GAM

Upon activating GAM in the KB (set Enable Integrated Security property = True ), the following dialog box is displayed:

GAMActivationprocessGX152_PNG
Figure 1.

Three settings should be selected here:

  1. Web Administration is a check box to indicate if the GAM Web Backoffice is to be imported.
    It is checked by default because importing these objects is highly recommended. If Web Administration is imported, Login Object for Web property and Not Authorized Object for Web property are initialized. The Carmine Theme is used by the GAM Web Backoffice so it's imported with the rest of the objects.
     
  2. Smart Device Configuration is a check box to indicate if the Smart Device examples are to be imported.
    If the KB has a Smart Device generator this property is checked by default. If this option is checked, Login Object for SD property, Change Password Object for SD property, and Not Authorized Object for SD property are initialized.
    Note that the Smart Device Configuration check box is disabled if the Smart Device Generator is not present in the environment.

If none of the above are selected, only the GAM API is updated in the KB.

       3. The combo box is used to indicate how to handle the updates to those examples. The options are as follows:

  • Prompt me to update: A dialog box will be displayed when a new version of the examples is found.
  • Install updates automatically: The examples will be imported every time a new version is found.
  • Never update: No examples will be imported.

To confirm these options, use the Install button.

In a brand new KB, the first time that GAM is activated, this functionality makes it possible to consolidate only what’s necessary. If the KB is only web-based, you have the possibility to not consolidate SD examples.

Changing the settings

The options selected in the dialog of figure 1. can be changed from the menu Tools/GeneXus Access Manager/Installation Settings.

i2016_06_08_15_00_352_png
Figure 2.

The update button imports the newly selected option(s) and saves the changes. This is for changing the settings and applying those changes.
The repair button forces a full import of the GAM API, and all the selected options, not only the new selections.

By using the GAM Settings dialog in a new KB that will be started from GeneXus Server from a KB in which GAM is already activated you have the option to not consolidate the GAM examples.

In a KB where GAM is used only for the web, and you want to start using it for SD, you have the option to apply GAM to the SD part of the KB using this dialog (consolidate the GAM SD examples and initialize Login Object for SD property, Change Password Object for SD property, and Not Authorized Object for SD property).

Updating GAM examples

New GeneXus versions may include updates to GAM Examples. If you selected to automatically update GAM examples (see “Prompt me to update”), the following dialog may appear when updates are available.

Proceso de activación y actualización del GAM imagen 2
Figure 3. Do you want to continue with 'GAM' library additional features?

The dialog box lets you confirm if you want to install the updates or not. Select Yes to install them or No if you do not want to at this time.
 Updates to GAM examples may be manually installed at a later time by importing GAM_Panels-for-SD.xpz and/or GAM_Web-Administration.xpz located in folder \Library\GAM under the GeneXus installation directory.

As stated above, the GAM API is not affected by these properties; they are automatically imported every time that a new version is found while the GAM is activated.

See Also

Enable Integrated Security property

Creating the GAM repository for the first time from GeneXus

 



Was this page helpful?
What Is This?
Your feedback about this content is important. Let us know what you think.