HowTo: Filtering Data by User Using the GAM API

Official Content
This documentation is valid for:

The following is a basic example of GAM API use.

Imagine a scenario where distributors of an "X" company enter purchase orders in their smart devices.

As there's only one "Purchase Orders" table in the system, the "X" company wants to identify the salesman who entered the order. So the User Identification (UserId attribute) of the salesman is also stored in the "Purchase Orders" Table (see image 2).

The security information (Users, User information, GAM Roles, GAM Security Policies, etc) is stored in the GAM Repository.

A system requirement is that when the user navigates within the "Work With Smart Devices Purchase Orders", he has to access only the information entered by him and not the information entered by others. So we need to get the data of a specific user (the user who is loged in).

How to solve it:

1.      Set Enable Integrated Security property = TRUE

dataselectorgamsampleEnableIntegratedSecurity

image 1.

2.      The following is the transaction for our example:

dataselectorgamsampleTrnSample

image 2.

The Transaction has an attribute named UserId, which is under the domain GAMUserLogin. This attribute is going to store the identification of the user who entered the purchase order to the System. There are several ways to reference the user id in GAM database : GAM API: How to reference GAM users. In this example we are using the GETLogin method of GAMUser external object.

In order to go on with the example, apply the "Work with for Smart Devices" Pattern to the transaction, create a Dashboard Object and add the Work With "Purchase Orders" Smart Device instance as an element of it.

3. The salesman are requested their credentials when they enter the application in their Smart Devices. Check in the Dashboard object that Integrated Security Level Property = Authentication.

4. The user credentials have to be captured automatically when the user enters the information (the "Purchase Order"), so the User Identification can be saved. This is solved by programming the Equal rule in the PurchaseOrder transaction:

dataselectorgamsampleTrnEqualRule

image 3.

GetUser is a procedure. It has the following:                 

Source:

dataselectorgamsampleTrnSource

image 4,​
Rules:

dataselectorgamsampleGetUser

image 5.​
Variables:

dataselectorgamsampleGetUserSDT

image 6.​
Notes:
  • As "GAMUser" is a "static variable" that instantiates the current user information, you can use static methods to obtain the desired information (GetLogin, GetName, GetEmail, GetId...).
  • GetLogin method returns a string of the form <namespace>\<Authentication method>\<username>, e.g: testgam.testgam2\local\admin

After following the previous steps, the User current information will be retrieved and saved in the table when the user confirms the Purchase Order transaction.

5.  When the user navigates within the "Work With Purchase Orders", he has to see only the information entered by his own. In order to achieve this behavior, one solution is to:

a. Create a dataselector with the following code (note that "GetUser" is the procedure defined above):

dataselectorgamsample

image 7.​

b. Edit WorkWithDevicesPurchaseOrders object and configure the dataselector filter, editing the grid "Dataselector" property in the section detail:

grid dataselector filter

image 8.​

See Also

MyCowBook KB