Adding a user to the TM1 database

Users who are added to Cloud Pak for Data with the User role must be added to the TM1 database to enable the full use of Planning Analytics Workspace.

About this task

In Access management, Administrators assign User roles to users.

The Administrator adds the user to the TM1 database and assigns the user to a user group to provide access to books, views, and other objects in Planning Analytics Workspace.

User groups are used to manage object security on the TM1 database and in Planning Analytics Workspace. To learn more about user groups and object security, see Managing users and groups.

Procedure

  1. Log in to Planning Analytics Workspace as an Administrator.
  2. Open the TurboIntegrator process editor on the database where you want to add a user.
  3. In the Prolog procedure, enter these functions to create a new user group, add a user, and assign the user to the group.
    AddGroup('GroupName');
    AddClient('ClientName');
    AssignClientToGroup('ClientName', 'GroupName');

    ClientName should correspond to the authentication username that was specified when Adding users in Cloud Pak for Data.

    This example creates the user group North America and adds the user NeillR to the TM1 database with membership in the North America group.

    AddGroup('North America');
    AddClient('NeillR');
    AssignClientToGroup('NeillR', 'North America');

    If you want to add a user and assign the user to an existing group, omit the AddGroup function and specify the existing group in the AssignClientToGroup function.

    To learn more about these functions, see TurboIntegrator security functions.

  4. Click Save.
  5. Click Run.

    If you want to add multiple users at once, you can create a TurboIntegrator process that uses a file data source and executes the functions for each record in the source. For details, see Define a file data source.