Access Manager - Batch Maintenance...

IBM Cognos Business Intelligence Series 7IBM Cognos Series 7 Access Manager

Version 7.4

Access Manager Batch Maintenance Guide

Access Manager - Batch Maintenance Help

ACCESS MANAGER BATCH MAINTENANCE GUIDE

Product InformationThis document applies to IBM Cognos Series 7 Access Manager Version 7.4 and may also apply to subsequent releases. To check for newer versions of this document, visit the IBM Cognos Information Centers (http://publib.boulder.ibm.com/infocenter/cogic/v1r0m0/index.jsp).

CopyrightLicensed Materials - Property of IBM

© Copyright IBM Corp. 1999, 2009.

US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

IBM, the IBM logo, ibm.com, Cognos, Impromptu, and PowerPlay are trademarks or registered trademarks of International Business Machines Corp., in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at www.ibm.com/legal/copytrade.shtml.

Table of Contents

Chapter 1: Introduction 7

Chapter 2: Create an Input File 9All Objects Input File 9

Chapter 3: Batch Maintenance Tasks 11Run the Access Manager Batch Maintenance Tool 11Use the Graphical User Interface 11Use the Command Line 12Command Line Format 13View the Log File (All Objects Input File) 13

Chapter 4: Objects 17BasicSignon Object 17Cube Object 18Database Object 19DatabaseCube Object 20DatabaseSignon Object 21Folder Object 23MetadataObject Object 24Namespace Object 25OSSignon Object 26PowerPlayServer Object 27TransformerServer Object 28TransformerServerSignon Object 29User Object 30UserClass Object 32Object Association Commands 33

Chapter 5: Commands 35AddCube Command 38AddCubeToUser Command 39AddDatabase Command 39AddDatabaseCube Command 40AddDatabaseCubeToUser Command 41AddDatabaseSignon Command 42AddDatabaseSignonToUser Command 43AddDatabaseToUser Command 44AddFolder Command 45AddMetadataObject Command 46AddMetadataObjectToUser Command 47AddNamespace Command 48AddPowerPlayServer Command 49AddTransformerServer Command 50AddTransformerServerToUser Command 51AddTransformerServerSignon Command 52AddTransformerServerSignonToUser Command 53AddUser Command 54AddUserBasicSignon Command 55AddUserClass Command 56AddUserOSSignon Command 57

3 Licensed Materials - Property of IBM

© Copyright IBM Corp. 1999, 2009

AddUserToUserClass Command 58ChangeCubeName Command 59ChangeDatabaseName Command 60ChangeDatabaseCubeName Command 61ChangeDatabaseSignonName Command 62ChangeFolderName Command 63ChangeMetadataObjectName Command 63ChangePowerPlayServerName Command 64ChangeTransformerServerName Command 65ChangeTransformerServerSignonName Command 66ChangeUserBasicSignonName Command 67ChangeUserClassName Command 68ChangeUserName Command 68ChangeUserOSSignonName Command 69DeleteCube Command 70DeleteCubeFromUser Command 70DeleteDatabase Command 71DeleteDatabaseCube Command 72DeleteDatabaseCubeFromUser Command 73DeleteDatabaseFromUser Command 73DeleteDatabaseSignon Command 74DeleteDatabaseSignonFromUser Command 75DeleteFolder Command 76DeleteMetadataObject Command 77DeleteNamespace Command 77DeletePowerPlayServer Command 78DeleteTransformerServer Command 79DeleteTransformerServerFromUser Command 79DeleteTransformerServerSignon Command 80DeleteTransformerServerSignonFromUser Command 81DeleteUser Command 82DeleteUserBasicSignon Command 82DeleteUserClass Command 83DeleteUserFromUserClass Command 84DeleteUserOSSignon Command 85LinkUser Command 85LogonNamespace Command 86LogoffNamespace Command 87RelinkUser Command 88RemoveMetadataObjectFromUser Command 89SetCubeFolder Command 90SetCubeProperty Command 91SetDatabaseCubeProperty Command 91SetDatabaseFolder Command 92SetDatabaseProperty Command 93SetDatabaseSignonProperty Command 94SetMetadataObjectFolder Command 95SetMetadataObjectProperty Command 96SetNamespaceProperty Command 97SetPowerPlayServerProperty Command 99SetTransformerServerProperty Command 100SetTransformerServerSignonProperty Command 101SetUserBasicSignonProperty Command 102SetUserClassProperty Command 103SetUserFolder Command 105SetUserOSSignonProperty Command 105SetUserProperty Command 106

4 IBM Cognos Series 7 Access Manager

Chapter 6: Properties 109AccountIsDisabled Property (SetUserProperty Command) 110ActiveSignon Property (SetNamespaceProperty Command) 110AuthenticateAs Property (SetNamespaceProperty Command) 111AuthorFirstName Property (SetNamespaceProperty Command) 111AuthorLastName Property (SetNamespaceProperty Command) 111ChangePasswordAtNextLogon (SetUserBasicSignonProperty Command) 111ConnectionString Property (SetDatabaseProperty Command) 112ConnectionString Property (SetDatabaseCubeProperty Command) 112Connection Strings for Supported Databases 112CreatePersonalNewsBox Property (SetUserProperty Command) 113DataSourcePrivileges Property (SetUserClassProperty Command) 113DaylightSavingsTimeInEffect Property (SetNamespaceProperty Command) 113DaylightSavingsTimeInEffect Property (SetUserProperty Command) 113DayRestriction Property (SetUserClassProperty Command) 114Description Property (SetCubeProperty Command) 114Description Property (SetDatabaseProperty Command) 114Description Property (SetDatabaseCubeProperty Command) 114Description Property (SetDatabaseSignonProperty Command) 115Description Property (SetMetadataObjectProperty Command) 115Description Property (SetNamespaceProperty Command) 115Description Property (SetPowerPlayServerProperty Command) 115Description Property (SetTransformerServerProperty Command) 115Description Property (SetTransformerServerSignonProperty Command) 115Description Property (SetUserBasicSignonProperty Command) 116Description Property (SetUserClassProperty Command) 116Description Property (SetUserOSSignonProperty Command) 116Description Property (SetUserProperty Command) 116Email Property (SetUserProperty Command) 116ExpiredPasswordWarningPeriod Property (SetNamespaceProperty Command) 116ExternalIdentiyMapping (SetNamespaceProperty Command) 117FirstName Property (SetUserProperty Command) 117HourRestriction Property (SetUserClassProperty Command) 117Keywords Property (SetNamespaceProperty Command) 117Language Property (SetNamespaceProperty Command) 118Language Property (SetUserProperty Command) 118LastName Property (SetUserProperty Command) 118Locale Property (SetNamespaceProperty Command) 119Locale Property (SetUserProperty Command) 119Locale Table 119LockoutDuration Property (SetNamespaceProperty Command) 122MaxInvalidAttempts Property (SetNamespaceProperty Command) 122Password Property (SetDatabaseSignonProperty Command) 122Password Property (SetTransformerServerSignonProperty Command) 122Password Property (SetUserBasicSignonProperty Command) 122PasswordCaseSensitivity Property (SetNamespaceProperty Command) 123PasswordExpiry Property (SetNamespaceProperty Command) 123PasswordMinLength Property (SetNamespaceProperty Command) 123PasswordNeverExpires Property (SetUserProperty Command) 123PhoneNumber Property (SetUserProperty Command) 124Port Property (SetPowerPlayServerProperty Command) 124PowerPlayServerPrivileges Property (SetUserClassProperty Command) 124PublicUserClass Property (SetNamespaceProperty Command) 124RequiresSignon Property (SetDatabaseProperty Command) 124SignonCaseSensitivity Property (SetNamespaceProperty Command) 125SignonMinLength Property (SetNamespaceProperty Command) 125Subject Property (SetNamespaceProperty Command) 125

Access Manager Batch Maintenance Guide 5

TimeFormat Property (SetNamespaceProperty Command) 125TimeFormat Property (SetUserProperty Command) 125TimeZone Property (SetNamespaceProperty Command) 126TimeZone Property (SetUserProperty Command) 126Time Zone Table 126Timeout Property (SetPowerPlayServerProperty Command) 128Title Property (SetNamespaceProperty Command) 128TransformerServerPrivileges Property (SetUserClassProperty Command) 128UserCanNotChangePassword (SetUserProperty Command) 129UserClassPrivileges Property (SetUserClassProperty Command) 129UserPrivileges Property (SetUserClassProperty Command) 130

Chapter 7: Legacy Input Files 131User Input File 131User Class Input File 133View the Log File (User Input File) 135

Index 137


Chapter 1: Introduction

You can use the Access Manager Batch Maintenance tool to set up and manage Access Manager namespace information. You can update a namespace, user class, users, and data source objects by reading commands from text files in comma separated values (.csv) format. Each text file, or input file, contains a list of command lines. Each command line consists of a number of command parameters separated by commas, and ends with a carriage return. You can use this tool on both UNIX and Windows platforms.

Access Manager Batch Maintenance provides you with an alternative method for creating, deleting, renaming, and setting properties for objects. For Windows users, Access Manager OLE automation provides you with additional capabilities and follows a familiar programming style.

Related Topics• "Create an Input File" (p. 9)• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Command Line" (p. 12)



Chapter 1: Introduction


Chapter 2: Create an Input File

You create input files to add, delete, and change objects. The type of input file that is fully supported by Access Manager Batch Maintenance is called All Objects.

All Objects contain the object commands that you can use to maintain namespace, user class, user, application server, and data source object information. We recommend that you select this type of input file to work with regularly.

For information about the remaining types of input files, User and User Class, see the legacy input files (p. 131).

In Access Manager Batch Maintenance, you can select a namespace from a list of namespaces, to which you have access, specify a password for the namespace, and then select an input file type and name. The Access Manager Batch Maintenance tool reads each command line from an input file and changes the specified namespace. The input files provide you with options for changing information in a directory server.

NotesThe Access Manager Batch Maintenance tool does not have a line continuation character. Lines that wrap represent a single command in the input file.

All Objects Input File

SyntaxCommand,Parameters

DescriptionYou create an All Objects input file to set up and manage security information in a namespace on your directory server. The All Objects input file can contain many commands to maintain your namespace, user class, user, and data source objects.

DiscussionWhen you create an All Objects input file, ensure that• you log on to a namespace• you add user classes before adding users• all user class, user, and signon names are unique• you use commas to separate all commands, parameters, properties, and property settings

Use double forward slashes (//) to add comments within an All Objects input file. For example//Log on to a namespace

Commas are always required in the input file regardless if a field has a value. If you do not specify one or more parameters, include only the comma separator.

Access Manager Batch Maintenance logs all activities in the file log.txt in the folder that contains the Access Manager Batch Maintenance tool. You can use the Output file group box in Access Manager Batch Maintenance to specify another location for the log file.

Commands All Objects input files can contain any combination of object commands. When you use the All Objects input file, ensure that• you use a comma after command names and before parameters



Chapter 2: Create an Input File

• you use quotation marks around string data types• unless a member (user) of a user class has the appropriate privilege set, such as create, modify,

delete, and show, they cannot perform that action on the object• you do not have to include the LogonNamespace command as the first command in an All

Objects input file. The tool automatically logs you in to the namespace based on the namespace name you specify to run the input file.

• you do not have to include the LogoffNamespace command as the last command in an All Objects input file. The tool automatically logs off the namespace after it runs the last command in the input file.

ExampleThis example logs on to the Regions namespace through Access Manager Batch Maintenance, sets namespace properties, and then automatically logs off the namespace.//Set the type of signon.SetNamespaceProperty, "Regions","ActiveSignon","Basic"//Set the access type to AnonymousUser access.SetNamespaceProperty,"Regions","AuthenticateAs","AnonymousUser","Gibbons, Bill"//Set the first name of the author of the namespaceSetNamespaceProperty,"Regions ","AuthorFirstName","Matt"//Set the last name of the author of the namespaceSetNamespaceProperty,"Regions","AuthorLastName","Casgot"//Add a description for the namespaceSetNamespaceProperty,"Regions","Description","All sales regions."//Set the expired password warning period to 14 days.SetNamespaceProperty,"Regions","ExpiredPasswordWarningPeriod","9"//Set the language to French.SetNamespaceProperty,"Regions","Language","French"//Set the locale to French (France).SetNamespaceProperty,"Regions","Locale","fr-fr"//Specify a lockout duration time period of 20 minutesSetNamespaceProperty,"Regions","LockoutDuration","20"//Set an unlimited number of log on attemptsSetNamespaceProperty,"Regions","MaxInvalidAttempts","-1"//Set password case sensitivitySetNamespaceProperty,"Regions","PasswordCaseSensitivity","Yes"//Set the minimum password length to 6 charactersSetNamespaceProperty,"Regions","PasswordMinLength","6"//Set the password expiry to 3 monthsSetNamespaceProperty,"Regions","PasswordExpiry","3 months"//Set the public user class to Sales Representatives.SetNamespaceProperty,"Regions","PublicUserClass","Sales Representatives"//Set the minimum signon length to 8 charactersSetNamespaceProperty,"Regions","SignonMinLength","8"//Set signon case sensitivity to NoSetNamespaceProperty,"Regions","SignonCaseSensitivity","No"//Set a time format to the 24-hour clock.SetNamespaceProperty,"Regions","TimeFormat","HH:mm:ss"//Set the time zone to Romance.SetNamespaceProperty,"Regions","TimeZone","Romance"

Related Topics• "Commands" (p. 35)• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Command Line" (p. 12)• "Use the Graphical User Interface" (p. 11)


Chapter 3: Batch Maintenance Tasks

You can run the Access Manager Batch Maintenance tool using the graphical user interface, if you run it from Windows, or you can run it from a command line. In both cases, your first step is to create an input file.

Run the Access Manager Batch Maintenance ToolAfter you create an input file, you run the Access Manager Batch Maintenance tool to process the commands for a specified namespace.

Before you begin, you must:• Log on to the computer that has the Access Manager Batch Maintenance tool.• Know the Administrator ID and password of the namespace you want to edit. The default for

the Administrator ID is administrator and the default password is blank.• Ensure that the configuration is correct. The Access Manager Batch Maintenance tool uses the

configuration set by the Access Manager - Runtime component in Configuration Manager.

When you use user class and user input files, ensure that you process user class input files first because user classes must exist before you can add users to them.

Related Topics• "All Objects Input File" (p. 9)• "View the Log File (All Objects Input File)" (p. 13)

Use the Graphical User Interface

DescriptionUse the graphical user interface when you want to process one input file at a time. After the Access Manager Batch Maintenance tool processes the input file, a message appears stating that the process was successful. Access Manager Batch Maintenance logs all activities in the file log.txt by appending new processing results to the end of the log file. You may want to edit this file occasionally to limit its size.

Steps1. From the Start menu, click Programs, IBM Cognos, Tools, Access Manager - Batch

Maintenance.The Access Manager - Batch Maintenance dialog box appears.

2. From the Namespace box, select a namespace. 3. The drop-down list displays namespaces available on the directory server.4. In the Administrator ID and Password boxes, type your Administrator ID and password for

the namespace you want to edit.5. In the Input File group box, click Browse to specify the location of the input file.

The Open dialog box appears.Tip: Instead of using the Browse button, you can drag the input file from Windows Explorer to the Access Manager Batch Maintenance window.

6. Move to where the input file is stored, select the input file, and then click Open.7. Do one of the following to specify the type of input file to process:

• Click User File to process a user input file.• Click User Class File to process a user class input file.




• Click All Objects File to process the all objects input file.8. In the Output File group box, specify the path and file name of a log file. The default is log.txt

in the same location as Access Manager - Batch Maintenance.9. Click OK.

Related Topics• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Command Line" (p. 12)• "All Objects Input File" (p. 9)• "View the Log File (All Objects Input File)" (p. 13)

Use the Command Line

DescriptionYou can run the Access Manager Batch Maintenance tool from a command line to batch process one or more input files at once.

An example of a Windows command line prompt isAccessAdmMaint -namespace=Namespace1 -uid=Administrator -pass=Admin -filetype=2 -filename=C:\MyFiles\MyInputFile.txt

An example of a UNIX prompt isAccessAdmMaint -namespace=Regions -uid=Administrator -pass=admin -filetype=2 -filename=MyFile.txt -logfile=/home/Gibbonsb/log.txt

Steps1. Open a command prompt window.2. Find the location where Access Manager is installed.3. Type AccessAdmMaint for UNIX or AccessAdmMaint.exe for Windows, with the following

command line parameters.

Parameter Description

namespace Optional. Specifies the namespace to modify by the input file command. If you do not specify this parameter, Access Manager Batch Maintenance uses the default namespace on the directory server or in the local authentication file (.lae). If a default namespace has not been set, Access Manager Batch Maintenance uses the namespace that is called default. If such a namespace does not exist, an error message appears.

Type: String

uid Required. Specifies the basic signon user name of the root user for the specified namespace.

Type: String

pass Required. Specifies the basic signon password of the root user for the specified namespace.

Type: String



Note: Use the -? or -help parameters in a Windows environment, or the -help parameter in a UNIX environment, to see the Usage box that contains summary information about all parameters.

Related Topics• "All Objects Input File" (p. 9)• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Graphical User Interface" (p. 11)• "View the Log File (All Objects Input File)" (p. 13)

Command Line FormatThe format in which to specify the parameters from the command line is/namespace=namespace/uid=userid/pass=password/filetype=filetype/filename=inputfile/logfile=logfile

See "Use the Command Line" (p. 12) for a description of these parameters.

You can also use a hyphen (-) instead of a forward slash (/) when you enter parameters from the command line.

Related Topics• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Command Line" (p. 12)• "View the Log File (All Objects Input File)" (p. 13)

View the Log File (All Objects Input File)After the Access Manager Batch Maintenance tool processes an input file, it logs the results in a file called log.txt. This file is located in the same folder as the Access Manager Batch Maintenance tool. You use the Output file box in Access Manager Batch Maintenance to specify another location for the log file.

For example, you create the following All Objects input file.

filetype Required. Specifies the type of input file for processing.

0 = User input file1 = User class input file2 = All objects input file

Note: If you specify an incorrect file type, you may not get the expected results.

Type: Integer

filename Required. Specifies the path and file name of the input file for processing.

Type: String

logfile Optional. Specifies the path and file name of the log file that records all activities from running the input file. If you do not specify this parameter, Access Manager Batch Maintenance automatically creates a file log.txt in the same location as the tool.

Type: String




Note: To obtain the same results, you must have created the following objects prior to processing this input file,• user class "User Class 2" • basic signon "basic signon 3"• basic signon "basic signon 4"AddUserClass,"User Class 1 ","Root User Class"AddUserClass,"User Class A ","User Class 1" AddUserClass,"User Class 2 ","Root User Class" //This command should fail - User Class 2 already exists. AddUserClass,"User Class 3 ","Root User Class"AddUserClass,"User Class B ","User Class 1" AddUserClass,"User Class C ","User Class 3" AddUser,"User 1"SetUserProperty,"User 1","Description","This is User 1."AddUserBasicSignon,"User 1","basic signon 1"SetUserBasicSignonProperty,"User 1","basic signon1","Password", "Password1"AddUser,"User 2"SetUserProperty,"User 2","Description","This is User 2."AddUserBasicSignon,"User 2","basic signon 2"SetUserBasicSignonProperty,"User 2","basic signon2","Password", "Password2"AddUser,"User 3"SetUserProperty,"User 3","Description","This is User 3."AddUserBasicSignon,"User 3","basic signon 3"//This command should fail - basic signon 3 already exists. SetUserBasicSignonProperty,"User 3","basic signon3","Password", "Password3"//This command should fail - basic signon 3 is not associated with User 3. AddUser,"User 4"AddUserBasicSignon,"User 4","basic signon 4"//This command should fail - basic signon 4 already exists. AddUser,"User 5"DeleteUser,"User 5"DeleteUser,"User 2"AddUser,"User 6"SetUserProperty,"User 6","Description","This is User 6."AddUserOSSignon,"User 6","NAMERICA\OS signon 6"AddUserToUserClass,"User 1","User Class 1"AddUserToUserClass,"User 3","User Class A"ChangeUserClassName,"User Class 1","European Sales Representatives"ChangeUserName,"User 1","Mercier, Linda"ChangeUserName,"User 2","Gibbons, Bill"//This command should fail - User 2 does not existAddDatabase,"DB_Products"AddDatabase,"DB_HR"AddDatabaseToUser,"DB_Products","Mercier, Linda"AddDatabaseToUser,"DB_HR","User 6"

After Access Manager Batch Maintenance processes the input file, log.txt contains the following results. Each line in the log file corresponds to one command line in the All Objects input file.-- Access Manager Batch Maintenance --08/21/01 03:01:02 PM

Using input file: E:\Access Manager\BatchMaint\LogFileExmpl.txt

OK...... logonNamespace, TestOK...... AddUserClass, User Class 1OK...... AddUserClass, User Class AFailed.. AddUserClass, User Class 2: User class already existsOK...... AddUserClass, User Class 3OK...... AddUserClass, User Class BOK...... AddUserClass, User Class COK...... AddUser, User 1OK...... SetUserProperty, User 1OK...... AddUserBasicSignon, User 1OK...... SetUserBasicSignonProperty, User 1OK...... AddUser, User 2OK...... SetUserProperty, User 2



OK...... AddUserBasicSignon, User 2OK...... SetUserBasicSignonProperty, User 2OK...... AddUser, User 3OK...... SetUserProperty, User 3Failed.. AddUserBasicSignon, User 3: Signon already existsFailed.. SetUserBasicSignonProperty, User 3: Objects are not associatedOK...... AddUser, User 4Failed.. AddUserBasicSignon, User 4: Signon already existsOK...... AddUser, User 5OK...... DeleteUser, User 5OK...... DeleteUser, User 2OK...... AddUser, User 6OK...... SetUserProperty, User 6OK...... AddUserOSSignon, User 6OK...... AddUserToUserClass, User 1OK...... AddUserToUserClass, User 3OK...... ChangeUserClassName, User Class 1OK...... ChangeUserName, User 1Failed.. ChangeUserName, User 2: User does not existOK...... AddDatabase, DB_ProductsOK...... AddDatabase, DB_HROK...... AddDatabaseToUser, DB_ProductsOK...... AddDatabaseToUser, DB_HR

DONE.... 35 line(s) processed, 5 error(s) occurred, 0 warning(s) occurred.

Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify. You do not have to include the LogonNamespace command as the first command in the All Objects type of input file. The only exception to this rule is the AddNamespace command.

For more information, see All Objects Input File.

Related Topics• "Create an Input File" (p. 9)• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Command Line" (p. 12)• "Use the Graphical User Interface" (p. 11)




Chapter 4: Objects

BasicSignon Object

DescriptionDefines a basic signon for a User object.

DiscussionUse this object to specify a basic signon for a user to log on to a namespace. A basic signon consists of a user ID and password and is used to identify a user. By default, a namespace object has a root user called Administrator with a blank password and Administrator as the basic signon name.

To gain access to a namespace (an Access Manager session), Access Manager must validate you as a user. For example, a user can have a basic signon, OS signon, no signon, or both basic and OS signon. If a user has a basic signon and an OS signon, Access Manager uses the OS signon by default. An authenticated session only applies to the user that Access Manager has successfully validated.

Object Description

BasicSignon Object Defines a basic signon for a User object.

Cube Object Maintains local cubes in a namespace.

Database Object Maintains database objects as data sources in a namespace.

DatabaseCube Object Maintains cubes stored within databases.

DatabaseSignon Object Maintains database signons.

Folder Object Organizes other objects.

MetadataObject Object Specifies a data source in a namespace.

Namespace Object Contains signon information for users, user classes the users belong to, application servers, and data sources.

OSSignon Object Defines an OS signon for a User object.

PowerPlayServer Object Maintains PowerPlay servers in a namespace.

TransformerServer Object Maintains Transformer servers as data sources in a namespace.

TransformerServerSignon Object Maintains signon information for a Transformer server.

User Object Represents a user within a namespace.

UserClass Object Represents a user class within a namespace.



Chapter 4: Objects

The signon attributes of a database and Transformer server are different from the basic signon and OS signon attributes for the User object. A User object defines how a user signs on to an IBM Cognos application, such as a basic signon or OS signon. You can provide auto-access for a user to automatically give them access to protected cubes, servers, or databases without being prompted for a user ID or password. Before you set up auto-access for a user, signons for cubes, servers, or databases must already exist.

After you add a user to a namespace, you must create an object association to define how that user signs on to the namespace. To add a basic signon to a user, use the AddUserBasicSignon command.

You can also use the Access Manager tool to create and maintain basic signons.

The value you set for the PasswordCaseSensitivity property of the SetNamespaceProperty command determines case-sensitivity for passwords associated with the basic signon.

You can only create one basic signon for each user.

ExampleThis example associates two signons named Gibbonsb and Mustained to users named Bill Gibbons and Dave Mustaine. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.// Add two basic signons to the current namespace.AddUserBasicSignon,"Gibbons, Bill","Gibbonsb" AddUserBasicSignon,"Mustaine, Dave","Mustained"

Related Topics• "AddUserBasicSignon Command" (p. 55)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "SetNamespaceProperty Command" (p. 97)

Cube Object

DescriptionMaintains local cubes in a namespace.

DiscussionA cube is a data source that contains multidimensional information. The local Cube object represents a Transformer PowerCube that exists as a stand-alone multidimensional cube (.mdc) file.

The name and password that you assign to a local cube must be identical to the cube name and password specified in Transformer.

Local cube names must be unique within a namespace.

Command Description

AddUserBasicSignon Command Adds a basic signon to a user for auto-access.

ChangeUserBasicSignonName Command Sets a new basic signon name for a user.

DeleteUserBasicSignon Command Removes a basic signon from a user and deletes the signon from the namespace.

SetUserBasicSignonProperty Command Sets properties associated with a basic signon for a user.


Chapter 4: Objects

After you add a cube to a namespace, you can use the AddCubeToUser command to associate a cube data source to a user for auto-access.

ExampleThis example adds two cubes named Sales98 and Finance98, and associates these cubes with users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.// Add two cubes to the current namespace.AddCube,"Sales98" AddCube,"Finance98" //Associate the cubes with users. AddCubeToUser,"Sales98","Gibbons, Bill" AddCubeToUser,"Sales98","Richard, Fred" AddCubeToUser,"Sales98","Casgott, Matt" AddCubeToUser,"Sales98","Mustaine, Dave" AddCubeToUser,"Finance98","Gibbons, Bill"

Related Topics• "AddCube Command" (p. 38)• "AddCubeToUser Command" (p. 39)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangeCubeName Command" (p. 59)• "DeleteCube Command" (p. 70)• "SetCubeProperty Command" (p. 91)

Database Object

DescriptionMaintains database objects as data sources in a namespace.

DiscussionA Database object represents a relational database management system (RDBMS) that users can access. The signon attributes of a database are different from the basic signon and OS signon attributes for the User object. You can provide auto-access for a user to enable them to access protected cubes, servers, or databases without being prompted for a user ID or password. Before you set up auto-access for a user, signons for cubes, servers, or databases must already exist.

The name of the Database object in the namespace must be the same as the name of the database to which the user wants to connect. A Database object can store DatabaseSignon objects (for auto-access) and DatabaseCube objects (in-database cubes).

Command Description

AddCube Command Adds a cube as a data source.

AddCubeToUser Command Associates a cube data source to a user for auto-access.

ChangeCubeName Command Sets a new name for a local cube data source.

DeleteCube Command Removes a cube from a namespace.

DeleteCubeFromUser Command Removes a cube association from a user.

SetCubeFolder Command Sets a folder for a local cube.

SetCubeProperty Command Sets properties for a local cube.


Chapter 4: Objects

The Database object must exist before you can associate it to a User object. To associate a database to a user, use the AddDatabaseToUser command.

A database signon must be unique for each Database object.

You do not have to associate a database to a user before associating a database signon with a user. If you have not previously associated a database with a user, you can use the AddDatabaseSignonToUser command and Access Manager will automatically associate the corresponding database to the user for you.

ExampleThis example adds two databases named FinanceDatabase and MarketingDatabase, and then associates the databases with users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add two databases to the current namespace.AddDatabase,"FinanceDatabase" AddDatabase,"MarketingDatabase" //Associate databases with users. AddDatabaseToUser,"FinanceDatabase","Gibbons, Bill" AddDatabaseToUser,"MarketingDatabase","Gibbons, Bill" AddDatabaseToUser,"FinanceDatabase","Mustaine, Dave" AddDatabaseToUser,"MarketingDatabase","Mustaine, Dave" AddDatabaseToUser,"FinanceDatabase","Richard, Fred"

Related Topics• "AddDatabaseSignon Command" (p. 42)• "AddDatabaseSignonToUser Command" (p. 43)• "AddDatabaseToUser Command" (p. 44)• "Commands" (p. 35)• "All Objects Input File" (p. 9)

DatabaseCube Object

DescriptionMaintains cubes stored within databases.

DiscussionA database cube (in-database cube) is a data source that contains multidimensional information. The DatabaseCube object represents a Transformer cube that exists as a data source in a database. The name of the DatabaseCube object in the namespace must be the same as the name of the database cube the user wants as a data source.

Command Description

AddDatabase Command Adds a database as a data source in the namespace.

AddDatabaseToUser Command Associates a database to a user for auto-access.

ChangeDatabaseName Command Sets a new name for the database.

DeleteDatabase Command Removes a database from the namespace.

DeleteDatabaseFromUser Command Removes a database association from a user.

SetDatabaseFolder Command Sets a folder for a database.

SetDatabaseProperty Command Sets properties for a database.


Chapter 4: Objects

You can provide auto-access for a user to give them access protected cubes, servers, or databases without being prompted for a user ID or password. Before you set up auto-access for a user, signons for cubes, servers, or databases must already exist.

To associate a database cube to a user, use the AddDatabaseCubeToUser command.

You do not have to associate a database to a user before associating a database cube with a user. If you have not previously associated a database with a user, you can use the AddDatabaseCubeToUser command and Access Manager will automatically associate the corresponding database to the user for you.

A database cube name must be unique within a namespace.

ExampleThis example adds two database cubes named HRDatabase and MarketingDatabase, and then associates the databases with users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add two database cubes to the current namespace.AddDatabaseCube,"HRDatabase","HR98" AddDatabaseCube,"MarketingDatabase","Marketing98 //Associate the database cubes to users. AddDatabaseCubeToUser,"HRDatabase","HR98","Gibbons, Bill" AddDatabaseCubeToUser,"MarketingDatabase","Marketing98","Gibbons, Bill" AddDatabaseCubeToUser,"HRDatabase","HR98","Mustaine, Dave" AddDatabaseCubeToUser,"MarketingDatabase","Marketing98", "Mustaine, Dave" AddDatabaseCubeToUser,"HRDatabase","HR98","Richard, Fred"

Related Topics• "AddDatabaseCubeToUser Command" (p. 41)• "Commands" (p. 35)• "All Objects Input File" (p. 9)

DatabaseSignon Object

DescriptionMaintains database signons.

DiscussionUse this object to permit a user auto-access to a database. For example, when a user attempts to access a cube stored in a database (an in-database cube), Access Manager informs PowerPlay of the user ID, password, and connection string to the database.

Command Description

AddDatabaseCube Command Adds a cube stored within a database to the namespace.

AddDatabaseCubeToUser Command Associates a database cube with a user for auto-access.

ChangeDatabaseCubeName Command Sets a new name for the database cube.

DeleteDatabaseCube Command Removes a database cube from the namespace.

DeleteDatabaseCubeFromUser Command Removes a database cube association from a user.

SetDatabaseCubeProperty Command Sets a property for a database cube.


Chapter 4: Objects

The signon attributes of a database are different from the basic signon and OS signon attributes for the User object. A User object defines how a user signs on to an IBM Cognos application, such as a basic signon or OS signon. A database signon identifies what databases a user can automatically access after they are authenticated. To associate a database signon to a user, use the AddDatabaseSignonToUser command.

You can provide auto-access for a user to enable them to access protected cubes, servers, or databases without being prompted for a user ID or password. Before you set up auto-access for a user, signons for cubes, servers, or databases must already exist.


ExampleThis example adds two databases named HRDatabase and MarketingDatabase, associates the databases with users, and then associates the database signons with the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add two databases to the current namespace.AddDatabase,"HRDatabase"AddDatabase,"MarketingDatabase"//Associate the databases to users.AddDatabaseToUser,"HRDatabase","Gibbons, Bill"AddDatabaseToUser,"MarketingDatabase","Gibbons, Bill"AddDatabaseToUser,"HRDatabase","Mustaine, Dave"AddDatabaseToUser,"MarketingDatabase","Mustaine, Dave"AddDatabaseToUser,"HRDatabase","Richard, Fred"//Add database signon. AddDatabaseSignon,"HRDatabase","HRDBSignon" AddDatabaseSignon,"MarketingDatabase","MarketingDBSignon" //Associate the database signons to users. AddDatabaseSignonToUser,"HRDatabase","HRDBSignon","Gibbons, Bill" AddDatabaseSignonToUser,"MarketingDatabase","MarketingDBSignon", "Gibbons, Bill" AddDatabaseSignonToUser,"HRDatabase","HRDBSignon","Mustaine, Dave" AddDatabaseSignonToUser,"MarketingDatabase","MarketingDBSignon","Mustaine, Dave" AddDatabaseSignonToUser,"HRDatabase,"HRDBSignon","Richard, Fred"

Related Topics• "AddDatabaseSignonToUser Command" (p. 43)• "Commands" (p. 35)• "All Objects Input File" (p. 9)

Command Description

AddDatabaseSignon Command Adds a database signon to a database.

AddDatabaseSignonToUser Command Associates a database signon with a user for auto-access.

ChangeDatabaseSignonName Command Sets a new name for the database signon.

DeleteDatabaseSignon Command Removes a database signon from the namespace.

DeleteDatabaseSignonFromUser Command Removes a database signon association from a user.

SetDatabaseSignonProperty Command Sets a property for a database signon.


Chapter 4: Objects

Folder Object

DescriptionOrganizes other objects.

DiscussionUse this object to group other objects in the namespace into meaningful collections. In Access Manager, you can create two types of folders: DataSourceFolder and UserFolder. The DataSourceFolder type can contain databases, PowerCubes, and Metadata objects, and the UserFolder type contains only User objects. Both types of folders can have the same names. When you delete a folder, you also delete all objects that it contains.

ExampleThis example adds two Folder objects, both called Personnel. Each of them represents a different folder type: UserFolder and DataSourceFolder. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add two folders to the current namespace.AddFolder,"UserFolder","Personnel","Users" AddFolder,"DataSourceFolder","Personnel","Data Sources" //Change folder name. ChangeFolderName,"UserFolder","Personnel","Sales Personnel" //Delete a folder. DeleteFolder,"DataSourceFolder","Personnel","Data Sources" //Set a cube folder. SetCubeFolder,"Sales98","Sales" //Set a database folder.SetDatabaseFolder,"FinanceDB","Finance" //Set a Metadata object folder.SetMetadataObjectFolder,"Special NewsIndex", "New Metadata Sources" //Set a user folder.SetUserFolder,"Gibbons, Bill","Personnel"

Related Topics• "AddFolder Command" (p. 45)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangeFolderName Command" (p. 63)• "DeleteFolder Command" (p. 76)

Command Description

AddFolder Command Adds a Folder object to a namespace.

ChangeFolderName Command Sets a new name for a Folder object.

DeleteFolder Command Deletes a Folder object from a namespace.

SetCubeFolder Command Sets a folder for a Cube object.

SetDatabaseFolder Command Sets a folder for a Database object.

SetMetadataObjectFolder Command

Sets a folder for a Metadata object.

SetUserFolder Command Sets a folder for a User object.


Chapter 4: Objects

MetadataObject Object

DescriptionSpecifies a data source in a namespace.

DiscussionUse this object to make the metadata sources available as data sources in the namespace. Each Metadata object can represent only one metadata source (type), for example Architect Model, ERWin Model, or Informatica Model. You assign the type to a Metadata object when you create that object. Once a metadata type is set, it can not be changed. However, you can change the name and description of a Metadata object.

Architect defines what types of Metadata objects can be used. Ensure that you specify a valid metadata type because Access Manager does not validate this parameter.

For more information about metadata sources (types), see Architect documentation.

ExampleThis example adds a Metadata object, Company Model, as a data source to a namespace and then performs several operations on that object. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add a Metadata object.AddMetadataObject,"Company Model","Architect Model" //Set a folder for a Metadata object. SetMetadataObjectFolder,"Company Model","Metadata Sources" //Set a Metadata object property. SetMetadataObjectProperty,"Company Model","Description","This is a description" //Add a Metadata object to a user. AddMetadataObjectToUser,"Company Model","Gibbons, Bill" //Remove a Metadata object association from a user. RemoveMetadataObjectFromUser,"Company Model","Gibbons, Bill" //Change the Metadata object name.ChangeMetadataObjectName,"Company Model","Model2000" //Remove a Metadata object as a data source from the namespace.DeleteMetadataObject,"Model2000"

Related Topics• "AddMetadataObject Command" (p. 46)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangeMetadataObjectName Command" (p. 63)

Command Description

AddMetadataObject Command Adds a Metadata object as a data source to a namespace.

AddMetadataObjectToUser Command Associates a Metadata object to a user.

ChangeMetadataObjectName Command Sets a new name for a Metadata object.

DeleteMetadataObject Command Deletes a Metadata object from a namespace.

RemoveMetadataObjectFromUser Command Removes a Metadata object association from a user.

SetMetadataObjectFolder Command Sets a folder for a Metadata object.

SetMetadataObjectProperty Command Sets a property for a Metadata object.


Chapter 4: Objects

• "SetMetadataObjectProperty Command" (p. 96)

Namespace Object

DescriptionContains signon information for users, user classes the users belong to, application servers, and data sources.

DiscussionUse this object to create a space on a directory server where you can maintain signon information for users, user classes, application servers, and data sources. The UserClass object within a namespace controls access to information in other IBM Cognos applications. With the signon information for application servers and data sources, you can provide users auto-access to these sources.

When you set up a namespace you add the namespace, log in, and set the properties for a namespace.

Namespace objects are unique within a directory server. By default, a Namespace object has• a Root User Class object• a Root User called Administrator with a blank password• all privileges set (create, delete, and show) for user classes, users, data sources, PowerPlay

servers, and Transformer servers. The UserClass object also has a show all permission.• folders for Users, Data Sources, and Application servers.

An Access Manager session represents the data stored in a single namespace. A session can only be associated with a single namespace at a given time. To gain access to a valid session, Access Manager must validate you as a user. For example, a user can have a basic signon, an OS signon, or no signon.

For Web-based products, Access Manager sets another type of access to a namespace as well as the user's existing basic signon. The alternate accounts are AnonymousUser access and GuestUser access.

An anonymous user is an unnamed user who can access a data source without being prompted for a user ID and password. Anonymous users are never asked for identification but you can restrict their access to a data sources and their membership in user classes. Anonymous users cannot modify their user preferences. Anonymous users can belong to user classes and can have auto-access. In a namespace with anonymous users, the only other user that exists is the Administrator. If you enable anonymous users in a namespace, other IBM Cognos products will not prompt users for a user ID or password.

A guest user is an unnamed user who can access a data source without providing a user ID and password. Enabling guest users allows you to set different security access for named and for unnamed (guest) users. Guest users cannot modify their user preferences. Guest users can belong to user classes and can have auto-access. If you enable guest users in a namespace, IBM Cognos products which support guest access will offer users the option of logging in as guests.

An Access Manager session applies only to the user that Access Manager has successfully validated.

The authenticated session is associated with a set of user classes in which the authenticated user is a member of the namespace. It is this set of user classes that identifies the user's permissions for the authenticated session. For example, if users belongs to a user class that does not have the create permission set for users, they cannot create or change other users in that namespace for the current session.

To access the namespace, each user who has administrator access rights must have basic signon and belong to a Root User Class or a class with the same permissions as the Root User Class.

After you add a Namespace object, you must log on to the namespace before you can set properties, add users, user classes, and data sources. You can only log on to a namespace if you belong to a user class that has permissions to view or edit the contents of that namespace and you have a user ID.


Chapter 4: Objects

The user ID for the default administrator that is created for each namespace is Administrator. Other users must be assigned to a user class and have a basic or OS signon created before they can access a namespace. The default administrator's password is blank.

If you want to end the current authenticated session, use the LogoffNamespace command to log off the current namespace, and then use the LogonNamespace command to log on to another namespace (start another authenticated session).

Notes• You can log on only to the namespace to which you have been granted access.• You can rename objects only in the namespace to which you have been granted access.• You must create a Namespace object before you can create users or user classes, or before you

can add application servers or data sources that users can access.• There is no limit to the number of Namespace objects you can add.

ExampleThis example sets the password expiry and password case-sensitivity properties, logs off the Regions namespace, logs on to the Sales Representatives namespace, and deletes the user named Bill Gibbons. Note that you do not have to specify the NamespaceName parameter for the SetNamespaceProperty command.LogonNamespace,"Regions","administrator","admin" //Set the password expiry and the Password case//sensitivity properties.SetNamespaceProperty,"Regions","PasswordExpiry","12 weeks" SetNamespaceProperty,"Regions","PasswordCaseSensitivity","Yes" //Log off the Regions namespace.LogoffNamespace,"Regions" //Log on to the Sales Representatives namespace//using the default basic signon administrator and//the password admin.LogonNamespace,"Sales Representatives","administrator","admin" //Delete a user.DeleteUser,"Gibbons, Bill"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "LogoffNamespace Command" (p. 87)• "LogonNamespace Command" (p. 86)• "Run the Access Manager Batch Maintenance Tool" (p. 11)

OSSignon Object

DescriptionDefines an OS signon for a User object.

Command Description

AddNamespace Command Adds a namespace to a directory server.

DeleteNamespace Command Deletes a namespace from a directory server.

LogonNamespace Command Logs on to an existing namespace.

LogoffNamespace Command Logs off the current namespace.

SetNamespaceProperty Command Sets name, logon, signon, and password information for a specified namespace.


Chapter 4: Objects

DiscussionUse this object to specify an OS signon when a user logs on to a namespace. An operating system (OS) signon enables Access Manager to recognize a user's network operating system ID as a means of authentication. An OS signon relies on the security of the operating system and therefore requires no password. An OS signon consists of a user ID to identify a user. By default, a Namespace object has a Root User called Administrator with a blank basic signon.

To gain access to a namespace (an Access Manager session), Access Manager must validate you as a user. For example, a user can have a basic signon, OS signon, no signon, or both basic and OS signon. If a user has a basic signon and an OS signon, Access Manager uses the OS signon by default. An authenticated session only applies to the user that Access Manager has successfully validated.


After you add a user to a namespace, you can create an object association to define how that user signs on to the namespace. To add an OS signon to a user, use the AddUserOSSignon command.

The signon attributes of a database and Transformer server are different from the basic signon and OS signon attributes for the User object. A User object defines how a user signs on to an IBM Cognos application, such as a basic signon or OS signon.

You can create more than one OS signon for a user.

The OS signon is also referred to as a trusted signon when it is used to set up custom authentication. For more information, see the Access Manager Trusted Signon Plug-in Software Development Kit Guide.

ExampleThis example adds OS signons to users named Bill Gibbons and Dave Mustaine. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add two cubes to the current namespace.AddUserOSSignon,"Gibbons, Bill","gibbonsb" AddUserOSSignon,"Mustaine, Dave","mustaind"

Related Topics• "AddUserOSSignon Command" (p. 57)• "Commands" (p. 35)• "All Objects Input File" (p. 9)

PowerPlayServer Object

DescriptionMaintains PowerPlay servers in a namespace.

Command Description

AddUserOSSignon Command Adds a basic signon for a user for auto-access.

ChangeUserOSSignonName Command Sets a new name for a user's basic signon.

DeleteUserOSSignon Command Removes a basic signon from a user.

SetUserOSSignonProperty Command Sets a property for a user's basic signon.


Chapter 4: Objects

DiscussionUse this object to represent a PowerPlay server resource for a namespace. There is no signon associated with a PowerPlay server.

ExampleThis example adds a PowerPlay server called PPWebServer to a namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add a PowerPlay server to the namespace.AddPowerPlayServer,"PPWebServer"

Related Topics• "AddPowerPlayServer Command" (p. 49)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangePowerPlayServerName Command" (p. 64)• "DeletePowerPlayServer Command" (p. 78)• "SetPowerPlayServerProperty Command" (p. 99)

TransformerServer Object

DescriptionMaintains Transformer servers as data sources in a namespace.

DiscussionA TransformerServer object represents a Transformer server that users can access. The name of the Transformer server in the namespace must be the same as the name of the Transformer server to which you are connecting.


A Transformer server signon identifies what servers a user can automatically access after they are authenticated. To associate a Transformer server signon to a user, use the AddTransformerServerSignonToUser command.

To associate a Transformer server to a user, use the AddTransformerServerToUser command.

You do not have to associate a Transformer server to a user before associating a Transformer server signon with a user. If you have not previously associated a Transformer server with a user, you can use the AddTransformerServerSignonToUser command and Access Manager will automatically associate the corresponding Transformer server to the user for you.

Command Description

AddPowerPlayServer Command Adds a PowerPlay server to the namespace.

ChangePowerPlayServerName Command Sets a new name for a PowerPlay server.

DeletePowerPlayServer Command Removes a PowerPlay server from the namespace.

SetPowerPlayServerProperty Command Sets a property for a PowerPlay server.

Command Description

AddTransformerServer Command Adds a Transformer server to the namespace.


Chapter 4: Objects

ExampleThis example adds a Transformer server named TransWinServer, adds a Transformer server signon named TransSignonA, and associates the Transformer server and Transformer server signon to the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add a Transformer server to the namespace. AddTransformerServer,"TransWinServer" //Add a Transformer server signon. AddTransformerServerSignon,"TransWinServer","TransSignonA" //Associate a Transformer server with a user. AddTransformerServerToUser,"TransWinServer","Gibbons, Bill" //Associate a Transformer server signon with a user.AddTransformerServerSignonToUser,"TransWinServer","TransSignonA","Gibbons, Bill"

Related Topics• "AddTransformerServerSignon Command" (p. 52)• "AddTransformerServerToUser Command" (p. 51)• "Commands" (p. 35)• "All Objects Input File" (p. 9)

TransformerServerSignon Object

DescriptionMaintains signon information for a Transformer server.

DiscussionUse this object to associate a Transformer servers signon to a user. For example, when a user attempts to access a Transformer server, Access Manager must validate the Transformer server signon before granting access to that server.

You can provide a user auto-access to access protected cubes, servers, or databases without being prompted for a user ID or password. Before you set up auto-access for a user, signons for cubes, servers, or databases must already exist.

The signon attributes of a Transformer server are different from the basic signon and OS signon attributes for the User object. A User object defines how a user signs on to an IBM Cognos application, such as a basic signon or OS signon. A Transformer server signon identifies what servers a user can automatically access once they are authenticated.

To associate a Transformer server signon to a user, use the AddTransformerServerSignonToUser command.

AddTransformerServerToUser Command Associates a Transformer server with a user.

ChangeTransformerServerName Command Sets a new name for a Transformer server.

DeleteTransformerServer Command Removes a Transformer server from the namespace.

DeleteTransformerServerFromUser Command Removes a Transformer server association from a user.

SetTransformerServerProperty Command Sets a property for a Transformer server.

Command Description


Chapter 4: Objects


ExampleThis example adds a Transformer server named TransWinServer, adds a Transformer server signon named TransSignonA, and associates the Transformer server and Transformer server signon to the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add a Transformer server to the namespace.AddTransformerServer,"TransWinServer"//Add a Transformer server signon.AddTransformerServerSignon,"TransWinServer","TransSignonA" //Associate a Transformer server with a user.AddTransformerServerToUser,"TransWinServer","Gibbons, Bill"//Associate a Transformer server signon with a user.AddTransformerServerSignonToUser,"TransWinServer","TransSignonA","Gibbons, Bill"

Related Topics• "AddTransformerServerSignon Command" (p. 52)• "AddTransformerServerSignon Command" (p. 52)• "AddTransformerServerSignonToUser Command" (p. 53)• "AddTransformerServerToUser Command" (p. 51)• "Commands" (p. 35)• "All Objects Input File" (p. 9)

User Object

DescriptionRepresents a user within a namespace.

Command Description

AddTransformerServerSignon Command Adds a Transformer server signon to a Transformer server.

AddTransformerServerSignonToUser Command Associates a Transformer server signon with a user.

ChangeTransformerServerSignonName Command Sets a new name for a Transformer server signon.

DeleteTransformerServerSignon Command Removes a Transformer server signon from a Transformer server.

DeleteTransformerServerSignonFromUser Command Removes a Transformer server signon association from a user.

SetTransformerServerSignonProperty Command Sets a property for a Transformer server signon.


Chapter 4: Objects

DiscussionA User object defines how a user logs on to an IBM Cognos application, such as a basic or OS signon, and identifies what a user can automatically access once they are authenticated, such as cubes, databases, and servers. The signon attributes of a database and server are different from the basic and OS signon attributes for the User object.

After you create a user, you must create associations to define how a user signs on and what data sources they can have access to.

User names must be unique within a namespace and be at least one character.

The user that is currently logged on to the namespace must have the user create, modify self, and delete permissions set before they can add, update, and delete other users within that namespace.

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine to the current namespace, adds two user classes named Sales Representative and Sales VPs, associates the users to user classes, and associates signons with the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add users to the namespace.AddUser,"Gibbons, Bill" AddUser,"Richard, Fred" AddUser,"Mustaine, Dave" //Add user classes. AddUserClass,"Sales Representatives","Root User Class" AddUserClass,"Sales VPs","Root User Class" //Associate users with user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs" AddUserToUserClass,"Richard, Fred","Sales Representatives" AddUserToUserClass,"Mustaine, Dave","Sales Representatives" //Associate signons with users. AddUserOSSignon,"Gibbons, Bill","gibbonsb" AddUserBasicSignon,"Fred Richard","richardf" AddUserBasicSignon,"Dave Mustaine","mustaind"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "UserClass Object" (p. 32)

Command Description

AddUser Command Adds a user to a namespace.

AddUserToUserClass Command Associates a user to a user class.

ChangeUserName Command Sets a new name for a user.

DeleteUser Command Removes a user from the namespace.

DeleteUserFromUserClass Command Removes a user class association from a user.

LinkUser Command Links an external user to an Access Manager namespace.

RelinkUser Command Modifies the distinguished name (DN) reference for an existing external user.

SetUserFolder Command Sets a folder for a user.

SetUserProperty Command Sets a property for a user.


Chapter 4: Objects

UserClass Object

DescriptionRepresents a user class within a namespace.

DiscussionUse this object to define logical groups of users. UserClass objects consist of users who perform similar tasks and therefore require similar access to information. A UserClass object also maintains permissions for its member users. These administrative permissions identify the type of operations that the members of the user class can apply to other users and user classes, as well as how they access data sources and servers. The types of operations for the user class permission objects are create, delete, show, and show all. The show all permission is for user and user class objects. When this permission is set, users can view the entire user class hierarchy within the namespace, including unrelated users and user classes.

The permission objects are• Users• User classes• Data Sources (database, cube, and Metadata object access)• PowerPlay Servers• Transformer Servers

When you set up user security, you create users and give them memberships to user classes. Then, you give the user classes access permission to application servers (for example, Transformer server) and data sources (for example, Oracle, Sybase SQL Server, cubes, and Metadata objects). Any user who is a member of a user class can perform only those operations identified by the user class permissions. For example, a user belongs to a user class that does not have the Delete permission set for user classes. This user cannot delete other user classes from the namespace.

You apply user classes to specify what information users can see as well as prevent unauthorized users from viewing the information sources. For example, to create a user class protected cube in Transformer, the cube administrator applies user classes (created through automation or through Access Manager) to dimensions in the cube. When PowerPlay users access the cube, they can view only the dimensions that their user class has been granted access to. If users do not belong to a user class, they are not given access to the cube.

A UserClass object specifies the user class name and when members of that user class can access Access Manager tool to access their authentication data. This object also specifies the administrative permissions that the user class has that pertains to creating, deleting, viewing, and changing objects. The child user class objects inherit their administrative permissions from the parent user class object.

Access Manager has an option for creating a Public User Class. Any named user class that exists in a namespace can be identified as a Public User Class. All users associated to a namespace automatically become members of the Public User Class. At the same time, they can be members of any other user class.

User class names must be unique within a namespace.

The user who is currently logged on to the namespace must have the user class create permission set to add a user class.

Command Description

AddUserClass Command Adds a user class to the namespace.

AddUserToUserClass Command Associates a user with a user class.

ChangeUserClassName Command Sets a new name for a user class.

DeleteUserClass Command Removes a user class from the namespace.

DeleteUserFromUserClass Command Removes a user from a user class.


Chapter 4: Objects

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine, adds two user classes named Sales Representative and Sales VPs, associates the users with user classes, and associates signons with users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify in the Logon area of the dialog box.//Add users to the namespace.AddUser,"Gibbons, Bill"AddUser,"Richard, Fred"AddUser,"Mustaine, Dave"//Add user classes.AddUserClass,"Sales Representatives","Root User Class" AddUserClass,"Sales VPs","Root User Class" //Associate users to user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs" AddUserToUserClass,"Richard, Fred","Sales Representatives" AddUserToUserClass,"Mustaine, Dave","Sales Representatives" //Associate signons to users. AddUserOSSignon,"Gibbons, Bill","Gibbonsb" AddUserBasicSignon,"Richard, Fred","Richardf" AddUserBasicSignon,"Mustaine, Dave","Mustained"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "User Object" (p. 30)

Object Association CommandsYou can use associations to make data sources, servers, and server signons available to users. These objects exist in the namespace; however, you must make them available to users so that they can access these objects. This table identifies the associations for the All Objects input file.

SetUserClassProperty Command Sets a property for a user class.

Command Description

Command Description

AddCubeToUser Command Associates a local cube to a user.

AddDatabaseToUser Command Associates a database as a data source to a user.

AddDatabaseCubeToUser Command Associates a database cube to a user.

AddDatabaseSignonToUser Command Adds a database signon to a user.


AddTransformerServerToUser Command Associates a Transformer server to a user.

AddTransformerServerSignonToUser Command Associates a Transformer server signon to a user.

AddUserToUserClass Command Adds a user to a user class.

DeleteCubeFromUser Command Removes a local cube association from a user.


Chapter 4: Objects

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)



DeleteDatabaseSignonFromUser Command Removes a database signon from a user.

DeleteTransformerServerFromUser Command Removes a Transformer server association from a user.

DeleteTransformerServerSignonFromUser Command

Removes a Transformer server signon from a user.

DeleteUserFromUserClass Command Removes a user from a user class.


Command Description


Chapter 5: Commands

Command Description

AddCube Command Adds a cube as a data source to a namespace.

AddCubeToUser Command Associates a cube with a user for auto-access.

AddDatabase Command Adds a database as a data source in a namespace.

AddDatabaseCube Command Adds a cube stored within a database to a namespace.

AddDatabaseCubeToUser Command Associates a database cube with a user for auto-access.

AddDatabaseSignon Command Adds a database signon to a database.

AddDatabaseSignonToUser Command Associates a database signon with a user for auto-access.

AddDatabaseToUser Command Associates a database with a user for auto-access.

AddFolder Command Adds a Folder object to a namespace.

AddMetadataObject Command Adds a Metadata object as a data source to a namespace.


AddNamespace Command Adds a namespace to a directory server.

AddPowerPlayServer Command Adds a PowerPlay server to a namespace.

AddTransformerServer Command Adds a Transformer server to a namespace.

AddTransformerServerSignon Command Adds a Transformer server signon to a Transformer server.

AddTransformerServerSignonToUser Command

Associates a Transformer server signon with a user.

AddTransformerServerToUser Command Associates a Transformer server with a user.

AddUser Command Adds a user to a namespace.

AddUserBasicSignon Command Adds a basic signon to a user for auto-access.

AddUserClass Command Adds a user class to the namespace.

AddUserOSSignon Command Adds a basic signon to a user for auto-access.

AddUserToUserClass Command Associates a user with a user class.



Chapter 5: Commands

ChangeCubeName Command Sets a new name for a local cube.

ChangeDatabaseCubeName Command Sets a new name for a database cube.

ChangeDatabaseName Command Sets a new name for a database.

ChangeDatabaseSignonName Command Sets a new name for a database signon.

ChangeFolderName Command Sets a new name for a folder.

ChangeMetadataObjectName Command Sets a new name for a Metadata object.

ChangePowerPlayServerName Command Sets a new name for a PowerPlay server.

ChangeTransformerServerName Command Sets a new name for a Transformer server.

ChangeTransformerServerSignonName Command

Sets a new name for a Transformer server signon.

ChangeUserBasicSignonName Command Sets a new basic signon name for a user.

ChangeUserClassName Command Sets a new name for a user class.

ChangeUserName Command Sets a new name for a user.

ChangeUserOSSignonName Command Sets a new name for a user's basic signon.

DeleteCube Command Removes a cube from a namespace.

DeleteCubeFromUser Command Removes a cube association from a user.

DeleteDatabase Command Removes a database from the namespace.

DeleteDatabaseCube Command Removes a database cube from the namespace.



DeleteDatabaseSignon Command Removes a database signon from the namespace.

DeleteDatabaseSignonFromUser Command Removes a database signon association from a user.

DeleteFolder Command Deletes a Folder object from a namespace.

DeleteMetadataObject Command Removes a Metadata object from a namespace.

DeleteNamespace Command Removes a namespace from a directory server.

DeletePowerPlayServer Command Removes a PowerPlay server from a namespace.

DeleteTransformerServer Command Removes a Transformer server from a namespace.

DeleteTransformerServerFromUser Command Removes a Transformer server from a user.

DeleteTransformerServerSignon Command Removes a Transformer server signon from a Transformer server.

Command Description


Chapter 5: Commands


Removes a Transformer server signon association from a user.

DeleteUser Command Removes a user from a namespace.

DeleteUserBasicSignon Command Removes a basic signon from a user and deletes the signon from a namespace.

DeleteUserClass Command Removes a user class from a namespace.

DeleteUserFromUserClass Command Removes a user class association for a user.

DeleteUserOSSignon Command Removes a basic signon association from a user.

LinkUser Command Links an external user to an Access Manager namespace.

LogoffNamespace Command Logs off the current namespace.

LogonNamespace Command Logs on to an existing namespace.

RelinkUser Command Modifies the distinguished name (DN) reference for an existing external user.


SetCubeFolder Command Sets a folder for a local cube object.

SetCubeProperty Command Sets properties for a local cube.

SetDatabaseCubeProperty Command Sets a property for a database cube.

SetDatabaseFolder Command Sets a folder for a Database object.

SetDatabaseProperty Command Sets properties for a database.

SetDatabaseSignonProperty Command Sets a property for a database signon.

SetNamespaceProperty Command Sets name, logon, signon, and password information for a specified namespace.

SetMetadataObjectFolder Command Sets a folder for a Metadata object.

SetMetadataObjectProperty Command Sets a property for a Metadata object.

SetPowerPlayServerProperty Command Sets a property for a PowerPlay server.

SetTransformerServerProperty Command Sets a property for a Transformer server.

SetTransformerServerSignonProperty Command

Sets a property for a Transformer server signon.

SetUserBasicSignonProperty Command Sets properties associated with a basic signon for a user.

SetUserClassProperty Command Sets a property for a user class.

SetUserFolder Command Sets a folder for a User object.

SetUserOSSignonProperty Command Sets a property for a user's OS signon.

Command Description


Chapter 5: Commands

AddCube Command

SyntaxAddCube,CubeName

Applies ToCube Object

DescriptionAdds a local cube to a namespace.

DiscussionUse this command to add a local cube (.mdc file) to the current namespace as a data source. A cube is a data source that contains multidimensional information. The local Cube object represents a Transformer PowerCube that exists as a stand-alone .mdc file. Before you can add a cube to a namespace, Access Manager must validate you and the namespace must exist in the directory server.

The name and password that you assign to a local cube must be identical to the cube name and password specified in Transformer.

After you add a cube, if you have permissions set to create, change, and delete data sources, you can change the cube name, delete the cube, or set cube properties, such as the description, password, connection string, and name.

A Transformer PowerCube can exist in a database or as a file. Auto-access to a password protected cube requires a user ID and password.

ExampleThis example adds two cubes named Sales98 and Finance98 to the current namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add two cubes to the current namespace.AddCube,"Sales98" AddCube,"Finance98"

Related Topics• "AddCubeToUser Command" (p. 39)• "AddDatabaseCube Command" (p. 40)• "ChangeCubeName Command" (p. 59)• "DeleteCube Command" (p. 70)• "SetCubeProperty Command" (p. 91)

SetUserProperty Command Sets a property for a user.

Command Description


CubeName Required. Specifies the unique name of the cube. This name must be the same name as the local cube, without the .mdc file extension, for example "Sales98".

Type: String


Chapter 5: Commands

AddCubeToUser Command

SyntaxAddCubeToUser,CubeName,UserName


User Object

DescriptionAssociates a local cube with a user.

DiscussionUse this command to make a local cube in a namespace available to a user. This association gives the user access to a cube data source that contains multidimensional information. The local Cube object represents a Transformer PowerCube that exists as a stand-alone multi-dimensional cube (.mdc) file.

Before you can associate a cube with a user, the Cube and User objects must exist in the namespace.

ExampleThis example associates two cubes named Sales98 and Finance98 with the user Bill Gibbons in the current namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.// Associate two cubes with a user.AddCubeToUser,"Sales98","Bill Gibbons" AddCubeToUser,"Finance98","Bill Gibbons"

Related Topics• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)

AddDatabase Command

SyntaxAddDatabase,DatabaseName,ConnectionString

Applies ToDatabase Object

DescriptionAdds a database to a namespace.


CubeName Required. Specifies the unique name of the cube in the current namespace.

Type: String

UserName Required. Specifies the name of a user in the namespace. The user name is unique within a namespace.

Type: String


Chapter 5: Commands

DiscussionUse this command to add a database to the current namespace. The name of the Database object in the namespace must be the same as the name of the database the user wants to connect to. A Database object can store DatabaseSignon objects (for auto-access) and DatabaseCube objects (in-database cubes).

A Database object represents a relational database management system (RDBMS) that users can access. The signon attributes of a database are different from the basic signon and OS signon attributes for the User object.

You must create a namespace before you can add data sources.

The database name must be unique within a namespace. To associate a database to a user, use the AddDatabaseToUser command.

To associate a database signon to a user, use the AddDatabaseSignonToUser command.

After the database is added, if the user class has permissions to create, modify, and delete data sources, you can change the database name, delete the database, or set database properties, such as its description, connection string, and name.

ExampleThis example adds a database named Products and sets the connection string property. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add database Products and set the//connection string property.AddDatabase,"Products" //Set the connection string property for the database.SetDatabaseProperty,Products,ConnectionString,"ÛserID:^?Password:;LOCAL;IF;//Local:server1/general|sqlexec@%s/%s"

Related Topics• "AddDatabaseSignon Command" (p. 42)• "AddDatabaseSignonToUser Command" (p. 43)• "AddDatabaseToUser Command" (p. 44)• "All Objects Input File" (p. 9)• "ChangeDatabaseName Command" (p. 60)• "DeleteDatabase Command" (p. 71)• "SetDatabaseProperty Command" (p. 93)

AddDatabaseCube Command

SyntaxAddDatabaseCube,DatabaseName,DatabaseCubeName

Applies ToDatabaseCube Object


DatabaseName Required. Specifies the name of the database to add, for example, "Sales". This name must be unique within a namespace and have the same name as the database.

Type: String

ConnectionString Required. Specifies a connection string that identifies the location of the data. The syntax is connection string.

Type: String


Chapter 5: Commands

DescriptionAdds a cube stored in a database to the namespace.

DiscussionA database cube is a data source that contains multidimensional information. An in-database cube represents a Transformer PowerCube that exists as a data source in a database. The name of the DatabaseCube object in the namespace must be the same as the name of the database cube the user wants as a data source.

Access Manager stores information for access to databases and cubes contained within databases. While the database may have its own security applied, the cube can also have Access Manager user class security applied. Access Manager enables you to manage both the user classes and database connection information.

To associate a database cube with a user, see AddDatabaseCubeToUser Command.

After a database cube is added, you can change the database cube name, delete the database cube, or set database properties, such as the description, connection string, and name.

ExampleThis example adds the Sales98, Finance98, and Marketing98 cubes from the FinancialData1 database to the current namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add database cubes to the namespace.AddDatabaseCube,"FinancialData1","Sales98" AddDatabaseCube,"FinancialData1","Finance98" AddDatabaseCube,"FinancialData1","Marketing98"

Related Topics• "AddDatabaseCubeToUser Command" (p. 41)• "AddDatabaseSignonToUser Command" (p. 43)• "AddDatabaseToUser Command" (p. 44)• "ChangeDatabaseCubeName Command" (p. 61)• "DeleteDatabaseCube Command" (p. 72)• "SetDatabaseCubeProperty Command" (p. 91)

AddDatabaseCubeToUser Command

SyntaxAddDatabaseCubeToUser,DatabaseName,DatabaseCubeName,UserName


User Object


DatabaseName Required. Specifies the name of the database containing the cube. This name must be unique within a namespace and have the same name as the database containing the cube.

Type: String

DatabaseCubeName Required. Specifies the name of the cube stored in a database, for example, "Sales98". This name must be unique within a namespace and have the same name as the cube in the database.

Type: String


Chapter 5: Commands

DescriptionAssociates a local cube to a user.

DiscussionUse this command to make a cube stored in a database available to a user as a data source. This association gives the user access to a database cube that contains multidimensional information.

Before you can associate a database cube to a user, the DatabaseCube and the User objects must exist in the namespace.

You do not have to associate a database to a user before associating a database cube with a user. If you have not previously associated a database with a user, you can use this command and Access Manager will automatically associate the corresponding database to the user for you.

ExampleThis example adds three database cubes to the namespace, and associates the Sales98, Finance98, and Marketing98 cubes from the FinancialData1 database with the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add in-database cubes to namespace.AddDatabaseCube,"FinancialData1","Sales98"AddDatabaseCube,"FinancialData1","Finance98"AddDatabaseCube,"FinancialData1","Marketing98"//Associate database cubes with a user.AddDatabaseCubeToUser,"FinancialData1","Sales98","Bill Gibbons" AddDatabaseCubeToUser,"FinancialData1","Finance98","Bill Gibbons" AddDatabaseCubeToUser,"FinancialData1","Marketing98","Bill Gibbons"

Related Topics• "AddDatabaseCube Command" (p. 40)• "AddDatabaseSignonToUser Command" (p. 43)• "Object Association Commands" (p. 33)

AddDatabaseSignon Command

SyntaxAddDatabaseSignon,DatabaseName,SignonName

Applies ToDatabaseSignon Object

DescriptionAdds a database signon to your database.


DatabaseName Required. Specifies the unique name of the database that contains the cube to associate.

Type: String

DatabaseCubeName Required. Specifies the name of the cube within the database.

Type: String

UserName Required. Specifies the name of the user to associate the database cube with.

Type: String


Chapter 5: Commands

DiscussionUse this command to add a signon for a database to permit a user auto-access to a database. A database signon identifies what databases a user can automatically access after they are authenticated. For example, when a user attempts to access a cube stored in a database (a database cube), Access Manager provides PowerPlay with the user ID, password, and connection string to the database.

A database signon name is unique within a Database object. This means that you can have the same signon within two different databases. The Database object must exist in the namespace before you can add a database signon.

The database signon contains important information relating the database, such as the connection string that enables you to log on to the database server. The signon attributes of a database are different from the basic signon and OS signon attributes for the User object.

After you add a database signon, use the SetDatabaseSignonProperty command to assign a password to the database signon.

A database signon is unique for a database. After you add the database signon, you can also change the database signon, delete the database signon, or set database properties, such as the description, connection string, and name.

ExampleThis example adds a database signon to the Products database and sets the database signon password to ABC12. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Adds a database signon and sets a new password.AddDatabaseSignon,"Products","SignonA" SetDatabaseSignonProperty,"Products","SignonA","Password","ABC12"

Related Topics• "AddDatabaseSignonToUser Command" (p. 43)• "ChangeDatabaseSignonName Command" (p. 62)• "DeleteDatabaseSignon Command" (p. 74)• "DeleteDatabaseSignonFromUser Command" (p. 75)• "SetDatabaseSignonProperty Command" (p. 94)

AddDatabaseSignonToUser Command

SyntaxAddDatabaseSignonToUser,DatabaseName,DatabaseSignonName,UserName


User Object

DescriptionAssociates a database signon to a user.


DatabaseName Required. Specifies the unique name of the database in the namespace.

Type: String

SignonName Required. Specifies the database signon name.

Type: String


Chapter 5: Commands

DiscussionUse this command to add a signon for a database to permit a user auto-access to a database. Associating a database signon to a user identifies what databases the user can automatically access after they are authenticated. The database signon contains important information relating the database, such as the connection string that you can use to log on to the database server.

A database signon name is unique within a Database object. This means that you can have the same signon within two different databases.

The Database, Database signon, and User objects must exist in the namespace before you can associate a database signon to a user.


ExampleThis example adds a Products database to the namespace, adds a database signon for the Products database, sets the database signon password, and associates the Products database and database signon with the user Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Adds a database to the namespace.AddDatabase,"Products"//Adds a database signon for the database.AddDatabaseSignon,"Products","SignonA"//Set a password for the database signon.SetDatabaseSignonProperty,"Products","SignonA","Password","ABC12"//Associate the database with a user.AddDatabaseToUser,"Products","Bill Gibbons"//Associate a database signon with a user.AddDatabaseSignonToUser,"Products","SignonA","Bill Gibbons"

Related Topics• "AddDatabaseSignon Command" (p. 42)• "AddDatabaseToUser Command" (p. 44)• "Object Association Commands" (p. 33)

AddDatabaseToUser Command

SyntaxAddDatabaseToUser,DatabaseName,UserName


User Object


DatabaseName Required. Specifies the name of a database in the namespace.

Type: String

DatabaseSignonName Required. Specifies a database signon name for the database.

Type: String

UserName Required. Specifies the name of a user in the namespace.

Type: String


Chapter 5: Commands

DescriptionAssociates a database to a user.

DiscussionUse this command to add a database to a user as a data source. Associating a database to a user identifies what databases the user can access once they are authenticated.

The Database object and the User object must exist before you can associate a database with a user.


ExampleThis example adds a Products database to the namespace, adds a database signon for the Products database, sets the database signon password, and associates the Products database and database signon with the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Adds a database signon and sets a password.AddDatabase,"Products"//Adds a database signon and sets a password.AddDatabaseSignon,"Products","SignonA"//Set a password for the database signon.SetDatabaseSignonProperty,"Products","SignonA","Password","ABC12"//Associate the database to the user.AddDatabaseToUser,"Products","Bill Gibbons" //Associate a database signon to a user.AddDatabaseSignonToUser,"Products","SignonA","Bill Gibbons"

Related Topics• "AddDatabaseCube Command" (p. 40)• "AddDatabaseCubeToUser Command" (p. 41)• "AddDatabaseSignon Command" (p. 42)• "AddDatabaseSignonToUser Command" (p. 43)• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)

AddFolder Command

SyntaxAddFolder,FolderType,FolderName,ParentFolderName

Applies ToFolder Object

DescriptionAdds a Folder object to the current namespace.


DatabaseName Required. Specifies the name of the database in the namespace.

Type: String

UserName Required. Specifies the name of the user in the namespace.

Type: String


Chapter 5: Commands

DiscussionUse this command to add a new subfolder to an existing folder. There are two types of folders that exist in Access Manager: UserFolder and DataSourceFolder. Both folder types can have the same names.

To delete a Folder object from a namespace, use the DeleteFolder command.

ExampleThis example adds two folders, both called Sales Personnel but representing different types (UserFolder type and DataSourceFolder type), to the current namespace. Next, it adds another folder called Managers of DataSourceFolder type as a subfolder of Sales Personnel folder. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a folder.AddFolder,"UserFolder","Sales Personnel","Users" AddFolder,"DataSourceFolder","Sales Personnel","Data Sources" AddFolder,"DataSourceFolder","Managers","Sales Personnel"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangeFolderName Command" (p. 63)• "DeleteFolder Command" (p. 76)• "Object Association Commands" (p. 33)• "SetUserFolder Command" (p. 105)

AddMetadataObject Command

SyntaxAddMetadataObject,MetadataObjectName,MetadataObjectTypeName

Applies ToMetadataObject Object

DescriptionAdds a Metadata object as a data source to a namespace.

DiscussionUse this command to create a new Metadata object. The Metadata object name must be unique within a namespace.


FolderType Required. Specifies the type of folder, either UserFolder or DataSourceFolder.

Type: String

FolderName Required. Specifies the name of a folder to add to a namespace.

Type: String

ParentFolderName Required. Specifies the name of a main folder that contains one or more subfolders.

Type: String


Chapter 5: Commands

The namespace must exist before you can add data sources to it. To access a metadata source through Architect, you must select the type for the Metadata object. Ensure that you specify a valid metadata type because Access Manager does not validate this parameter. For a list of valid metadata types, see Architect documentation.

To associate a Metadata object to a user, use the AddMetadataObjectToUser command.

ExampleThis example adds a Metadata object, Company Model, to a namespace and then associates it with the users, Bill Gibbons and Dave Mustaine. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Metadata object to the current namespace.AddMetadataObject,"Company Model","Architect Model" //Add a Metadata object to a user.AddMetadataObjectToUser,"Company Model","Gibbons, Bill"AddMetadataObjectToUser,"Company Model","Mustaine, Dave"

Related Topics• "AddMetadataObjectToUser Command" (p. 47)• "All Objects Input File" (p. 9)• "ChangeMetadataObjectName Command" (p. 63)• "Object Association Commands" (p. 33)• "SetMetadataObjectProperty Command" (p. 96)

AddMetadataObjectToUser Command

SyntaxAddMetadataObjectToUser,MetadataObjectName,UserName


User Object

DescriptionAssociates a Metadata object to a user.

DiscussionUse this command to make a Metadata object available to a user as a data source.

To remove a user's association to a Metadata object, use the RemoveMetadataObjectFromUser command.


MetadataObjectName Required. Specifies the unique name of a Metadata object.

Type: String

MetadataObjectTypeName Required. Specifies the name of a Metadata object type, for example Architect Model, ERWin Model, or Informatica Model.

Type: String


Chapter 5: Commands

A User object must exist before you can add data sources to it.

ExampleThis example associates a Metadata object, Company Model, to the users, Bill Gibbons and Dave Mustaine. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Metadata object to a namespace.AddMetadataObject,"Company Model","Architect Model"//Add a Metadata object to a user.AddMetadataObjectToUser,"Company Model","Gibbons, Bill" AddMetadataObjectToUser,"Company Model","Mustaine, Dave"

Related Topics• "All Objects Input File" (p. 9)• "ChangeMetadataObjectName Command" (p. 63)• "Object Association Commands" (p. 33)• "SetMetadataObjectProperty Command" (p. 96)

AddNamespace Command

SyntaxAddNamespace,NamespaceName

Applies ToNamespace Object

DescriptionAdds a namespace to a directory server.

DiscussionA namespace is a container for signon information for users, the user classes to which each user belongs, information about data sources and application servers. Namespaces are unique within a directory server. When you add a namespace to a directory server, Access Manager automatically creates a Root User Class, a root user called Administrator with a logon ID and a blank password. The default signon type is basic signon. For a new namespace, Access Manager also sets all permissions (create, delete, and show) for user classes, users, data sources, PowerPlay servers and Transformer servers. Access Manager also sets the Show All permission for user classes.

The Administrator user has full access rights to the namespace and can create users, user classes, and add signon information about servers and data sources. You can create other namespace administrators by adding users to the Root User Class. Each user that has Administrator access rights must have a basic signon to be able to access the namespace.

To access a namespace, you must log on to the namespace. You can only log on to a namespace if you belong to a user class that has permissions to view or edit the contents of a namespace, and you have a user ID. The default user ID for the administrator for each namespace is Administrator. Other users must have a basic or OS Signon associated with them before they can access a namespace. The default administrator that is created for each namespace has a blank password.


MetadataObjectName Required. Specifies the unique name of a Metadata object.

Type: String

UserName Required. Specifies the name of a user. This name must be unique within a namespace and be at least one character in length.

Type: String


Chapter 5: Commands

Notes• You can only rename objects in a namespaces that you have been granted access to by an

administrator.• You must create a namespace before you can create users or user classes, or before you can

add application servers or data sources that the users can access.• There is no limit to the number of namespaces you can add to a directory server. The limit for

a local authentication export file (.lae) is 24.

ExampleThis example creates a new namespace called Regions, logs on to the namespace, sets the minimum length and case sensitivity properties for passwords, and then automatically logs off the namespace.//Create Regions namespace.AddNamespace,"Regions" //Log on to the Regions namespace using the default basic//signon name Administrator with the default (blank) password.LogonNamespace,"Regions","Administrator",""SetNamespaceProperty,"Regions","PasswordMinLength","6"SetNamespaceProperty,"Regions","PasswordCaseSensitivity","Yes"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteNamespace Command" (p. 77)• "LogoffNamespace Command" (p. 87)• "SetNamespaceProperty Command" (p. 97)

AddPowerPlayServer Command

SyntaxAddPowerPlayServer,PowerPlayServerName

Applies ToPowerPlayServer Object

DescriptionAdds a PowerPlay server to the current namespace.

DiscussionUse this command to add a PowerPlay server resource as a data source. There is no signon associated with a PowerPlay server.


NamespaceName Required. Specifies the name for the namespace, for example, Sales Regions. This name must be unique within a directory server.

Type: String


PowerPlayServerName Required. Specifies the name of a PowerPlay server. This name must be the same name as the PowerPlay server.

Type: String


Chapter 5: Commands

ExampleThis example adds a PowerPlay server to the current namespace . Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a PowerPlay server to the namespace.AddPowerPlayServer,"PPWebServer"

Related Topics• "All Objects Input File" (p. 9)• "ChangePowerPlayServerName Command" (p. 64)• "Commands" (p. 35)• "DeletePowerPlayServer Command" (p. 78)

AddTransformerServer Command

SyntaxAddTransformerServer,TransformerServerName

Applies ToTransformerServer Object

DescriptionAdds a Transformer server to the namespace.

DiscussionUse this command to add a Transformer server that users can access as a data source. The name of the Transformer server in the namespace must be the same as the name of the Transformer server to which you connect.

To associate a Transformer server to a user, use the AddTransformerServerToUser command. After you add a Transformer server, use the AddTransformerServerSignon command to add the signon information associated with the Transformer server.

A Transformer server signon identifies what servers a user can automatically access once they are authenticated. To associate a Transformer server signon to a user, use the AddTransformerServerSignonToUser command.

ExampleThis example adds a Transformer server named TransWinServer, adds a Transformer server signon named TransSignonA, and associates the Transformer server and Transformer server signon with the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Transformer server to the namespace.AddTransformerServer,"TransWinServer" //Add a Transformer server signon to the namespace.AddTransformerServerSignon,"TransWinServer","TransSignonA"//Associate the Transformer server with a user.AddTransformerServerToUser,"TransWinServer","Bill Gibbons"//Associate the Transformer server with a user.AddTransformerServerSignonToUser,"TransWinServer","TransSignonA","Bill Gibbons"


TransformerServerName Required. Specifies the same name of the Transformer server to which you want to connect.

Type: String


Chapter 5: Commands

Related Topics• "AddTransformerServerSignon Command" (p. 52)• "ChangeTransformerServerName Command" (p. 65)• "DeleteTransformerServer Command" (p. 79)• "SetTransformerServerProperty Command" (p. 100)

AddTransformerServerToUser Command

SyntaxAddTransformerServerToUser,TransformerServerName,UserName


User Object

DescriptionAssociates a Transformer server to a user.

DiscussionUse this command to associate a Transformer server with a user.

The TransformerServer and User object must exist before you can associate a Transformer server to a user.


ExampleThis example adds a Transformer server named TransWinServer, adds a Transformer server signon named TransSignonA, and associates the Transformer server and Transformer server signon with the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Transformer server to the namespace.AddTransformerServer,"TransWinServer"//Add a Transformer server signon to the namespace.AddTransformerServerSignon,"TransWinServer","TransSignonA"//Associate the Transformer server with a user.AddTransformerServerToUser,"TransWinServer","Bill Gibbons" //Associate the Transformer server with a user.AddTransformerServerSignonToUser,"TransWinServer","TransSignonA","Bill Gibbons"

Related Topics• "AddTransformerServer Command" (p. 50)• "AddTransformerServerSignon Command" (p. 52)


TransformerServerName Required. Specifies the name of the Transformer server in the namespace. This name must be the same name of the Transformer server to which you are connecting.

Type: String


Type: String


Chapter 5: Commands

• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)

AddTransformerServerSignon Command

SyntaxAddTransformerServerSignon,TransformerServerName,TransformerServerSignonName

Applies ToTransformerServerSignon Object

DescriptionAdds a Transformer server signon to a Transformer server.

DiscussionUse this command to add a Transformer server signon that you can associate with a user for accessing a Transformer server. For example, when a user attempts to access a Transformer server, Access Manager must validate the Transformer server signon before granting access to that server.

The signon attributes of a Transformer server are different from the basic signon and OS signon attributes of the User object.

A TransformerServer object must exist in the namespace before you can add a signon for the server.

After you add a Transformer server signon, use the AddTransformerServerSignonToUser command to associate the signon with a user. A Transformer server signon identifies what servers a user can automatically access after they are authenticated.

ExampleThis example adds a Transformer server named TransWinServer, adds a Transformer server signon named TransSignonA, and associates the Transformer server and Transformer server signon with the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Transformer server to the namespace.AddTransformerServer,"TransWinServer"//Add a Transformer server signon to the namespace.AddTransformerServerSignon,"TransWinServer","TransSignonA"//Associate the Transformer server with a user.AddTransformerServerToUser,"TransWinServer","Bill Gibbons"//Associate the Transformer server with a user.AddTransformerServerSignonToUser,"TransWinServer","TransSignonA","Bill Gibbons"

Related Topics• "ChangeTransformerServerSignonName Command" (p. 66)• "DeleteTransformerServerSignon Command" (p. 80)


TransformerServerName Required. Specifies the name of a Transformer server in the namespace.

Type: String

TransformerServerSignonName Required. Specifies the name of a Transformer server signon. This name must be the same as the signon name associated with the Transformer server.

Type: String


Chapter 5: Commands

• "DeleteTransformerServerSignonFromUser Command" (p. 81)• "SetPowerPlayServerProperty Command" (p. 99)

AddTransformerServerSignonToUser Command

SyntaxAddTransformerServerSignonToUser,TransformerServerName,

TransformerServerSignonName,UserName


User Object

DescriptionAssociates a Transformer server signon to a user.

DiscussionUse this command to make a Transformer server signon available to a user. A Transformer server signon identifies what servers a user can automatically access after they are authenticated. For example, when a user attempts to access a Transformer server, Access Manager must validate the Transformer server signon before granting access to that server.

A TransformerServer, TransformerServerSignon, and User object must exist in the namespace before you can add a signon for the server.

A Transformer server signon is unique for a Transformer server.

The signon attributes of a Transformer server are different from the basic signon and OS signon attributes for the User object.


ExampleThis example adds a Transformer server named TransWinServer, adds a Transformer server signon named TransSignonA, and associates the Transformer server and Transformer server signon with the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Transformer server to the namespace.AddTransformerServer,"TransWinServer"//Add a Transformer server signon to the namespace.AddTransformerServerSignon,"TransWinServer","TransSignonA"


TransformerServerName Required. Specifies the name of a Transformer server in a namespace.

Type: String

TransformerServerSignonName Required. Specifies the name of a Transformer server signon. This name must be the same as the signon name associated with the Transformer server.

Type: String


Type: String


Chapter 5: Commands

//Associate the Transformer server with a user.AddTransformerServerToUser,"TransWinServer","Bill Gibbons"//Associate the Transformer server with a user.AddTransformerServerSignonToUser,"TransWinServer","TransSignonA","Bill Gibbons"

Related Topics• "AddTransformerServer Command" (p. 50)• "AddTransformerServerSignon Command" (p. 52)• "AddTransformerServerToUser Command" (p. 51)• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)

AddUser Command

SyntaxAddUser,UserName

Applies ToUser Object

DescriptionAdds a user to a namespace.

DiscussionA user is an object that represents a specific individual in an organization. The Administrator user is automatically created when you create a namespace, and it• belongs to the root user class• has the full permissions specified for the root user class• cannot be deleted

As an administrator, you can• add, modify, and delete users• define basic signons, OS signons, or both for users• assign the users to user classes• add, modify, and delete application servers and data sources

Each individual that you want to be able to access protected data must be added to Access Manager as a user. After you add the user, they can then be assigned to user classes, for which access is defined in the client application.

You must create a namespace before you can create users or user classes or before you can add application servers or data sources that the users can access.

Notes• Users can be a member of more than one user class. • After you add user classes and users, you can assign the users to any number of user classes.• The user name identifies a user in Access Manager. The name used to authenticate the user in

the client application depends on their basic or OS signon.


UserName Required. Specifies the name of the new user. This name must be unique within a namespace, and have at least one character.

Type: String


Chapter 5: Commands

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine, adds two user classes named Sales Representative and Sales VPs, associates the users with existing user classes, and adds signons for the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add users to the namespace.AddUser,"Gibbons, Bill" AddUser,"Richard, Fred" AddUser,"Mustaine, Dave" //Add user classes to the namespaceAddUserClass,"Sales Representatives","Root User Class"AddUserClass,"Sales VPs","Root User Class"//Associate users to user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs"AddUserToUserClass,"Richard, Fred","Sales Representatives"AddUserToUserClass,"Mustaine, Dave","Sales Representatives"//Creates signons for users.AddUserOSSignon,"Gibbons, Bill","gibbonsb"AddUserBasicSignon,"Fred Richard","richardf"AddUserBasicSignon,"Dave Mustaine","mustaind"

Related Topics• "AddUserBasicSignon Command" (p. 55)• "AddUserClass Command" (p. 56)• "AddUserOSSignon Command" (p. 57)• "AddUserToUserClass Command" (p. 58)• "ChangeUserName Command" (p. 68)• "DeleteUser Command" (p. 82)• "SetUserProperty Command" (p. 106)• "LinkUser Command" (p. 85)• "RelinkUser Command" (p. 88)

AddUserBasicSignon Command

SyntaxAddUserBasicSignon,UserName,BasicSignonName

Applies ToBasicSignon Object

DescriptionAdds a basic signon to a user.

DiscussionUse this command to create a basic signon for a user. A signon consists of a user ID and password and is used to identify a user. You can only create one basic signon for each user. If you add a basic signon to a user that already has one assigned, the newer signon will overwrite the older signon.

Use the Password property of the SetUserBasicSignonProperty command to set a password for the user's basic signon. The user has only one basic signon. A basic signon name is unique within a namespace.

If a user has a basic signon and an OS signon, Access Manager uses the OS signon by default.


Chapter 5: Commands

The User and BasicSignon objects must exist before you can add a basic signon to a user.

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine, adds two user classes named Sales Representative and Sales VPs, associates the users with existing user classes, and adds signons for the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add users to the namespace.AddUser,"Gibbons, Bill"AddUser,"Richard, Fred"AddUser,"Mustaine, Dave"//Add user classes to the namespace.AddUserClass,"Sales Representatives","Root User Class"AddUserClass,"Sales VPs","Root User Class"//Associate users to user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs"AddUserToUserClass,"Richard, Fred","Sales Representatives"AddUserToUserClass,"Mustaine, Dave","Sales Representatives"//Creates signons for users.AddUserOSSignon,"Gibbons, Bill","gibbonsb"AddUserBasicSignon,"Richard, Fred","richardf" AddUserBasicSignon,"Mustaine, Dave","mustaind"

Related Topics• "ChangeUserBasicSignonName Command" (p. 67)• "DeleteUserBasicSignon Command" (p. 82)• "SetUserBasicSignonProperty Command" (p. 102)

AddUserClass Command

SyntaxAddUserClass,UserClassName,ParentUserClassName

Applies ToUserClass Object

DescriptionAdds a user class to a namespace.

DiscussionUse this command to control access to other IBM Cognos applications. When you add a user class, you can add it to the Root User Class or an existing user class under the Root User Class. When you add a namespace, Access Manager automatically creates the default Root User Class.

When you add a user class, the name must be unique within a namespace. Each user class that you add is contained within the Root User Class. If you add a child user class to a parent, the child user class will inherit all existing properties of the parent user class, such as restrictions and user class privileges.


BasicSignonName Required. Specifies the name of a basic signon in the namespace.

Type: String


Type: String


Chapter 5: Commands

You can organize the user classes according to how your business is structured. In this way, you can easily assign data access capabilities in the same way that you would otherwise distribute the data to classes of users. You can also build multiple structures because users can belong to more than one user class. In these structures listed above, a user might be a member of both Senior Managers (by function) and National Offices (by region). For example, you may want to set up user classes by function (Vice Presidents, Senior Managers, and Regional Managers), and by region (All Regions, National Offices, District Offices, Plants).

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine, adds two user classes named Sales Representative and Sales VPs, associates the users with existing user classes, and adds signons for the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add users to the namespace.AddUser,"Gibbons, Bill"AddUser,"Richard, Fred"AddUser,"Mustaine, Dave"//Add user classes to the namespace.AddUserClass,"Sales Representatives","Root User Class" AddUserClass,"Sales VPs","Root User Class" //Associate users to user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs"AddUserToUserClass,"Richard, Fred","Sales Representatives"AddUserToUserClass,"Mustaine, Dave","Sales Representatives"//Creates signons for users.AddUserOSSignon,"Gibbons, Bill","gibbonsb"AddUserBasicSignon,"Fred Richard","richardf"AddUserBasicSignon,"Dave Mustaine","mustaind"

Related Topics• "AddUser Command" (p. 54)• "AddUserBasicSignon Command" (p. 55)• "AddUserOSSignon Command" (p. 57)• "AddUserToUserClass Command" (p. 58)• "ChangeUserClassName Command" (p. 68)• "DeleteUserClass Command" (p. 83)• "SetUserClassProperty Command" (p. 103)

AddUserOSSignon Command

SyntaxAddUserOSSignon,UserName,OSSignonName

Applies ToOSSignon Object


UserClassName Required. Specifies the new user class name, for example, Sales Representatives. This name must be unique within the namespace.

Type: String

ParentUserClassName Required. Specifies the parent user class name of the new user class. The parent can be the Root User Class or another user class.

Type: String


Chapter 5: Commands

DescriptionAdds an OS signon for a user.

DiscussionUse this command to create an OS signon for a user in a namespace.

Access Manager uses an operating system (OS) signon as a means of authentication. An OS signon relies on the security of the operating system.

The User object must exist in the namespace before you add a signon to the user.

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine, adds two user classes named Sales Representative and Sales VPs, associates the users with existing user classes, and adds signons for the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add users to the namespace.AddUser,"Gibbons, Bill"AddUser,"Richard, Fred"AddUser,"Mustaine, Dave"//Add user classes to the namespace.AddUserClass,"Sales Representatives","Root User Class"AddUserClass,"Sales VPs","Root User Class"//Associate users to user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs"AddUserToUserClass,"Richard, Fred","Sales Representatives"AddUserToUserClass,"Mustaine, Dave","Sales Representatives"//Creates signons for users.AddUserOSSignon,"Gibbons, Bill","gibbonsb" AddUserBasicSignon,"Richard, Fred","richardf"AddUserBasicSignon,"Mustaine, Dave","mustaind"

Related Topics• "AddUser Command" (p. 54)• "AddUserBasicSignon Command" (p. 55)• "AddUserToUserClass Command" (p. 58)• "ChangeUserOSSignonName Command" (p. 69)• "DeleteUserOSSignon Command" (p. 85)• "SetUserOSSignonProperty Command" (p. 105)

AddUserToUserClass Command

SyntaxAddUserToUserClass,UserName,UserClassName


UserClass Object


OSSignonName Required. Specifies the name of an OS signon that exists in the namespace.

Type: String


Type: String


Chapter 5: Commands

DescriptionAssociates a user to a user class.

DiscussionUse this command to associate a user with a user class. Associating a user to a user class makes that user a member of the user class and the user inherits the permissions available to that user class.

A user can belong to more than one user class.

The User and the UserClass object must exist before you can associate a user with a user class.

ExampleThis example adds three users named Bill Gibbons, Fred Richard, and Dave Mustaine, adds two user classes named Sales Representative and Sales VPs, associates the users with existing user classes, and adds signons for the users. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add users to the namespace.AddUser,"Gibbons, Bill"AddUser,"Richard, Fred"AddUser,"Mustaine, Dave"//Add user classes to the namespace.AddUserClass,"Sales Representatives","Root User Class"AddUserClass,"Sales VPs","Root User Class"//Associate users to user classes.AddUserToUserClass,"Gibbons, Bill","Sales VPs" AddUserToUserClass,"Richard, Fred","Sales Representatives" AddUserToUserClass,"Mustaine, Dave","Sales Representatives" //Creates signons for users.AddUserOSSignon,"Gibbons, Bill","gibbonsb"AddUserBasicSignon,"Fred Richard","richardf"AddUserBasicSignon,"Dave Mustaine","mustaind"

Related Topics• "AddUser Command" (p. 54)• "AddUserClass Command" (p. 56)• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)

ChangeCubeName Command

SyntaxChangeCubeName,CubeName,NewCubeName


DescriptionSets a new name for a local cube data source.


UserClassName Required. Specifies the user class name, for example, Sales Representatives.

Type: String


Type: String


Chapter 5: Commands

DiscussionUse this command to change the name of a local cube in the current namespace. If the name of the .mdc file for the cube changes, you must also change the name of the cube in all namespaces that reference this cube as a data source. Access Manager automatically updates the cube name for all users that references this name.

The new name must be unique within the namespace.

ExampleThis example changes the name of the Sales98 cube to European Sales 98. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the cube.ChangeCubeName,"Sales98","European Sales 98"

Related Topics• "AddCube Command" (p. 38)• "AddCubeToUser Command" (p. 39)• "DeleteCube Command" (p. 70)• "DeleteCubeFromUser Command" (p. 70)• "SetCubeProperty Command" (p. 91)

ChangeDatabaseName Command

SyntaxChangeDatabaseName,DatabaseName,NewDatabaseName


DescriptionSets a new name for a Database object.

DiscussionUse this command to change the name of a database in a namespace. If the name of the database changes, you must also change the name of the database in all namespaces that reference this database as a data source. Access Manager automatically updates the database name for all users that reference this name.



CubeName Required. Specifies the name of an existing cube.

Type: String

NewCubeName Required. Specifies the new name for the local cube. This name must be unique within a namespace and have at least one character. It must be the same name as the .mdc file, such as "Sales98".

Type: String


DatabaseName Required. Specifies the name of an existing database in the namespace.

Type: String


Chapter 5: Commands

ExampleThis example changes the name of the FinDB98 database to FinanceDatabase98. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the database.ChangeDatabaseName,"FinDB98","FinanceDatabase98"

Related Topics• "AddDatabase Command" (p. 39)• "AddDatabaseToUser Command" (p. 44)• "DeleteDatabase Command" (p. 71)• "DeleteDatabaseFromUser Command" (p. 73)• "SetDatabaseProperty Command" (p. 93)

ChangeDatabaseCubeName Command

SyntaxChangeDatabaseCubeName,DatabaseName,DatabaseCubeName,NewDatabaseCubeName


DescriptionSets a new name for a database cube.

DiscussionUse this command to change the name of a database cube in a namespace. If the name of the database cube changes, you must also change the name of the database cube in all namespaces that reference this database as a data source. Access Manager automatically updates the database cube name for all users that reference this name.


NewDatabaseName Required. Specifies the new name for a database. The new name must be unique within the namespace and have at least one character.

Type: String



DatabaseName Required. Specifies the name of the database containing the cube.

Type: String

DatabaseCubeName Required. Specifies the name of an existing cube data source within a database.

Type: String

NewDatabaseCubeName Required. Specifies the new name for a cube within a database. The new name must be unique within the namespace and have at least one character.

Type: String


Chapter 5: Commands

ExampleThis example changes the name of the Sales98 database cube to European Sales 98. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the database cube.ChangeDatabaseCubeName,"SalesDB","Sales98","European Sales98"

Related Topics• "AddDatabaseCube Command" (p. 40)• "AddDatabaseCubeToUser Command" (p. 41)• "DeleteDatabaseCube Command" (p. 72)• "DeleteDatabaseCubeFromUser Command" (p. 73)• "SetDatabaseCubeProperty Command" (p. 91)

ChangeDatabaseSignonName Command

SyntaxChangeDatabaseSignonName,DatabaseName,DatabaseSignonName,NewDatabaseSignonName


DescriptionSets a new name for a database signon.

DiscussionUse this command to change the name of a database signon in a namespace. If the name of the database signon changes, you must also change the name of the database signon in all namespaces that reference this signon. Changing the name updates all references to this name in the current namespace.

ExampleThis example changes the name of the DBSignon database signon to SalesDBSignon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the database signon.ChangeDatabaseSignonName,"SalesDB","DBSignon","SalesDBSignon"

Related Topics• "AddDatabaseSignon Command" (p. 42)• "AddDatabaseSignonToUser Command" (p. 43)


DatabaseName Required. Specifies the name of the database.

Type: String

DatabaseSignonName Required. Specifies the name of an existing database signon.

Type: String

NewDatabaseSignonName Required. Specifies the new name for a database signon. The new name must be unique within the namespace and have at least one character.

Type: String


Chapter 5: Commands

• "DeleteDatabaseSignon Command" (p. 74)• "DeleteDatabaseSignonFromUser Command" (p. 75)• "SetDatabaseSignonProperty Command" (p. 94)

ChangeFolderName Command

SyntaxChangeFolderName,FolderType,FolderName,NewFolderName


DescriptionSets a new name for a folder.

DiscussionUse this command to change the name of a folder in the current namespace. Both types, UserFolder and DataSourceFolder, can have the same names.

ExampleThis example changes the names of two folders from Sales Personnel to Personnel. Next, it changes the name of the folder from Old Data Sources to Updated Data Sources. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the folder name.ChangeFolderName,"UserFolder","Sales Personnel","Personnel" ChangeFolderName,"DataSourceFolder","Sales Personnel","Personnel" ChangeFolderName,"DataSourceFolder","Old Data Sources", "Updated Data Sources"

Related Topics• "AddFolder Command" (p. 45)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteFolder Command" (p. 76)• "Object Association Commands" (p. 33)

ChangeMetadataObjectName Command

SyntaxChangeMetadataObjectName,MetadataObjectName,NewMetadataObjectName


FolderType Required. Specifies the type of folder, either UserFolder or DataSourceFolder.

Type: String

FolderName Required. Specifies the name of an existing folder.

Type: String

NewFolderName Required. Specifies the new name for an existing folder. Both types, UserFolder and DataSourceFolder, can have the same names.

Type: String


Chapter 5: Commands


DescriptionSets a new name for a Metadata object.

DiscussionUse this command to change the name of a Metadata object in a namespace. If you change the name of a Metadata object, you must also change the name of the Metadata object in all namespaces that reference this object as a data source. Access Manager automatically updates the Metadata object name for all users who reference this name. The new name must be unique within a namespace.

ExampleThis example changes the name of the Metadata object, Company Model, to Model 2000. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the Metadata object. ChangeMetadataObjectName,"Company Model","Model 2000"

Related Topics• "AddMetadataObject Command" (p. 46)• "AddMetadataObjectToUser Command" (p. 47)• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)• "SetMetadataObjectProperty Command" (p. 96)

ChangePowerPlayServerName Command

SyntaxChangePowerPlayServerName,PowerPlayServerName,NewPowerPlayServerName


DescriptionSets a new name for a PowerPlay server.

DiscussionUse this command to change the name of a PowerPlay server that appears as a data source in a namespace. If the name of the PowerPlay server changes, you must also change the name of the PowerPlay server in all namespaces that reference this server. Changing the name updates all references to this name in the current namespace.


MetadataObjectName Required. Specifies the unique name of the existing Metadata object.

Type: String

NewMetadataObjectName Required. Specifies the new name for a Metadata object. This name must be unique within a namespace and be at least one character in length.

Type: String


Chapter 5: Commands

The new name must be unique within the namespace and match the name of the PowerPlay server to which you want to connect.

ExampleThis example changes the PowerPlay server name from PPS to WestPPServer1. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the PowerPlay server.ChangePowerPlayServerName,"PPS","WestPPServer1"

Related Topics• "AddPowerPlayServer Command" (p. 49)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeletePowerPlayServer Command" (p. 78)• "SetPowerPlayServerProperty Command" (p. 99)

ChangeTransformerServerName Command

SyntaxChangeTransformerServerName,TransformerServerName,NewTransformerServerName


DescriptionSets a new name for a Transformer server.

DiscussionUse this command to change the name of a Transformer server in the current namespace. If the name of the Transformer server changes, you must also change the name of the Transformer server in all namespaces that reference this server. Changing the name updates all references to this name in the current namespace.

The new name must be unique within the namespace and be the same as the Transformer server to which you want to connect.


PowerPlayServerName Required. Specifies the name of an existing PowerPlay server.

Type: String

NewPowerPlayServerName Required. Specifies the new name for a PowerPlay server. The new name must be unique within the namespace and have at least one character.

Type: String


TransformerServerName Required. Specifies the name of an existing Transformer server.

Type: String


Chapter 5: Commands

ExampleThis example changes the Transformer server from TRS to TransServer1. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the Transformer server.ChangeTransformerServerName,"TRS","TransServer1"

Related Topics• "AddTransformerServer Command" (p. 50)• "AddTransformerServerToUser Command" (p. 51)• "DeleteTransformerServer Command" (p. 79)• "DeleteTransformerServerSignonFromUser Command" (p. 81)• "SetTransformerServerProperty Command" (p. 100)

ChangeTransformerServerSignonName Command

SyntaxChangeTransformerServerSignonName,TransformerServerName,TransformerServerSignonName,NewTransformerServerSignonName


DescriptionSets a new name for a Transformer server signon.

DiscussionUse this command to change the name of a Transformer server signon in a namespace. If the name of the Transformer server signon changes, you must also change the name in all namespaces that reference this signon. Changing the name updates all references to this name in the current namespace.

The new name must be the same name as that used by the Transformer server.

NewTransformerServerName Required. Specifies the new name for a Transformer server.The new name must be unique within the namespace and have at least one character.

Type: String



TransformerServerName Required. Specifies the name of a Transformer server.

Type: String

TransformerServerSignonName Required. Specifies the name of a signon for a Transformer server.

Type: String

NewTransformerServerSignonName Required. Specifies the new name for a Transformer server signon. It must have at least one character.

Type: String


Chapter 5: Commands

ExampleThis example changes the Transformer server signon name from SignonA to Trans1. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the Transformer server signon.ChangeTransformerServerSignonName,"TransServ1","SignonA","Trans1"

Related Topics• "AddTransformerServerSignon Command" (p. 52)• "DeleteTransformerServerSignon Command" (p. 80)• "DeleteTransformerServerSignonFromUser Command" (p. 81)• "SetTransformerServerSignonProperty Command" (p. 101)

ChangeUserBasicSignonName Command

SyntaxChangeUserBasicSignonName,UserName,BasicSignonName,NewBasicSignonName


DescriptionSets a new name for a basic signon.

DiscussionUse this command to change the name of a basic signon associated with a user in a namespace. Changing the name updates all references to this name in the current namespace.

ExampleThis example changes the basic signon name for a user from FredR to Richardf. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name.ChangeUserBasicSignonName,"Fred Richard","FredR","Richardf"

Related Topics• "AddUserBasicSignon Command" (p. 55)• "DeleteUserBasicSignon Command" (p. 82)• "SetUserBasicSignonProperty Command" (p. 102)


UserName Required. Specifies the name of user within the namespace.

Type: String

BasicSignonName Required. Specifies the name of a basic signon associated with the user.

Type: String

NewBasicSignonName Required. Specifies the new basic signon association for the user.

Type: String


Chapter 5: Commands

ChangeUserClassName Command

SyntaxChangeUserClassName,UserClassName,NewUserClassName


DescriptionSets a new name for a user class.

DiscussionUse this command when you want to change the name of an existing user class in a namespace, for example, to reflect the nature of the users belonging to that user class. The new user class name must be unique within the current namespace. When you change a user class name, Access Manager automatically updates the user associations with the user class.

ExampleThis example changes the user class name from European to European Sales Representatives. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the user class name.ChangeUserClassName,"European","European Sales Representatives"

Related Topics• "AddUserClass Command" (p. 56)• "DeleteUserClass Command" (p. 83)• "SetUserProperty Command" (p. 106)

ChangeUserName Command

SyntaxChangeUserName,UserName,NewUserName


DescriptionSets a new name for a user.


NewUserClassName Required. Specifies the new user class name. This name must be unique within the current namespace.

Type: String

UserClassName Required. Specifies the name of the user class to change.

Type: String


Chapter 5: Commands

DiscussionUse this command to change the name of a user in a namespace. Changing the name updates all references to this name in the namespace. This name must be unique within a namespace.

ExampleThis example changes the name of a user from Linda Mercier to Linda Mercier-Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name of the user.ChangeUserName,"Mercier, Linda","Mercier-Gibbons, Linda"

Related Topics• "AddUser Command" (p. 54)• "DeleteUser Command" (p. 82)• "SetUserProperty Command" (p. 106)

ChangeUserOSSignonName Command

SyntaxChangeUserOSSignonName,UserName,OSSignonName,NewOSSignonName


DescriptionSets a new OS signon association for a user.

DiscussionUse this command to change the OS signon of a user in a namespace. Changing the name updates all references to this name in the current namespace.


UserName Required. Specifies the name of a user within the namespace.

Type: String

NewUserName Required. Specifies the new name for the user. The new name must be unique within the namespace. It must have at least one character.

Type: String


UserName Required. Specifies the name of user within the namespace.

Type: String

OSSignonName Required. Specifies the name of an OS signon associated with the user.

Type: String

NewOSSignonName Required. Specifies the new OS signon for the user.

Type: String


Chapter 5: Commands

ExampleThis example changes the OS signon name from gibbonsb to gibbonsbi. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Change the name.ChangeUserOSSignonName,"Gibbons, Bill","gibbonsb","gibbonsbi"

Related Topics• "AddUserOSSignon Command" (p. 57)• "DeleteUserOSSignon Command" (p. 85)• "SetUserOSSignonProperty Command" (p. 105)

DeleteCube Command

SyntaxDeleteCube,CubeName


DescriptionRemoves a local cube from the current namespace.

DiscussionUse this command to remove a local cube as a data source. Deleting this object removes all references to this object in the namespace. It does not delete the cube.

ExampleThis example removes a local cube named Sales98 from the namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a cube from the namespace.DeleteCube,"Sales98"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteCubeFromUser Command" (p. 70)

DeleteCubeFromUser Command

SyntaxDeleteCubeFromUser,CubeName,UserName


User Object


CubeName Required. Specifies the name of the local cube to remove from the namespace.

Type: String


Chapter 5: Commands

DescriptionRemoves a cube association for a user.

DiscussionUse this command to remove a local cube association for a user. Deleting this object removes this object from the user and not from the namespace. The user will no longer have access to this data source. It does not delete the cube.

ExampleThis example removes a local cube association named Sales98 from the user Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete the cube association for a user.DeleteCubeFromUser,"Sales98","Gibbons, Bill"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteCube Command" (p. 70)

DeleteDatabase Command

SyntaxDeleteDatabase,DatabaseName


DescriptionRemoves a database from the namespace.

DiscussionUse this command to remove the database as a data source. Deleting this object removes all references to this object in the namespace. It does not delete the database.

When you delete a database, you also delete the database signons associated with the database and in-database cubes.


CubeName Required. Specifies the name of the local cube to remove from the specified user.

Type: String


Type: String


DatabaseName Required. Specifies the name of an existing database data source in the namespace.

Type: String


Chapter 5: Commands

ExampleThis example deletes a database called FinanceDatabase98, and then automatically logs off the namespace.//Delete a database.DeleteDatabase,"FinanceDatabase98"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteDatabaseCube Command" (p. 72)• "DeleteDatabaseCubeFromUser Command" (p. 73)• "DeleteDatabaseFromUser Command" (p. 73)

DeleteDatabaseCube Command

SyntaxDeleteDatabaseCube,DatabaseName,DatabaseCubeName


DescriptionRemoves a database cube from a namespace.

DiscussionUse this command to delete a database cube as a data source. Deleting this object removes all references to this object in the namespace. It does not delete the database cube.

ExampleThis example removes a database cube named Sales98 in the SalesRepsDB database from the namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a database cube from the namespace.DeleteDatabaseCube,"SalesRepsDB","Sales98"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteCube Command" (p. 70)• "DeleteCubeFromUser Command" (p. 70)• "DeleteDatabase Command" (p. 71)• "DeleteDatabaseCubeFromUser Command" (p. 73)


DatabaseName Required. Specifies the name of the database that contains the cube data source to delete.

Type: String

DatabaseCubeName Required. Specifies the name of the cube data source stored within a database.

Type: String


Chapter 5: Commands

DeleteDatabaseCubeFromUser Command

SyntaxDeleteDatabaseCubeFromUser,DatabaseName,DatabaseCubeName,UserName


User Object

DescriptionRemoves a database cube association from a user.

DiscussionUse this command to delete a database cube as a data source for a user. Deleting this object only removes the database cube reference for the user. It does not delete the database cube from the namespace.

ExampleThis example deletes a database cube called Sales98 from the SalesRepsDB database for the user Bill Gibbons, and then automatically logs off the namespace.//Delete a database cube association from a user.DeleteDatabaseCubeFromUser,"SalesRepsDB","Sales98","Bill Gibbons"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteCube Command" (p. 70)• "DeleteCubeFromUser Command" (p. 70)• "DeleteDatabase Command" (p. 71)• "DeleteDatabaseCube Command" (p. 72)• "DeleteDatabaseFromUser Command" (p. 73)

DeleteDatabaseFromUser Command

SyntaxDeleteDatabaseFromUser,DatabaseName,UserName


User Object


DatabaseName Required. Specifies the name of the database that contains the cube data source to delete.

Type: String

DatabaseCubeName Required. Specifies the name of the cube data source stored within a database.

Type: String


Type: String


Chapter 5: Commands

DescriptionRemoves a database from a user.

DiscussionUse this command to remove the database as a data source for a user. Deleting this object only removes the Database object reference to the User object. It does not delete the database object from the namespace. When you remove a database, you must also remove the database signon associated with the database.

ExampleThis example removes a database named FinanceDatabase98 from the user Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a database association.DeleteDatabaseFromUser,"FinanceDatabase98","Bill Gibbons"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteCube Command" (p. 70)• "DeleteDatabase Command" (p. 71)• "DeleteDatabaseCube Command" (p. 72)• "DeleteDatabaseCubeFromUser Command" (p. 73)• "DeleteDatabaseSignon Command" (p. 74)

DeleteDatabaseSignon Command

SyntaxDeleteDatabaseSignon,DatabaseName,DatabaseSignonName


DescriptionRemoves a database signon from a namespace.

DiscussionUse this command to delete a database signon associated with a database. Deleting this object removes all references to this object in the namespace.


DatabaseName Required. Specifies the name of an existing database data source in the namespace.

Type: String


Type: String



Type: String


Chapter 5: Commands

ExampleThis example removes a database signon named Loc45 for the database named FinanceDB. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete the database signon.DeleteDatabaseSignon,"FinanceDB","Loc45"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteDatabase Command" (p. 71)• "DeleteDatabaseCube Command" (p. 72)• "DeleteDatabaseCubeFromUser Command" (p. 73)• "DeleteDatabaseSignonFromUser Command" (p. 75)

DeleteDatabaseSignonFromUser Command

SyntaxDeleteDatabaseSignonFromUser,DatabaseName,DatabaseSignonName,UserName


User Object

DescriptionRemoves a database signon association from a user.

DiscussionUse this command to delete a database signon associated with a user. Deleting this object removes the association of a User object to the DatabaseSignon object. The database signon is not deleted from the namespace.

DatabaseSignonName Required. Specifies the name of a database signon for a database in the namespace.

Type: String




Type: String

DatabaseSignonName Required. Specifies the name of a database signon for a database in the namespace.

Type: String


Type: String


Chapter 5: Commands

ExampleThis example removes a database signon named Loc45 for the database named FinanceDB from the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a database signon association from a user.DeleteDatabaseSignonFromUser,"FinanceDB","Loc45","Bill Gibbons"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteDatabase Command" (p. 71)• "DeleteDatabaseFromUser Command" (p. 73)• "DeleteDatabaseSignon Command" (p. 74)

DeleteFolder Command

SyntaxDeleteFolder,FolderType,FolderName,ParentFolderName


DescriptionDeletes a Folder object from a namespace.

DiscussionUse this command to delete a folder from the current namespace, when a folder is no longer required. When you delete a folder, you also delete all objects that it contains.

To add a folder to a namespace use the AddFolder command.

ExampleThis example deletes two folders, both called Sales Personnel but representing different types (UsersFolder type and DataSourceFolder type), from the current namespace. Then it deletes another folder called Managers. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete three folders from the current namespace.DeleteFolder,"UserFolder","Sales Personnel","Users" DeleteFolder,"DataSourceFolder","Sales Personnel","Data Sources" DeleteFolder,"DataSourceFolder","Managers","Sales Personnel"


FolderType Required. Specifies the type of a folder, either UserFolder or DataSourceFolder.

Type: String

FolderName Required. Specifies the name of a folder to delete it from a namespace.

Type: String

ParentFolderName Optional. Specifies the name of a main folder that contains one or more subfolders.

Type: String


Chapter 5: Commands

Related Topics• "AddFolder Command" (p. 45)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangeFolderName Command" (p. 63)• "Object Association Commands" (p. 33)

DeleteMetadataObject Command

SyntaxDeleteMetadataObject,MetadataObjectName


DescriptionDeletes a Metadata object from the current namespace.

DiscussionUse this command to delete a Metadata object from a namespace when the object is no longer required or its type is no longer supported by Architect. When you delete this object, you also delete all references to it in the namespace. The metadata source is not deleted from the namespace.

To add a Metadata object to a namespace, use the AddMetadataObject command.

ExampleThis example removes two Metadata objects, Company Model and Model 2000, from the namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a Metadata object from the namespace.DeleteMetadataObject,"Company Model" DeleteMetadataObject,"Model 2000"

Related Topics• "AddMetadataObject Command" (p. 46)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "SetMetadataObjectProperty Command" (p. 96)• "SetMetadataObjectFolder Command" (p. 95)

DeleteNamespace Command

SyntaxDeleteNamespace,NamepaceName



MetadataObjectName Required. Specifies the name of an existing Metadata object to delete from the namespace.

Type: String


Chapter 5: Commands

DescriptionRemoves a namespace from a directory server.

DiscussionWhen you delete a current namespace, you remove all signon information for users, the user classes to which each user belongs, information about data sources, and information about application servers from the directory server.

ExampleThis example deletes the Regions and Sales Representatives namespaces from the directory server. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Log on to the namespace.LogonNamespace,"Regions","administrator",""LogonNamespace,"Sales Representatives","administrator",""//Delete two namespaces.DeleteNamespace,"Regions" DeleteNamespace,"Sales Representatives"

Related Topics• "AddNamespace Command" (p. 48)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "SetNamespaceProperty Command" (p. 97)

DeletePowerPlayServer Command

SyntaxDeletePowerPlayServer,PowerPlayServerName


DescriptionRemoves a PowerPlay server from the namespace.

DiscussionUse this command to remove all references to PowerPlay server in the namespace.

ExampleThis example removes a PowerPlay server named PPServer1 from the namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.


NamespaceName Required. Specifies the name of the namespace to delete, for example, Sales Regions.

Type: String


PowerPlayServerName Required. Specifies the name of a PowerPlay server in the namespace.

Type: String


Chapter 5: Commands

//Delete a PowerPlay server.DeletePowerPlayServer,"PPServer1"

Related Topics• "AddPowerPlayServer Command" (p. 49)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangePowerPlayServerName Command" (p. 64)• "SetPowerPlayServerProperty Command" (p. 99)

DeleteTransformerServer Command

SyntaxDeleteTransformerServer,TransformerServerName


DescriptionRemoves a Transformer server from a namespace.

DiscussionUse this command to remove all references to Transformer server in the namespace.

ExampleThis example removes a Transformer server named TransServer1 from the current namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a Transformer server.DeleteTransformerServer,"TransServer1"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "Commands" (p. 35)• "DeleteTransformerServerFromUser Command" (p. 79)• "DeleteTransformerServerSignon Command" (p. 80)

DeleteTransformerServerFromUser Command

SyntaxDeleteTransformerServerFromUser,TransformerServerName,UserName


User Object



Type: String


Chapter 5: Commands

DescriptionRemoves a Transformer server from a user.

DiscussionUse this command to remove a Transformer server association from a user. Deleting this object for a user only removes the Transformer server reference to this object. The Transformer server is not deleted.

ExampleThis example removes a Transformer server named TransServer1 from the user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a Transformer server from a user.DeleteTransformerServerFromUser,"TransServer1","Bill Gibbons"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeletePowerPlayServer Command" (p. 78)• "DeleteTransformerServerSignon Command" (p. 80)• "DeleteTransformerServerSignonFromUser Command" (p. 81)

DeleteTransformerServerSignon Command

SyntaxDeleteTransformerServerSignon,TransformerServerName,TransformerServerSignonName


DescriptionRemoves a Transformer server signon from a Transformer server.

DiscussionUse this command to delete a Transformer server signon. Deleting this object removes all references to this object in the namespace.



Type: String


Type: String



Type: String


Chapter 5: Commands

ExampleThis example removes a Transformer server signon named Trans1234 for the Transformer server named Trans1. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a Transformer server signon.DeleteTransformerServerSignon,"Trans1","Trans1234"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteTransformerServer Command" (p. 79)• "DeleteTransformerServerFromUser Command" (p. 79)• "DeleteTransformerServerSignonFromUser Command" (p. 81)


SyntaxDeleteTransformerServerSignonFromUser,TransformerServerName,TransformerServerSignonName,UserName


User Object

DescriptionRemoves a Transformer server signon from a user.

DiscussionUse this command to delete a Transformer server signon for a user. Deleting this object from a user only removes the Transformer server signon reference from the User object.

TransformerServerSignonName Required. Specifies the name of a Transformer server signon to remove from the Transformer server.

Type: String




Type: String

TransformerServerSignonName Required. Specifies the name of a Transformer server signon to remove from the Transformer server.

Type: String


Type: String


Chapter 5: Commands

ExampleThis example removes a Transformer server signon named Trans1234 from the user Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a Transformer server signon for a user.DeleteTransformerServerSignonFromUser,"Trans1","Trans1234","Bill Gibbons"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteTransformerServer Command" (p. 79)• "DeleteTransformerServerFromUser Command" (p. 79)• "DeleteTransformerServerSignon Command" (p. 80)

DeleteUser Command

SyntaxDeleteUser,UserName


DescriptionRemoves a user from the namespace.

DiscussionUse this command to delete a user and any of its references from a namespace. Deleting a user removes this user from all user classes, and removes all associations with this user.

ExampleThis example removes a user named Bill Gibbons from the current namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a user.DeleteUser,"Gibbons, Bill"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteUserBasicSignon Command" (p. 82)• "DeleteUserClass Command" (p. 83)• "DeleteUserFromUserClass Command" (p. 84)• "DeleteUserOSSignon Command" (p. 85)

DeleteUserBasicSignon Command

SyntaxDeleteUserBasicSignon,UserName,BasicSignonName



Type: String


Chapter 5: Commands


DescriptionRemoves a basic signon from a user and deletes the signon from the namespace.

DiscussionUse this command to delete a basic signon from the namespace. Deleting the signon removes all references to this object.

ExampleThis example removes a basic signon for a user. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a basic signon for a user.DeleteUserBasicSignon,"Bill Gibbons","gibbonsb"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteUser Command" (p. 82)• "DeleteUserClass Command" (p. 83)• "DeleteUserOSSignon Command" (p. 85)

DeleteUserClass Command

SyntaxDeleteUserClass,UserClassName


DescriptionRemoves a user class from a namespace.

DiscussionWhen you remove a user class, you remove any children user classes and associations with the user class. Users that have been assigned to the user classes will not be deleted from the namespace.


BasicSignonName Required. Specifies the name of a basic signon.

Type: String

UserName Required. Specifies the name of a user.

Type: String


UserClassName Required. Specifies the name of the user class to remove from the namespace. Do not include quotation marks with the name.

Type: String


Chapter 5: Commands

ExampleThis example removes the Eastern Sales Representatives and European Sales Representatives user classes from the current namespace. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete two user classes.DeleteUserClass,"Eastern Sales Representatives" DeleteUserClass,"European Sales Representatives"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteUser Command" (p. 82)• "DeleteUserFromUserClass Command" (p. 84)

DeleteUserFromUserClass Command

SyntaxDeleteUserFromUserClass,UserName,UserClassName


UserClass Object

DescriptionRemoves a user class association from a user.

DiscussionUse this command to delete a user from a user class. Deleting a user from a user class removes only the user from that user class. If the user is a member of other user classes, the user will remain a member of the other user classes.

A user can exist in the namespace without belonging to a user class.

ExampleThis example removes a user named Bill Gibbons from the user class named Managers. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete a user from a user class.DeleteUserFromUserClass,"Gibbons, Bill","Managers"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteUser Command" (p. 82)• "DeleteUserBasicSignon Command" (p. 82)



Type: String

UserClassName Required. Specifies the name of a user class to which the user is a member.

Type: String


Chapter 5: Commands

• "DeleteUserClass Command" (p. 83)• "DeleteUserOSSignon Command" (p. 85)

DeleteUserOSSignon Command

SyntaxDeleteUserOSSignon,UserName,OSSignonName


DescriptionRemoves an OS signon from a user and deletes the signon from the namespace.

DiscussionUse this command to delete an OS signon.

ExampleThis example removes an OS signon for a user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Delete an OS signon for a user.DeleteUserOSSignon,"Gibbons, Bill","gibbonsb"

Related Topics• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "DeleteUser Command" (p. 82)• "DeleteUserBasicSignon Command" (p. 82)• "DeleteUserClass Command" (p. 83)• "DeleteUserFromUserClass Command" (p. 84)

LinkUser Command

SyntaxLinkUser,ExternalUserDN


DescriptionLinks an external user to an Access Manager namespace.


OSSignonName Required. Specifies the name of an OS signon.

Type: String

UserName Required. Specifies the name of a user.

Type: String


Chapter 5: Commands

DiscussionUse this command instead of the AddUser (p. 54) command when external user support is enabled for your namespace. This command creates a user, adds the user to the Access Manager namespace, and links the user to an external user specified by the ExternalUserDN parameter.

The user's name is set to the external user name. If the external user name already exists in the namespace, an error message is returned.

For information about configuring Access Manager for external user support, see the Configuration Manager User Guide.

For information about enabling external user support, see the Access Manager Administrator Guide.

ExampleThis example links external users in the Sales namespace to the external user DN "uid=scarter, ou=people, dc=company,dc=com". Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Log on to the Sales namespace.LogonNamespace,"Sales","ActiveSignon","Basic"//Link an external user to the external user DN "ou=People, dc=company,dc=com".LinkUser, "uid=scarter, ou=people, dc=company, dc=com"

Related Topics• "RelinkUser Command" (p. 88)• "AddUser Command" (p. 54)

LogonNamespace Command

SyntaxLogonNamespace,NamespaceName,SignonName,Password


DescriptionLogs on to an existing namespace.

DiscussionUse this command when you want to access a namespace. You do not need to log off the current namespace when you want to log on to another namespace in the same all object input file. Access Manager Batch Maintenance tool automatically logs you on to the specified namespace. The namespace must exist in the directory server before you can log on. If the namespace does not exist, use the AddNamespace command to add a new namespace.

You do not have to include the LogonNamespace command as the first command in an all objects input file.

The administrator must assign you access permissions for an existing namespace before you can log on to that namespace, and you must have a valid signon name and password. The ActiveSignon property from the SetNamespaceProperty command determines the type of signon required, such as an OS signon or a basic signon.


ExternalUserDN Required. Specifies the external user distinguished name (DN) to which the new user object is linked.

Type: String


Chapter 5: Commands

This command overrides the previous setting in the Access Manager Batch Maintenance graphical user interface so that you can log on to different namespaces in a single script.

ExampleThis example sets the active signon type to basic signon, logs off the Regions namespace, logs on to the Sales namespace, and then sets the signon type to basic signon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set the active signon type to basic.SetNamespaceProperty,"Regions","ActiveSignon","Basic"//Log off the Regions namespace.LogoffNamespace,"Regions"//Log on to the Sales namespace.LogonNamespace,"Sales","administrator","admin" //Set the active signon type to basic.SetNamespaceProperty,"Sales","ActiveSignon","Basic"

Related Topics• "AddNamespace Command" (p. 48)• "Commands" (p. 35)• "DeleteNamespace Command" (p. 77)• "LogoffNamespace Command" (p. 87)• "SetNamespaceProperty Command" (p. 97)

LogoffNamespace Command

SyntaxLogoffNamespace,NamespaceName


DescriptionLogs off a namespace.


NamespaceName Required. Specifies the name for the namespace, for example, Sales Regions. This name is unique within a directory server.

Type: String

SignonName Required. Specifies the signon name for the namespace. The default signon name is the basic signon name Administrator. This name must be unique within a directory server. The signon name properties for an existing namespace are those previously defined by the SetNamespaceProperty command.

Type: String

Password Optional. Specifies the password associated with the signon name. The default password for a basic signon for a new namespace is Admin. The password properties for an existing namespace are those previously defined by the SetNamespaceProperty command.

Type: String


Chapter 5: Commands

DiscussionUse this command when you want to close the current namespace in an All Objects input file. This command overrides the previous setting in the Access Manager Batch Maintenance. You do not have to use this command when you want to log off the current namespace and log on to another namespace. You do not have to include the LogoffNamespace command as the last command in an All objects input file. The Access Manager Batch Maintenance tool automatically logs off the namespace after it runs the last command in the input file. After you log off the current namespace, use the LogonNamespace command to log on to another namespace.

ExampleThis example sets the active signon type to basic signon, logs off the Regions namespace, logs on to the Sales namespace, and then sets the signon type to basic signon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set the active signon type to basic.SetNamespaceProperty,"Regions","ActiveSignon","Basic"//log off the Regions namespace.LogoffNamespace,"Regions" //Log on to the Sales namespace.LogonNamespace,"Sales","Administrator","SalesAdmin"//Set the active signon type to basic.SetNamespaceProperty,"Sales","ActiveSignon","Basic"

Related Topics• "AddNamespace Command" (p. 48)• "Commands" (p. 35)• "DeleteNamespace Command" (p. 77)• "LogonNamespace Command" (p. 86)• "SetNamespaceProperty Command" (p. 97)

RelinkUser Command

SyntaxRelinkUser,UserName,ExternalUserDN


DescriptionModifies the external user distinguished name (DN) reference for an existing external user.

DiscussionUse this command to update the distinguished name (DN) references for external users already linked to an Access Manager namespace. For example, when the link is invalid. The user’s link to an external user is changed to the external user specified by the ExternalUserDN parameter. The name of the user is not changed.

For information about configuring Access Manager for external user support, see the Configuration Manager User Guide.


NamespaceName Optional. Specifies the name for the namespace, for example, Sales Regions. This name is unique within a directory server.

Type: String


Chapter 5: Commands

For information about enabling external user support, see the Access Manager Administrator Guide.

ExampleThis example updates the external user DN reference for a user named Sam Carter. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Log on to the Sales namespace.LogonNamespace,"Sales","ActiveSignon","Basic"//Link the user Sam Carter to the external user DN //"uid=scarter, ou=people, dc=company, dc=com".RelinkUser,"uid=scarter, ou=people, dc=company, dc=com"

Related Topics• "LinkUser Command" (p. 85)

RemoveMetadataObjectFromUser Command

SyntaxRemoveMetadataObjectFromUser,MetadataObjectName,UserName


User Object

DescriptionRemoves a Metadata object association from a user.

DiscussionUse this command to delete a Metadata object as a data source from a user, when it is no longer required. When you delete this object, you delete only the Metadata object reference to the User object. The Metadata object is not deleted from the namespace.

To add a Metadata object to a user, use the AddMetadataObjectToUser command.

ExampleThis example deletes a Metadata object, Company Model, from two users, Bill Gibbons and Dave Mustaine. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.


UserName Required. Specifies the external user’s name.

Type: String

ExternalUserDN Required. Specifies the external user distinguished name (DN) to which the user object is linked.

Type: String


MetadataObjectName Required. Specifies the name of an existing Metadata object.

Type: String


Type: String


Chapter 5: Commands

//Remove a Metadata object from a user.RemoveMetadataObjectFromUser,"Company Model","Gibbons, Bill" RemoveMetadataObjectFromUser,"Company Model","Mustaine, Dave"

Related Topics• "All Objects Input File" (p. 9)• "DeleteMetadataObject Command" (p. 77)• "Object Association Commands" (p. 33)• "SetMetadataObjectProperty Command" (p. 96)

SetCubeFolder Command

SyntaxSetCubeFolder,CubeName,FolderName


Folder Object

DescriptionSets a folder for a Cube object.

DiscussionUse this command to organize Cube objects into named folders. When you create Cube objects, Access Manager puts them into a root data source folder. Use this command to move a local cube data source from the root folder into a specified DataSourceFolder. You can also use this command to relocate a local cube from one DataSourceFolder to another. A folder must exist in the namespace before you can move a Cube object into it.

ExampleThis example sets a folder called Sales for a Cube object called Sales98. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a cube folder.SetCubeFolder,"Sales98","Sales"

Related Topics• "AddFolder Command" (p. 45)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)


CubeName Required. Specifies the name of a Cube object in the namespace.

Type: String

FolderName Required. Specifies the name of a folder for a Cube object. It must be a DataSourceFolder.

Type: String


Chapter 5: Commands

SetCubeProperty Command

SyntaxSetCubeProperty,CubeName,CubeProperty,NewSetting


DescriptionSets a property for a local cube.

DiscussionUse this command when you want to change the description for a local cube data source. The Cube object must exist in the namespace before you can change the description.

ExampleThis example sets the Description property for a local cube. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a new description for a cube.SetCubeProperty,"Sales98","Description","Sales for all regions."

Related Topics• "AddCube Command" (p. 38)• "AddCubeToUser Command" (p. 39)• "ChangeCubeName Command" (p. 59)• "DeleteCube Command" (p. 70)• "DeleteCubeFromUser Command" (p. 70)• "SetDatabaseCubeProperty Command" (p. 91)

SetDatabaseCubeProperty Command

SyntaxSetDatabaseCubeProperty,DatabaseName,DatabaseCubeName,DatabaseCubeProperty,NewSetting



CubeName Required. Specifies the name of a local cube in the namespace.

Type: String

CubeProperty Required. Specifies the property to change. The cube property settings are

Description

Type: String

NewSetting Required. Specifies the new value for the cube property specified. See the CubeProperty parameter for the values associated with a property.

Type: String


Chapter 5: Commands

DescriptionSets a property for a cube in a database.

DiscussionUse this command when you want to change the description or connection string for a database cube. The database cube must exist in the namespace before you can set any properties.

ExampleThis example sets a new connection string and description for a cube within a database. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a new connection string and description.SetDatabaseCubeProperty,"Finance","FinanceCube98","ConnectionString","Finance@FinanceCube98" SetDatabaseCubeProperty,"Finance","FinanceCube98","Description","For all regions."

Related Topics• "AddDatabaseCube Command" (p. 40)• "AddDatabaseCubeToUser Command" (p. 41)• "ChangeDatabaseCubeName Command" (p. 61)• "DeleteDatabaseCube Command" (p. 72)• "DeleteDatabaseCubeFromUser Command" (p. 73)

SetDatabaseFolder Command

SyntaxSetDatabaseFolder,DatabaseName,FolderName


Folder Object

DescriptionSets a folder for a Database object.


DatabaseCubeName Required. Specifies the name of the database cube.

Type: String

DatabaseCubeProperty Required. Specifies the property to change. The database cube properties are

Description ConnectionString

DatabaseName Required. Specifies the name of the database containing the cube.

Type: String

NewSetting Required. Specifies the new value for the database cube property specified. See the DatabaseCubeProperty parameter for the values associated with a property.


Chapter 5: Commands

DiscussionUse this command to organize Database objects into named folders. When you create Database objects, Access Manager puts them into a root data source folder. Use this command to move a database data source from the root folder into a specified DataSourceFolder. You can also use this command to relocate a Database object from one DataSourceFolder to another. A folder must exist in the namespace before you can move a Database object into it.

ExampleThis example sets a folder called Finance for a Database object called FinanceDB. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a database folder.SetDatabaseFolder,"FinanceDB","Finance"

Related Topics• "AddFolder Command" (p. 45)• "Commands" (p. 35)• "All Objects Input File" (p. 9)• "ChangeFolderName Command" (p. 63)• "DeleteFolder Command" (p. 76)• "Object Association Commands" (p. 33)

SetDatabaseProperty Command

SyntaxSetDatabaseProperty,DatabaseName,DatabaseProperty,NewSetting


DescriptionSets a property for a database.

DiscussionUse this command when you want to change the description or connection string for a database. The database must exist in the namespace before you can set any properties.



Type: String

FolderName Required. Specifies the name of a folder for a Database object. It must be a DataSourceFolder.

Type: String



Type: String


Chapter 5: Commands

ExampleThis example sets description, connection string, and RequiresSignon properties for the database called FinanceDB. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a description, connection string, and RequiresSignon properties .SetDatabaseProperty,"FinanceDB","ConnectionString","OutWard/Spine@LocQuest" SetDatabaseProperty,"FinanceDB","Description","Finance for regions."

Related Topics• "AddDatabase Command" (p. 39)• "ChangeDatabaseName Command" (p. 60)• "ChangeDatabaseSignonName Command" (p. 62)• "DeleteDatabase Command" (p. 71)

SetDatabaseSignonProperty Command

SyntaxSetDatabaseSignonProperty,DatabaseName,DatabaseSignonName,DatabaseSignonProperty,SetDatabaseSignonProperty,DatabaseName,SyntaxDatabaseSignonName,DatabaseSignonPropertyNewSetting


DescriptionSets a property for a database signon.

DiscussionUse this command when you want to change the description or the password for a database signon. The database signon must exist in the namespace before you can set any properties.

DatabaseProperty Required. Specifies the property to change. The database properties are

Description ConnectionString RequiresSignon

NewSetting Required. Specifies the new value for the database property specified. See the DatabaseProperty parameter for the values associated with a property.




Type: String

DatabaseSignonName Required. Specifies the signon name associated with a Database object.

Type: String


Chapter 5: Commands

ExampleThis example sets a new description and password for a database signon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a description and password.SetDatabaseSignonProperty,"FinanceDB","SignonA","Description","Finance for regions." SetDatabaseSignonProperty,"FinanceDB","SignonA","Password", "Finance"

Related Topics• "AddDatabaseSignon Command" (p. 42)• "AddDatabaseToUser Command" (p. 44)• "AddDatabaseSignonToUser Command" (p. 43)• "ChangeDatabaseSignonName Command" (p. 62)• "DeleteDatabaseSignon Command" (p. 74)• "DeleteDatabaseSignonFromUser Command" (p. 75)

SetMetadataObjectFolder Command

SyntaxSetMetadataObjectFolder,MetadataObjectName,FolderName


MetadataObject Object

DescriptionSets a folder for a Metadata object.

DiscussionUse this command to organize Metadata objects into named folders. When you create Metadata objects, Access Manager puts them into a root data source folder. Use this command to move a Metadata object from the root folder into a specified DataSourceFolder. You can also use this command to relocate a Metadata object from one DataSourceFolder to another. A folder must exist in the namespace before you can move a Metadata object into it.

DatabaseSignonProperty Required. Specifies the property to change. The database signon properties are

Description Password

Type: String

NewSetting Required. Specifies the new value for the database signon property specified. See the DatabaseSignonProperty parameter for the values associated with a property.



MetadataObjectName Required. Specifies the name for a Metadata object.

Type: String


Chapter 5: Commands

ExampleThis example sets a folder, Metadata Sources, for a Metadata object called Company Model. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a Metadata object folder.SetMetadataObjectFolder,"Company Model","Metadata Sources"

Related Topics• "AddMetadataObject Command" (p. 46)• "All Objects Input File" (p. 9)• "Object Association Commands" (p. 33)

SetMetadataObjectProperty Command

SyntaxSetMetadataObjectProperty,MetadataObjectName,MetadataObjectProperty,NewSetting


DescriptionSets the properties for a Metadata Object.

DiscussionUse this command to change the property settings for a Metadata object. A Metadata object must exist in the namespace before you can set its properties. Each type of Metadata object has a different set of properties that apply to it.

For a list of valid Metadata types, see the MetadataObject object.

ExampleThis example adds a Metadata object, Company Model, and sets its description. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Add a Metadata object to the current namespace.

FolderName Required. Specifies the name of a folder for a Metadata object. It must be a DataSourceFolder.

Type: String



MetadataObjectName Required. Specifies the name of a Metadata object.

Type: String

MetadataObjectProperty Required. Specifies the Metadata object property to set or change. The property is

Description

Type: String

NewSetting Required. Specifies the new property setting for the Metadata object.

Type: String


Chapter 5: Commands

AddMetadataObject,"Company Model","Architect Model"//Set a desription.SetMetadataObjectProperty,"Company Model","Description", "This is a description"

Related Topics• "AddMetadataObject Command" (p. 46)• "All Objects Input File" (p. 9)• "ChangeMetadataObjectName Command" (p. 63)• "Object Association Commands" (p. 33)

SetNamespaceProperty Command

SyntaxSetNamespaceProperty,NamespaceName,NamespaceProperty,NewSetting


DescriptionSets the properties for a specified namespace.

DiscussionUse this method to change the property settings for a namespace, such as the type of signon, the length of passwords, and password expiry dates.

You can set the minimum number of characters for the password and user ID for each namespace. You can also specify whether the password and user ID are case sensitive. If the correct capitalization is not used, an object will not be found.

You can choose the type of signons that you assign to users in a namespace. Use a basic signon if you want the users to be prompted to provide a user name and password for each secure object they access. Use an operating system (OS) signon if you want the user to log on to the secure object by using their operating system or network logon information (user name and password). Use both types of signons for users to be prompted for a basic signon when AccessManager does not recognize the OS signon.

Notes• You can only set properties for a namespace that you are authorized to administer.• The namespace must exist before you can set the properties.


NamespaceName Optional. Specifies the name for the namespace, for example, Regions. If you do not specify a namespace name, Access Manager Batch Maintenance uses the current namespace.

Type: String


Chapter 5: Commands

ExampleThis example sets various properties for the current namespace Regions. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set the signon type to basic.SetNamespaceProperty,"Regions","ActiveSignon","Basic"//Set the AnonymousUser access. SetNamespaceProperty,"Regions","AuthenticateAs","AnonymousUser","Gibbons, Bill"//Set the GuestUser access. SetNamespaceProperty,"Regions","AuthenticateAs","GuestUser","Mustaine, Dave"//Set the normal access. SetNamespaceProperty,"Regions","AuthenticateAs","None"//Set the first name of the author. SetNamespaceProperty,"Regions","AuthorFirstName","Bill"//Set the last name of the author.SetNamespaceProperty,"Regions","AuthorLastName","Gibbons"//Set the DaylightSavingsTimeInEffect.SetNamespaceProperty,"Regions","DaylightSavingsTimeInEffect","No"//Add a description for the namespace.SetNamespaceProperty,"Regions","Description","All sales regions."//Set the ExpiredPasswordWarningPeriod to 6 days.SetNamespaceProperty,"Regions","ExpiredPasswordWarningPeriod","6"//Set the language.SetNamespaceProperty,"Regions","Language","English"//Set the locale type.SetNamespaceProperty,"Regions","Locale","fr-fr"//Specify a lockout duration time period of 20 minutes.

NamespaceProperty Required. Specifies the name of the property to set. The namespace property settings are

ActiveSignon AuthenticateAs AuthorFirstName AuthorLastNameDaylightSavingsTimeInEffectDescriptionExpiredPasswordWarningPeriod ExternalIdentityMappingKeywords Language Locale LockoutDurationMaxInvalidAttempts PasswordCaseSensitivity PasswordExpiry PasswordMinLength PublicUserClass SignonCaseSensitivity SignonMinLength Subject TimeFormat TimeZone Title

Type: String

NewSetting Required. Specifies the new setting for the namespace property. Refer to the NamespaceProperty parameter for the values associated with a property.



Chapter 5: Commands

SetNamespaceProperty,"Regions","LockoutDuration","20"//Set an unlimited number of log on attempts.SetNamespaceProperty,"Regions","MaxInvalidAttempts","-1"//Set variable for Web signosSetNamespaceProperty, "Regions", "ExtIdentityMapping", "${environment("REMOTE_USER")}"//Set password case sensitivity.SetNamespaceProperty,"Regions","PasswordCaseSensitivity","Yes"//Set the minimum password length to 6 characters.SetNamespaceProperty,"Regions","PasswordMinLength","6"//Set the password expiry to 3 months.SetNamespaceProperty,"Regions","PasswordExpiry","3 months"//Set the public user class.SetNamespaceProperty,"Regions","PublicUserClass","AllUsers"//Set the minimum signon length to 8 characters.SetNamespaceProperty,"Regions","SignonMinLength","8"//Set signon case sensitivity to No.SetNamespaceProperty,"Regions","SignonCaseSensitivity","No"//Set the time format to the 12-hour clock.SetNamespaceProperty,"Regions","TimeFormat","hh:mm:ss"//Set the time zone type. SetNamespaceProperty,"Regions","TimeZone","NorthAmericaEastern"

Related Topics• "AddNamespace Command" (p. 48)• "All Objects Input File" (p. 9)• "DeleteNamespace Command" (p. 77)• "Commands" (p. 35)• "LogonNamespace Command" (p. 86)• "LogoffNamespace Command" (p. 87)

SetPowerPlayServerProperty Command

SyntaxSetPowerPlayServerProperty,PowerPlayServerName,PowerPlayServerProperty,NewSetting


DescriptionSets a property for a PowerPlay server.

DiscussionUse this command when you want to change the description, port number, or timeout value of a PowerPlay server. The PowerPlay server must exist in the namespace before you can set any properties.

You must specify this command for every property you want to change.


PowerPlayServerName Required. Specifies the name of a PowerPlay server in the namespace.

Type: String


Chapter 5: Commands

ExampleThis example sets a new description, port, and timeout value for a PowerPlay server. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a new description, port, and timeout value.SetPowerPlayServerProperty,"Outdoors","Description","Regional Finance." SetPowerPlayServerProperty,"Outdoors","Port","5000" SetPowerPlayServerProperty,"Outdoors","Timeout","30"

Related Topics• "AddPowerPlayServer Command" (p. 49)• "All Objects Input File" (p. 9)• "ChangePowerPlayServerName Command" (p. 64)• "Commands" (p. 35)• "DeletePowerPlayServer Command" (p. 78)

SetTransformerServerProperty Command

SyntaxSetTransformerServerProperty,TransformerServerName,TransformerServerProperty,NewSetting


DescriptionSets a property for a Transformer server.

DiscussionUse this command when you want to change the description for a Transformer server. The Transformer server must exist in the namespace before you can set any properties.

PowerPlayServerProperty Required. Specifies the property to change. The PowerPlay server properties are

Description Port Timeout

Type: String

NewSetting Required. Specifies the new value for the PowerPlay server property specified. See the PowerPlayServerProperty parameter for the values associated with a property.




Type: String

TransformerServerProperty Required. Specifies the property to change. The Transformer server properties are

Description

Type: String


Chapter 5: Commands

ExampleThis example sets a new description for a Transformer server. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a new description.SetTransformerServerProperty,"WestPro","Description","Test server."

Related Topics• "AddTransformerServer Command" (p. 50)• "AddTransformerServerSignon Command" (p. 52)• "AddTransformerServerSignonToUser Command" (p. 53)• "AddTransformerServerToUser Command" (p. 51)• "ChangeTransformerServerName Command" (p. 65)• "ChangeTransformerServerSignonName Command" (p. 66)

SetTransformerServerSignonProperty Command

SyntaxSetTransformerServerSignonProperty,TransformerServerName,TransformerServerSignon,TransformerServerProperty,NewSetting


DescriptionSets a Transformer server signon property.

DiscussionUse this command when you want to change the description or password for a Transformer server signon. The TransformerServer and the signon object must exist in the namespace before you can set any properties.

NewSetting Required. Specifies the new value for the Transformer server property specified. See the TransformerServerProperty parameter for the values associated with a property.



NewSetting Required. Specifies the new value for the property. See the Property parameter for the names of properties that you can set.

TransformerServerName Required. Specifies the name of the Transformer server in the namespace.

Type: String

TransformerServerProperty Required. Specifies the name of the property to change. The properties are

Description Password

Type: String


Chapter 5: Commands

ExampleThis example sets a new description and password for a Transformer server signon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a new description and password.SetTransformerServerSignonProperty,"WestProH","SigA", "Description","Test" SetTransformerServerSignonProperty,"WestProH","SigA","Password", "Outward"

Related Topics• "AddTransformerServerSignon Command" (p. 52)• "AddTransformerServerSignonToUser Command" (p. 53)• "ChangeTransformerServerName Command" (p. 65)• "ChangeTransformerServerSignonName Command" (p. 66)• "DeleteTransformerServer Command" (p. 79)• "DeleteTransformerServerFromUser Command" (p. 79)

SetUserBasicSignonProperty Command

SyntaxSetUserBasicSignonProperty,UserName,BasicSignonName,Property,NewSetting


DescriptionSets a property for a basic signon for a user.

DiscussionUse this command when you want to change the description or password for basic signon associated with a user. The User and BasicSignon object must exist in the namespace before you can set any properties.

TransformerServerSignonName Required. Specifies the name of the signon associated with the Transformer server.

Type: String




Type: String

BasicSignonName Required. Specifies the name of a basic signon associated with a user in the namespace.

Type: String


Chapter 5: Commands

ExampleThis example sets a new description and password for a user's basic signon, and then prompts the user to change the password at next logon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set a new description and password.SetUserBasicSignonProperty,"Gibbons, Bill","Outdoors", "Description","Manager" SetUserBasicSignonProperty,"Gibbons, Bill","Outdoors", "Password","LocOutdr" SetUserBasicSignonProperty,"Gibbons, Bill","Outdoors","ChangePasswordAtNextLogon","yes"

Related Topics• "AddUserBasicSignon Command" (p. 55)• "ChangeUserBasicSignonName Command" (p. 67)• "DeleteUserBasicSignon Command" (p. 82)

SetUserClassProperty Command

SyntaxSetUserClassProperty,UserClassName,UserClassProperty,NewSetting


DescriptionSets properties for a user class.

DiscussionUse this command to set user class properties, such as time restrictions and privileges.

Use the DayRestriction and HourRestriction properties to grant or deny access for specific days and time periods. This means that members of a user class will only be granted access to a secure object during the time specified for that user class.

The time restriction is only applied when the user first accesses the secure object. A time restriction hour range is from 00:00 to 24:00.

User class administrative privileges specify the kinds of activities members of that user class will have within Access Manager. For example, depending on the rights that are selected, members of a user class can create or delete users and user classes or they can only have privileges to view users and user classes. If you have created a secondary user class within a primary user class, the privileges for the secondary user class are limited by the privileges that you have enabled for the primary user class. Privileges that you have not enabled for the primary user class will not be available for the secondary user class.

Property Required. Specifies the name of the property to change. The properties are

DescriptionChangePasswordAtNextLogon Password

Type: String




Chapter 5: Commands

The privileges specified in Access Manager do not determine the access privileges a member of the user class will have within a client application. Those privileges are defined in the client application. For example, privileges within Access Manager determine whether that user, as a member of a user class, can create or delete users and user classes. They do not specify whether that user can view a specific dimension while viewing a cube in PowerPlay. Specific privileges for viewing a cube must be specified in Transformer when the cube is created.

ExampleThis example sets various user class properties. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set the data source privileges.SetUserClassProperty,"Sales Representatives","DataSourcePrivileges","Create|Show" //Set the day restrictions for the user class.SetUserClassProperty,"Sales Representatives","DayRestriction","Monday|Tuesday|Wednesday|Friday" //Set the description for the user class.SetUserClassProperty,"Sales Representatives","Description","Sales people" //Set hour restrictions for the user class.SetUserClassProperty,"Sales Representatives","HourRestriction","09:00|17:30" //Set PowerPlay server permissions.SetUserClassProperty,"Sales Representatives","PowerPlayServerPrivileges","Create|Delete" //Set Transformer server permissions.SetUserClassProperty,"Sales Representatives","TransformerServerPrivileges","None" //Set user class permissions.SetUserClassProperty,"Sales Representatives","UserClassPrivileges","Create|Delete|ShowAll" //Set user permissions.SetUserClassProperty,"Sales Representatives","UserPrivileges","ModifySelf"

Related Topics• "AddUserClass Command" (p. 56)• "AddUserToUserClass Command" (p. 58)• "ChangeUserClassName Command" (p. 68)• "DeleteUserClass Command" (p. 83)• "DeleteUserFromUserClass Command" (p. 84)


UserClassName Required. Specifies the name of the user class.

Type: String

UserClassProperty Required. Specifies the name of the property to set. Refer to the Property table below for property names. The properties are

DataSourcePrivileges DayRestriction Description HourRestriction PowerPlayServerPrivileges TransformerServerPrivileges UserClassPrivileges UserPrivileges

Type: String

NewSetting Required. Specifies the new setting for the user class property. See the UserClassProperty parameter for a list of properties.


Chapter 5: Commands

SetUserFolder Command

SyntaxSetUserFolder,UserName,FolderName


User Object

DescriptionSets a folder for a user.

DiscussionUse this command to organize users into named folders. When Access Manager creates users, it puts them into the root user folder. Use this command to move a user from the root folder to a specified UserFolder. You can also use this command to relocate a user from one UserFolder to another. A folder must exist before you can move a user into it.

ExampleThis example puts the user named Bill Gibbons into a folder called Sales Personnel and then moves him to another folder called Managers. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Sets a user's folder.SetUserFolder,"Gibbons, Bill","Sales Personnel" SetUserFolder,"Gibbons, Bill","Managers"

Related Topics• "AddUser Command" (p. 54)• "All Objects Input File" (p. 9)• "Commands" (p. 35)• "Object Association Commands" (p. 33)

SetUserOSSignonProperty Command

SyntaxSetUserOSSignonProperty,UserName,OSSignonName,Property,NewSetting


DescriptionSets a property for an OS signon for a user.


UserName Required. Specifies the name of an existing user in the namespace.

Type: String

FolderName Required. Specifies the name of a folder for a User object. This folder must be a UserFolder.

Type: String


Chapter 5: Commands

DiscussionUse this command to change the description for an OS signon associated with a user. The User and OS signon objects must exist in the namespace before you can set a new description.

ExampleThis example sets a new description for a user's OS signon. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Set an OS signon description.SetUserOSSignonProperty,"Gibbons, Bill","gibbonsb","Description", "Test signon"

Related Topics• "AddUserOSSignon Command" (p. 57)• "ChangeUserOSSignonName Command" (p. 69)• "DeleteUserOSSignon Command" (p. 85)

SetUserProperty Command

SyntaxSetUserProperty,UserName,UserProperty,NewSetting


DescriptionSets a property for a User object.

DiscussionUse this command to change the property settings for a User object. The User object must exist in the namespace before you can set a new property value.



Type: String

OSSignonName Required. Specifies the name of an OS signon associated with a user in the namespace.

Type: String

Property Required. Specifies the name of the property. For example, description.

Type: String


Type: String



Type: String


Chapter 5: Commands

ExampleThis example sets various properties for a user named Bill Gibbons. Note that the Access Manager Batch Maintenance tool automatically logs you on and off the namespace that you specify.//Disable the user’s account.SetUserProperty,"Gibbons, Bill","AccountIsDisabled","yes" //Set a permission for creating a personal NewsBox.SetUserProperty,"Gibbons, Bill","CreatePersonalNewsBox","yes" //Set the DaylightSavingsTimeInEffect property.SetUserProperty,"Gibbons, Bill","DaylightSavingsTimeInEffect","No" //Set a new description.SetUserProperty,"Gibbons, Bill","Description","The Sales VP for Europe" //Set an email address.SetUserProperty,"Gibbons, Bill","Email","[email protected]" //Set a first name.SetUserProperty,"Gibbons, Bill","FirstName","Bill" //Set a language.SetUserProperty,"Gibbons, Bill","Language","English" //Set a last name.SetUserProperty,"Gibbons, Bill","LastName","Gibbons" //Set a locale. SetUserProperty,"Gibbons, Bill","Locale","fr-fr" //Make the user’s password always valid. SetUserProperty,"Gibbons, Bill","PasswordNeverExpires","yes" //Set a new phone number.SetUserProperty,"Gibbons, Bill","PhoneNumber","825-4523" //Set a time format to 12-hour clock.SetUserProperty,"Gibbons, Bill","TimeFormat","hh:mm:ss" //Set a time zone type.SetUserProperty,"Gibbons, Bill","TimeZone","NorthAmericaEastern" //Let the user’s password automatically expire.SetUserProperty,"Gibbons, Bill","UserCanNotChangePassword","yes"

Related Topics• "AddUser Command" (p. 54)• "AddUserToUserClass Command" (p. 58)• "ChangeUserName Command" (p. 68)• "DeleteUser Command" (p. 82)• "DeleteUserFromUserClass Command" (p. 84)

UserProperty Required. Specifies the name of the property to change. The properties are

AccountIsDisabled CreatePersonalNewsBox DaylightSavingsTimeInEffect Description Email FirstName Language LastName LocalePasswordNeverExpiresPhoneNumberTimeFormat TimeZone UserCanNotChangePassword

Type: String




Chapter 5: Commands


Chapter 6: Properties

Command Property

SetCubeProperty Description

SetDatabaseCubeProperty Description ConnectionString

SetDatabaseProperty Description ConnectionString RequiresSignon

SetDatabaseSignonProperty Description Password

SetMetadataObjectProperty Description

SetNamespaceProperty ActiveSignon AuthenticateAs AuthorFirstName AuthorLastNameDaylightSavingsTimeInEffectDescriptionExpiredPasswordWarningPeriodExternalIdentifyMapping Keywords Language Locale LockoutDurationMaxInvalidAttempts PasswordCaseSensitivity PasswordExpiry PasswordMinLength PublicUserClass SignonCaseSensitivity SignonMinLength Subject TimeFormat TimeZone Title

SetPowerPlayServerProperty Description Port Timeout

SetTransformerServerProperty Description

SetTransformerServerSignonProperty Description Password

SetUserBasicSignonProperty DescriptionChangePasswordAtNextLogon Password




AccountIsDisabled Property (SetUserProperty Command)

ActiveSignon Property (SetNamespaceProperty Command)

SetUserClassProperty DataSourcePrivileges DayRestriction Description HourRestriction PowerPlayServerPrivileges TransformerServerPrivileges UserClassPrivileges UserPrivileges

SetUserOSSignonProperty Description

SetUserProperty AccountIsDisabled CreatePersonalNewsBox DaylightSavingsTimeInEffect Description Email FirstName Language LastName LocalePasswordNeverExpiresPhoneNumberTimeFormat TimeZone UserCanNotChangePassword

Command Property

Property Description

AccountIsDisabled Optional. Specifies whether a user’s account is disabled until specified otherwise. The settings are "Yes" or "No". When you set this property to "Yes", the user can not access secured resources by any type of authentication (basic signon, OS signon, guest and anonymous access, Web browser access).

Default: No

Type: String


ActiveSignon Optional. Specifies the type of signon used for the namespace. The signon types are

Basic = a basic signon (default setting)

OS = an Operating System signon

Both = a basic and an Operating System signon

None = no signon

Type: String



AuthenticateAs Property (SetNamespaceProperty Command)

AuthorFirstName Property (SetNamespaceProperty Command)

AuthorLastName Property (SetNamespaceProperty Command)

ChangePasswordAtNextLogon (SetUserBasicSignonProperty Command)


AuthenticateAs Optional. Specifies how Access Manager identifies a user in Web based products. Access Manager sets another type of access other than the existing basic signon. The alternate user accounts are

AnonymousUser= sets AnonymousUser access

GuestUser access = sets GuestUser access

None = sets regular access with the use of basic signon

Only one of these accounts can be used at any given time.

Type: String


AuthorFirstName Optional. Specifies the first name of the person that created the namespace, for example, Administrator or Bill.

Type: String


AuthorLastName Optional. Specifies the last name of the person that created the namespace, for example, Gibbons.

Type: String


ChangePasswordAtNextLogon Optional. Specifies whether users must change password for a basic signon the next time they log on. The settings are "Yes" or "No". You can set this property at any time for any user, but it is especially useful for newly created users. It reduces administrative work when you set up basic signons.

This setting affects only basic signon authentication.

Default: No

Type: String



ConnectionString Property (SetDatabaseProperty Command)

ConnectionString Property (SetDatabaseCubeProperty Command)

Connection Strings for Supported Databases

DescriptionSpecifies the connection string for a Database or PowerCube object.

DiscussionUse this property to identify the location of data. ConnectionString returns the information that Access Manager requires to connect to the database or PowerCube, as found in the [Databases] section of the Cognos.ini file.

The format of the ConnectionString is

<security prompt>;<host>;<type>;<physical>

The <security prompt> indicates the number of parameters required to complete the connection string before Access Manager can connect to the database. Each parameter starts with a caret (^) and is followed by a name to identify the parameter. The <secuirty prompt> value, when specified, is almost always "Ûser ID:^? Password:"

The <host> is always "Local".

The <type> is a two character code that represents the database type. The [Database Support] section of the Cognos.ini file describes these codes and the database type they represent.

The <physical> parameter represents the description of the database. The format of the description varies with the database type.

Examples of connection strings for supported databases:

Sybase SQL Server (DB-Lib)ÛserID:^?Password:;LOCAL;SY;|master@%s/%s@APPNAME=Impromptu

Informix

Ûser ID:^?Password:;LOCAL;IF;//Local:server1/general|sqlexec@%s/%s


ConnectionString Required. Specifies a new connection string for the database.

Type: String


ConnectionString Required. Specifies a new connection string for the database cube.

Type: String



CreatePersonalNewsBox Property (SetUserProperty Command)

DataSourcePrivileges Property (SetUserClassProperty Command)

DaylightSavingsTimeInEffect Property (SetNamespaceProperty Command)

DaylightSavingsTimeInEffect Property (SetUserProperty Command)


CreatePersonalNewsBox Optional. Permits the creation of a personal NewsBox for a user in Upfront when that user logs into Upfront for the first time.

Yes = creates a personal NewsBox

No = does not permit a user to create a personal NewsBox in Upfront

A NewsBox is an entry in Upfront that a user can see and interact with. It can contain NewsItems, NewsItem references, NewsBox references, and other NewsBoxes. Only the owner of a personal NewsBox can view its contents.

Type: String


DataSourcePrivileges Optional. Specifies the permissions of the user class members for accessing data sources. Use the vertical line character ( | ) to specify more than one permission. The permissions are:

Create = add or modify a data source

Delete = delete a data source

None = no permissions set

Show = show a list of available data sources.

Type: String


DaylightSavingsTimeInEffect Optional. Specifies whether a namespace is offset by daylight savings time. The settings are "Yes" or "No".

Default: No

Type: String


DaylightSavingsTimeInEffect Optional. Specifies whether a user is offset by daylight savings time. The settings are "Yes" or "No".

Default: No

Type: String



DayRestriction Property (SetUserClassProperty Command)

Description Property (SetCubeProperty Command)

Description Property (SetDatabaseProperty Command)

Description Property (SetDatabaseCubeProperty Command)


DayRestriction Optional. Specifies the days of the week for user access to the current user class. Use this property to specify access or lock out days for user classes. For example, if you assign a user class access to a cube on weekdays, members of that user class cannot access the cube on Saturday or Sunday. Use the vertical line character ( | ) to separate the days of the week. Type the full name for the day of the week

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Sunday

Type: String


Description Required. Specifies that you want to update the description property for a cube.

Type: String


Description Required. Specifies that you want to update the description property for a database.

Type: String


Description Required. Specifies that you want to update the description property for a database cube.

Type: String



Description Property (SetDatabaseSignonProperty Command)

Description Property (SetMetadataObjectProperty Command)

Description Property (SetNamespaceProperty Command)

Description Property (SetPowerPlayServerProperty Command)

Description Property (SetTransformerServerProperty Command)

Description Property (SetTransformerServerSignonProperty Command)


Description Optional. Specifies that you want to update the description of a DatabaseSignon object.

Type: String


Description Optional. Specifies the description for a Metadata object. The description applies to all types of metadata sources.

Type: String


Description Optional. Specifies descriptive text about the namespace.

Type: String


Description Optional. Specifies that you want to update the description property for a PowerPlayServer object.

Type: String


Description Optional. Specifies that you want to update the description property for a TransformerServer object.

Type: String


Description Optional. Specifies a new description for a Transformer server signon.

Type: String



Description Property (SetUserBasicSignonProperty Command)

Description Property (SetUserClassProperty Command)

Description Property (SetUserOSSignonProperty Command)

Description Property (SetUserProperty Command)

Email Property (SetUserProperty Command)

ExpiredPasswordWarningPeriod Property (SetNamespaceProperty Command)


Description Optional. Specifies a new description for a basic signon associated with a user.

Type: String


Description Optional. Specifies the description for the user class.

Type: String


Description Optional. Specifies a new description for an OSSignon associated with a user.

Type: String


Description Optional. Specifies a new description for a User object.

Type: String


Email Optional. Specifies an email address associated with a user.

Type: String


ExpiredPasswordWarningPeriod Optional. Specifies the number of days remaining, from the time that a warning message appears, before a password expires.

Type: Integer



ExternalIdentiyMapping (SetNamespaceProperty Command)

FirstName Property (SetUserProperty Command)

HourRestriction Property (SetUserClassProperty Command)

Keywords Property (SetNamespaceProperty Command)


ExternalIdentityMapping Optional. Specifies the environment variable to use to obtain user signon information for Web signon.

Type: String


FirstName Optional. Specifies the first name associated with a user. Use the FirstName property when a user has one or more first names.

Type: String


HourRestriction Optional. Specifies the start and end time to permit user class access. If a user is connected when the end time occurs, the user connection to the namespace terminates. Use a vertical line character (|) to separate the start and end times. Express time using a twenty-four hour notation. The syntax for this property is

hh:mm|hh:mm

hh:mm tt |hh:mm tt

(Start) | (End)

For example, 09:00|17:30 indicates that the user class has access from 9:00 am until 5:30 pm. A time restriction hour range is from 00:00|24:00 for one day.

Type: String


Keywords Optional. Specifies words that can help users identify a namespace. Use spaces to separate key words.

Type: String



Language Property (SetNamespaceProperty Command)

Language Property (SetUserProperty Command)

LastName Property (SetUserProperty Command)


Language Optional. Specifies the language associated with a namespace. It can be one of• Deutsch• English• Español• Français• Italiano• Nederlands• Português• Suomi• Svenska

Type: String

Note: Language name must include special characters.


Language Optional. Specifies a language associated with a user. It can be one of• Deutsch• English• Español• Français• Italiano• Nederlands• Português• Suomi• Svenska• NamespaceDefault represents the default language setting for

the current namespace.

Type: String

Note: Language name must include special characters.


LastName Optional. Specifies the last name associated with a user. Use the LastName property when a user has one or more last names.

Type: String



Locale Property (SetNamespaceProperty Command)

Locale Property (SetUserProperty Command)

Locale TableUse to set the locale property for a Namespace or User object. Use the abbreviation as a setting for this property.


Locale Optional. Specifies the correct regional formats for numbers and dates, list separators, and so on. For a list of available settings, see the Locale Table.

Type: String


Locale Optional. Specifies the correct regional formats for numbers and dates, list separators, and so on. For a list of available settings, see the Locale Table.

NamespaceDefault represents the default locale setting for the current namespace.

Type: String

Locale Abbreviation

Afrikaans af

Albanian sq

Basque eu

Belarusian be

Bulgarian bg

Catalan cq

Chinese (PRC) zh-cn

Chinese (Taiwan) zh-tw

Croatian hr

Czech cs

Danish da

Dutch (Belgian) nl-be

Dutch (Netherlands) nl-nl

English (Australian) en-au

English (Belize) en-bz



English (Canadian) en-ca

English (Ireland) en-ie

English (Jamaica) en-jm

English (New Zealand) en-nz

English (South Africa) en-za

English (Trinidad) en-tt

English (United Kingdom) en-gb

English (United States) en-us

Estonian et

Faeroese fo

Finnish fi

French (Belgian) fr-be

French (Canadian) fr-ca

French (France) fr-fr

French (Luxembourg) fr-lu

French (Swiss) fr-ch

German (Germany) de-de

German (Liechtenstein) de-li

German (Luxembourg) de-lu

German (Swiss) de-ch

Greek el

Hungarian hu

Icelandic is

Indonesian id

Italian (Italy) it-it

Italian (Swiss) it-ch

Japanese ja

Korean ko

Latvian lv

Lithuanian lt

Norwegian (Bokmal) no

Locale Abbreviation



Polish pl

Portuguese (Brazilian) pt-br

Portuguese (Portugal) pt-pt

Romanian ro

Russian ru

Serbian (Cyrillic) sr

Slovak sk

Slovenian sl

Spanish (Argentina) es-ar

Spanish (Bolivia) es-bo

Spanish (Chile) es-cl

Spanish (Colombia) es-co

Spanish (Costa Rica) es-cr

Spanish (Dominican Rep) es-do

Spanish (Ecuador) es-ec

Spanish (El Salvador) es-sv

Spanish (Guatemala es-gt

Spanish (Honduras) es-hn

Spanish (Mexican) es-mx

Spanish (Nicaragua) es-ni

Spanish (Panama) es-pa

Spanish (Paraguay) es-py

Spanish (Peru) es-pe

Spanish (Puerto Rico0 es-pr

Spanish (Spain) es-es

Spanish (Uruguay) es-uy

Spanish (Venezuela) es-ve

Swedish (Finland) sv-fi

Swedish (Sweden) sv-sv

Turkish tr

Ukrainian uk

Locale Abbreviation



LockoutDuration Property (SetNamespaceProperty Command)

MaxInvalidAttempts Property (SetNamespaceProperty Command)

Password Property (SetDatabaseSignonProperty Command)

Password Property (SetTransformerServerSignonProperty Command)

Password Property (SetUserBasicSignonProperty Command)


LockoutDuration Optional. Specifies the length of time in minutes that a user will be locked out from a namespace after the maximum number of incorrect logon attempts. Use -1 to specify no lockout duration. The lockout duration range is from 1 to 32767 minutes.

Type: Integer


MaxInvalidAttempts Optional. Specifies the maximum number of times that a user can attempt to log on to a namespace using a basic signon. Use -1 to specify an unlimited number of logon attempts.

Type: Integer


Password Optional. Specifies a new password for the database signon.

Type: String


Password Optional. Specifies a new password for a Transformer server signon.

Type: String


Password Optional. Specifies a new password for a basic signon associated with a user. This password must be at least one character.

Type: String



PasswordCaseSensitivity Property (SetNamespaceProperty Command)

PasswordExpiry Property (SetNamespaceProperty Command)

PasswordMinLength Property (SetNamespaceProperty Command)

PasswordNeverExpires Property (SetUserProperty Command)


PasswordCaseSensitivity Optional. Specifies whether passwords are case-sensitive. Do not include quotation marks.

Yes = passwords are case-sensitive

No = passwords are not case-sensitive

Type: String


PasswordExpiry Optional. Specifies the time limit for passwords, for example, 2 months. The syntax is an integer followed by a string. If you use 1 as the integer value, both the plural and the non-plural time specified are acceptable. For example, 1 week or 1 weeks have the same meaning. The time increments are

year or years

month or months

week or weeks

day or days

hour or hours

minute or minutes

Type: String


PasswordMinLength Optional. Specifies the minimum number of characters required for passwords. The range is from 0 to 255 characters.

Type: Integer


PasswordNeverExpires Optional. Specifies whether the user’s password for the basic signon can expire. The settings are "Yes" or "No". Use this property to grant a user permanent access to a namespace. When set to "Yes", this setting takes precedence over the password settings at the namespace level, such as PasswordExpiry, and so on.


Default: No

Type: String



PhoneNumber Property (SetUserProperty Command)

Port Property (SetPowerPlayServerProperty Command)

PowerPlayServerPrivileges Property (SetUserClassProperty Command)

PublicUserClass Property (SetNamespaceProperty Command)

RequiresSignon Property (SetDatabaseProperty Command)


PhoneNumber Optional. Specifies the user's phone number.

Type: String


Port Optional. Specifies a new port for the PowerPlay server. This property must have the same value that was set on the computer that contains the PowerPlay server.

Type: Integer


PowerPlayServerPrivileges Optional. Specifies the permissions of the user class members for accessing PowerPlay servers. Use the vertical line character ( | ) to specify more than one permission. The permissions are.

Create = add or modify a PowerPlay server

Delete = remove a PowerPlay server


Show = show a list of available PowerPlay servers.

Type: String


PublicUserClass Optional. Specifies a general user class for a namespace. It is one of the user classes that exist in the namespace. Every user associated with a namespace automatically becomes a member of the Public User Class.

Type: String


RequiresSignon Optional. Specifies whether the database has to be secured with a signon. The settings are "Yes" or "No".

Type: String



SignonCaseSensitivity Property (SetNamespaceProperty Command)

SignonMinLength Property (SetNamespaceProperty Command)

Subject Property (SetNamespaceProperty Command)

TimeFormat Property (SetNamespaceProperty Command)

TimeFormat Property (SetUserProperty Command)


SignonCaseSensitivity Optional. Specifies whether signon names are case-sensitive. Do not include quotation marks.

Yes = signons are case-sensitive

No = signons are not case-sensitive

Type: String


SignonMinLength Optional. Specifies the minimum number of characters required for signon names including basic and OS signon names. The range is from 1 to 255 characters.

Type: Integer


Subject Optional. Specifies any subject information relating to the namespace, for example, Sales Regions.

Type: String


TimeFormat Optional. Specifies a time format associated with a namespace. The valid formats are "hh:mm:ss" or "HH:mm:ss", where h represents hours for the 12-hour clock, H represents hours for the 24-hour clock, m represents minutes, and s represents seconds.

Type: String


TimeFormat Optional. Specifies a time format associated with a user. The valid formats are "hh:mm:ss" or "HH:mm:ss", where h represents hours for the 12-hour clock, H represents hours for the 24-hour clock, m represents minutes, and s represents seconds.

NamespaceDefault represents the default time format setting for the namespace.

Type: String



TimeZone Property (SetNamespaceProperty Command)

TimeZone Property (SetUserProperty Command)

Time Zone TableUse to set the time zone property for a Namespace or User object. Use the Time zone column values as a setting for this property.


TimeZone Optional. Specifies the time zone associated with a namespace.

Type: String


TimeZone Optional. Specifies a time zone associated with a user.

NamespaceDefault represents the default time zone setting for the current namespace.

Type: String

Time Zone GMT offset

Dateline (GMT-12:00) Eniwetok, Kwajatein

Samoa (GMT-11:00) Midway Island, Samoa

Hawaiian (GMT-10:00) Hawaii

Alaskan (GMT-09:00) Alaska

Pacific (GMT-08:00) Pacific Time (US & Canada), Tijuana

NorthAmericaMountain (GMT-07:00) Mountain Time (US & Canada)

USMountain (GMT-07:00) Arizona

CanadaCentral (GMT-06:00) Saskatchewan

NorthAmericaCentral (GMT-06:00) Central Time (US & Canada)

Mexico (GMT-06:00) Mexico City, Tegucigalpa

USEastern (GMT-05:00) Indiana East

NorthAmericaEastern (GMT-05:00) Eastern Time (US & Canada)

SouthAmericaPacific (GMT-05:00) Bogota, Lima

Atlantic (GMT-04:00) Atlantic Time (Canada)

SouthAmericaWestern (GMT-04:00) Caracas, La Paz

Newfoundland (GMT-03:30) Newfoundland

EastSouthAmerica (GMT-03:00) Brasilia



SouthAmericaEastern (GMT-03:00) Buenos Aires, Georgetown

MidAtlantic (GMT-02:00) Mid-Atlantic

Azores (GMT-01:00) Azores, Cape Verde Is.

GMT1 (GMT1) Greenwich Mean Time; Dublin, Edinburgh, London, Lisbon

GMT2 (GMT2) Monrovia, Casablanca

Romance (GMT+01:00) Paris, Madrid, Amsterdam

WesternEurope (GMT+01:00) Berlin, Stockholm, Rome, Bern, Brussels, Vienna

CentralEurope (GMT+01:00) Prague, Warsaw, Budapest

Eastern Europe (GMT+02:00) Eastern Europe

Egypt (GMT+02:00) Cairo

GFT (GMT+02:00) Athens, Helsinki, Istanbul

Israel (GMT+02:00) Israel

SouthAfrica (GMT+02:00) Harare, Pretoria

Russia (GMT+03:00) Moscow, St. Petersburg, Kazan, Volograd

SaudiArabia (GMT+03:00) Baghdad, Kuwait, Nairobi, Riyadh

Iran (GMT+03:00) Tehran

Arabia (GMT+04:00) Abu Dhabi, Muscat, Tbilisi

Afghanistan (GMT+04:30) Kabul

WestAsia (GMT+05:00) Islamabad, Karachi, Ekaterinburg, Tashkent

India (GMT+05:30) Bombay, Calcutta, Madras, New Delhi, Colombo

CentralAsia (GMT+06:00) Almaty, Dhaka

Bangkok (GMT+07:00) Bangkok, Jakarta, Hanoi

China (GMT+08:00) Beijing, Chongquinq, Urumqi

Taipei (GMT+08:00) Hong Kong, Perth, Singapore,Taipei

Tokyo (GMT+09:00) Tokyo, Osaka, Sapporo, Seoul, Yakutsk

AUSCentral (GMT+09:30) Darwin

CentralAustralia (GMT+09:30) Adelaide

Sydney (GMT+10:00) Brisbane, Melbourne, Sydney

WestPacific (GMT+10:00) Guam, Port Moresby, Vladivostok

Tasmania (GMT+10:00) Hobart




Timeout Property (SetPowerPlayServerProperty Command)

Title Property (SetNamespaceProperty Command)

TransformerServerPrivileges Property (SetUserClassProperty Command)

CentralPacific (GMT+11:00) Magadan, Solomon Is., New Caledonia

Fiji (GMT+12:00) Fiji, Kamchatka, Marshall Is.

NewZealand (GMT+12:00) Wellington, Auckland



Timeout Optional. Specifies a new timeout value (in seconds) for a PowerPlay server. This property must have the same value that was set on the computer that contains the PowerPlay server. A value of zero indicates that there is no timeout restriction.

Type: Integer


Title Optional. Specifies a title for the namespace, for example, All Sales Regions.

Type: String


TransformerServerPrivileges Optional. Specifies the permissions of the user class members for accessing Transformer servers. Use a vertical line character ( | ) to separate more than one permission. The permissions are

Create = add or modify a Transformer server

Delete = remove a Transformer server


Show = show a list of available Transformer servers.

Type: String



UserCanNotChangePassword (SetUserProperty Command)

UserClassPrivileges Property (SetUserClassProperty Command)


UserCanNotChangePassword Optional. Specifies whether users have permission to change their password for the basic signon. The settings are "Yes" or "No". Use this property to control users’ access to a namespace. When you set this property to "Yes", users may not change their basic signon password, so that each user’s account expires automatically when the password expires. This saves on maintenance time.

You can set this option for non-administrative users who belong to a user class that does not have the permission to create users.


Default: No

Type: String


UserClassPrivileges Optional. Specifies the permissions of a user class in regards to other user classes. Use a vertical line character ( | ) to specify more than one permission. Use this property to limit a user's view to objects in their own and descendant user classes. The permissions are

Create = add or modify a user class

Delete = delete a user class


Show = show a list of available user classes the user belongs to

ShowAll = show all user and user class objects in the namespace, including those in ancestor user classes.

This privilege depends on the user and user class show privileges.• If showAll is set to false, and show for users and user classes are

set to true, users can see the users and user classes to which they have access, including the children user classes and users who are members of those user classes.

• If showAll and show for users and user classes are set to false, users cannot see any users and user classes in the namespace.

• If showAll and show for user classes are set to true, and show for users is set to false, users can view all user classes, but no users in the namespace.

• If showAll and show for users and user classes are set to true, users can see all users and all user classes in the namespace.

Type: String



UserPrivileges Property (SetUserClassProperty Command)


UserPrivileges Optional. Specifies the permissions of a user in regards to other users. Use the vertical line character ( | ) to specify more than one permission. The permissions are

Create = add or modify a user

Delete = delete a user

ModifySelf = change the user's own properties, except for passwords


Show = show a list of available users.

Type: String


Chapter 7: Legacy Input Files

Access Manager supports the User and User Class types of input files for customers with existing scripts. There will be no further development on these types in future. We recommend that you use the All Objects type of input file.

User input files can contain three commands: add a user, delete a user, or change user signon information. The change command changes only the basic signon password and OS signon domain. It does not change the user class, basic signon, or OS signon. If you try to change the basic signon or OS signon using this command, you will add another basic or OS signon to the existing signon.

User Class input files can contain two commands: add a user class or delete a user class.

NotesAccess Manager Batch Maintenance does not support extended characters for User and User Class types of input files. However, you can use extended characters for the All Objects type of input file.

User Input File

SyntaxCommand,UserName,UserNameDescription,BasicSignonName,BasicSignonPassword,OSSignonDomain,OSSignonUserName,UserClass,UserClassDescription

DescriptionYou create a user input file to add or delete users, or change user signon information.

DiscussionWhen you create a user input file, ensure that• the user name, basic signon name, and the operating system (OS) signon name are unique• a user class exists• you do not add quotation marks around string values

Commas are always required in the input file regardless if a field has a value. If you do not specify one or more parameters, include only the comma separator. For example, to change only the UserNameDescription parameter, the syntax isC,UserName,UserNameDescription,,,,,

Access Manager Batch Maintenance logs all activities in the file log.txt in the folder that contains the Access Manager Batch Maintenance tool.

You can use the Output file group box in Access Manager Batch Maintenance to specify another location for the log file.

The Access Manager Batch Maintenance tool appends new processing results to the end of the log file. You may want to edit this file occasionally to limit the file size.

Add a UserTo add a user, the syntax isA, UserName,UserNameDescription,BasicSignonName,BasicSignonPassword,OSSignonDomain,OSSignonUserName,UserClass,UserClassDescription




Change User InformationTo change user information, the syntax isC,UserName,UserNameDescription,BasicSignonName,BasicSignonPassword,OSSignonDomain,OSSignonUserName,UserClass,UserClassDescription

Delete a UserTo delete a user, the syntax isD,UserName

CommandsThe parameters and order for a command line in a user input file are


Command Required. Specifies the type of action to perform. The command types are

A = add a user

C = change user information

D = delete a user

Type: String

UserName Required. Specifies a unique user name.

Type: String

UserNameDescription Required. Specifies descriptive text for the user name.

Type: String

BasicSignonName Optional. Specifies the user ID that applications that use Access Manager use to identify individual users. If you add basic signons, you must specify a basic signon name and password. If you change a basic signon password you must specify a basic signon name and the new basic signon password.

Type: String

BasicSignonPassword Optional. Specifies the password that applications that use Access Manager use to identify individual users. If you add basic signons, you must specify a basic signon name and password. If you change a basic signon password you must specify a basic signon name and the new basic signon password.

Type: String

OSSignonDomain Optional. Specifies the domain name for an OS signon. If you add OS signons, you must specify an OS signon domain and OS signon user name. If you change an OS signon, you must specify an OS signon domain and an OS signon user name (the format is DOMAIN\User).

Type: String



ExampleThis example • adds a user named John Smith to the Sales user class without adding a basic signon or OS

signon in the first command line• adds the user Fred Richard to the France Sales user class and includes a description of the user

name, a basic signon, and OS signon in the second command line• deletes the user Bill Gibbons in the third command line• changes the basic signon password for the user Dave Mustaine in the fourth command line• changes the OS signon for the user Matt Casgott in the last command line A,John Smith,This description of John Smith,,,,,Sales,A,Fred Richard,This is a description of Fred Richard,RichardF,FRED1234,Europe,Europe\FredR,France Sales,D,Bill GibbonsC,Dave Mustaine,This is a description of Dave,Mustaind,Dave9999,,,,C,Matt Casgott,This is a description of Matt,,,Namerica,Namerica\CasgottM,,

Related Topics• "All Objects Input File" (p. 9)• "Create an Input File" (p. 9)• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Graphical User Interface" (p. 11)• "View the Log File (All Objects Input File)" (p. 13)• "View the Log File (User Input File)" (p. 135)

User Class Input File

SyntaxCommand,UserClass,UserClassDescription,UserClassParent

DescriptionYou create a user class input file to create or delete user classes.

DiscussionCreate user class input files first, because user classes must exist before you can add users to them.

When you create a user class input file, ensure that• all user class names are unique for a given namespace

OSSignonUserName Optional. Specifies the user name associated with an OS signon. If you add OS signons, you must specify an OS signon domain and OS signon user name. If you change an OS signon, you must specify an OS signon domain and an OS signon user name (the format is DOMAIN\User).

Type: String

UserClass Required. Specifies the unique user class name within a namespace. The user class must exist before you can add or delete users, or change user signon information.

Type: String

UserClassDescription Optional. Specifies a description associated with a user class.

Type: String




• for Windows, you use the same file-naming conventions used by Windows Explorer when naming user classes, and for UNIX, you use the same file-naming conventions and take note of case-sensitivity

• a parent user class exists, such as the Root User Class. When you add a namespace, Access Manager automatically creates a Root User Class object

• you do not add quotation marks around string values

Commas are always required in the input file regardless if a field has a value. If you do not specify one or more parameters, include only the comma separator. For example, to add only a UserClassDescription parameter, the syntax isA,Sales Representatives,UserClassDescription,

Access Manager Batch Maintenance logs all activities in the file log.txt. You specify the location of this file in the Access Manager Batch Maintenance tool.

You can use the Output file group box in the Access Manager Batch Maintenance tool to specify another location for the log file.

The Access Manager Batch Maintenance tool appends new processing results to the end of the log file. You may want to edit this file occasionally to limit the file size.

Add a User ClassTo add a user class, the syntax isA, UserClass, Description, UserClassParent

Delete a User ClassTo delete user class information, the syntax isD, UserClass

Commands

ExampleThis example adds user classes named Sales Representatives, Marketing Managers, Vice Presidents, and Finance Managers, and deletes the user classes named All VPs and All Sales.A,Sales Representatives,,Root User ClassA,Marketing Managers,,Root User Class


Command Required. Specifies the type of action to perform. The command types are

A = add a user class

D = delete a user class

Type: String

UserClass Required. Specifies a unique user class name for the namespace.

Type: String

UserClassDescription Optional. Specifies a description for the user class.

Type: String

UserClassParent Reqired. Specifies the parent name for the user class. Use "<Root User Class>" to specify the Root User Class of the namespace. This parameter is case-sensitive. Use this parameter when you add a user class.

Type: String



A,Vice Presidents,,Root User ClassD,All VPsD,All Sales

Related Topics• "Create an Input File" (p. 9)• "All Objects Input File" (p. 9)• "View the Log File (All Objects Input File)" (p. 13)

View the Log File (User Input File)After the Access Manager Batch Maintenance tool processes an input file, it logs the results in a file named log.txt in the location specified in Access Manager Batch Maintenance.

For example, you create the following user input file:A,User 1,This is user 1,basic signon 1,GOPassword,NAMERICA,NAMERICA\user1,User Class 1A,User 2,This is user 2,basic signon 2,GOPassword,NAMERICA,NAMERICA\user2,User Class 1,This command should workA,User 3,This is user 3,basic signon 3,GOPassword,NAMERICA,NAMERICA\user1,User Class 1,This command should fail-user signon existsA,User 4,This is user 4,basic signon 1,GOPassword,NAMERICA,NAMERICA\user4,User Class 1,This command should fail-basic signon existsA,User 5,This is user 5,,,,,User Class 1,D,User 5D,User 2A,User 6,This is user 6,basic signon 6,GOPassword,,,User Class 1,This command should workA,User 7,This is user 7,,,NAMERICA,NAMERICA\user7,User Class 1,This command should workA,User 8,This is user 8,basic signon 8,,,,User Class 1,This command should fail-no basic signon passwordA,User 9,This is user 9,basic signon 9,,NAMERICA,NAMERICA\user9,User Class 1,This command should fail-no basic signon passwordA,User 10,This is user 10,,GOPassword,,,User Class 1,This command should fail-no basic signonA,User 11,This is user 11,,GOPassword,NAMERICA,NAMERICA\user11,User Class 1,This command should fail-no basic signonA,User 12,This is user 12,,,NAMERICA,,User Class 1,This command should fail-no OS usernameA,User 13,This is user 13,basic signon 13,GOPassword,NAMERICA,,User Class 1,This command should fail-no OS username

After Access Manager Batch Maintenance processes the input file, log.txt contains the following results:Friday, August 12,1999- Input File : C:\Program Files\Common Files\Cognos Shared\Access Manager\6.0\MyUsers.txtUsing namespace: User_TestRecord: 1 - Added User: User 1Record: 1 - Added basic signon for user: User 1Record: 1 - Added OS signon for user: User 1Record: 2 - Added User: User 2Record: 2 - Added basic signon for user: User 2Record: 2 - Added OS signon for user: User 2Record: 3 - Added User: User 3Record: 3 - Added basic signon for user: User 3Record: 3 - ERROR - Could not add OS signon for user :User 3 Reason: Record: 4 - Added User: User 4Record: 4 - ERROR - Could not add basic signon for user: User 4 Reason: Name conflict in BasicSignon::BasicSignon : basic signon 1Record: 5 - Added User: User 5Record: 6 - Deleted User: User 5Record: 7 - Deleted User: User 2Record: 8 - Added User: User 6Record: 8 - Added basic signon for user: User 6Record: 9 - Added User: User 7



Record: 9 - Added OS signon for user: User 7Record: 10 - Added User: User 8Record: 10 - ERROR - No password when adding basic signon for User: User 8Record: 11 - Added User: User 9Record: 11 - ERROR - No password when adding basic signon for User: User 9Record: 12 - Added User: User 10Record: 12 - ERROR - Basic signon password found with no matching signon for User: User 10Record: 13 - Added User: User 11Record: 13 - ERROR - Basic signon password found with no matching signon for User: User 11Record: 14 - Added User: User 12Record: 14 - ERROR - OS signon domain name found with no matching OS signon for User: User 12Record: 15 - Added User: User 13Record: 15 - ERROR - OS signon domain name found with no matching OS signon for User: User 13

Each record number corresponds to a command line in the user input file. The actions performed based on each command are listed as separate entries. For example, if the first command in an input file only adds the user KarenV to the Finance user class, the log file recordsRecord: 1 - Added User: KarenV

If the second command adds the user GaryW to the Finance user class and includes both a basic signon and password and an OS signon, the log file recordsRecord: 1 - Added User: GaryWRecord: 1 - Added Signon for user: GaryWRecord: 1 - Added basic signon for user :GaryW

Access Manager Batch Maintenance logs all activities in the file log.txt in the folder that contains the Access Manager Batch Maintenance tool.

You can use the Output file group box in Access Manager Batch Maintenance to specify another location for the log file.

Related Topics• "Create an Input File" (p. 9)• "Run the Access Manager Batch Maintenance Tool" (p. 11)• "Use the Command Line" (p. 12)• "Use the Graphical User Interface" (p. 11)


Index

AAccess Manager

automating, 7Access Manager Batch Maintenance, 7

commands, 35object associations, 33objects, 17properties, 109

addingdata sources, 38, 39, 40folders, 45namespaces, 48object associations, 33servers, 49, 50, 52signons, 42, 55, 57user classes, 56users, 54

All Objects input file, 9associating

objects, 33automating

Access Manager, 7

Bbasic signons

adding, 55changing names, 67deleting, 82

batch maintenance, 7commands, 35object associations, 33objects, 17properties, 109

Cchanging names

data sources, 59, 60, 61, 63folders, 63servers, 64, 65signons, 62, 66, 67, 69user classes, 68users, 68

charactersinput files, 9

command lineparameters, 13running batch maintenance tool, 12

commands (Batch Maintenance), 35AddCube, 38, 114AddCubeToUser, 39AddDatabase, 39

commands (Batch Maintenance) (cont'd)AddDatabaseCube, 40AddDatabaseCubeToUser, 41AddDatabaseSignon, 42AddDatabaseSignonToUser, 43AddDatabaseToUser, 44AddFolder, 45AddMetadataObjectToUser, 47AddNamespace, 48AddPowerPlayServer, 49AddTransformerServer, 50AddTransformerServerSignon, 52AddTransformerServerSignonToUser, 53AddTransformerServerToUser, 51AddUser, 54AddUserBasicSignon, 55AddUserClass, 56AddUserOSSignon, 57AddUserToUserClass, 58ChangeCubeName, 59ChangeDatabaseCubeName, 61ChangeDatabaseName, 60ChangeDatabaseSignonName, 62ChangeFolderName, 63ChangeMetadataObjectName, 63ChangePowerPlayServerName, 64ChangeTransformerServerName, 65ChangeTransformerServerSignonName, 66ChangeUserBasicSignonName, 67ChangeUserClassName, 68ChangeUserName, 68ChangeUserOSSignonName, 69DeleteCube, 70DeleteCubeFromUser, 70DeleteDatabase, 71DeleteDatabaseCube, 72DeleteDatabaseCubeFromUser, 73DeleteDatabaseFromUser, 73DeleteDatabaseSignon, 74DeleteDatabaseSignonFromUser, 75DeleteFolder, 76DeleteMetadataObject, 77DeleteNamespace, 77DeletePowerPlayServer, 78DeleteTransformerServer, 79DeleteTransformerServerFromUser, 79DeleteTransformerServerSignon, 80DeleteTransformerServerSignonFromUser, 81DeleteUser, 82DeleteUserBasicSignon, 82DeleteUserClass, 83DeleteUserFromUserClass, 84DeleteUserOSSignon, 85



Index

commands (Batch Maintenance) (cont'd)LinkUser, 85LogoffNamespace, 87LogonNamespace, 86object associations, 33RelinkUser, 88RemoveMetadataObjectFromUser, 89SetCubeFolder, 90SetCubeProperty, 91SetDatabaseCubeProperty, 91SetDatabaseFolder, 92SetDatabaseProperty, 93SetMetadataObjectFolder, 95SetMetadataObjectProperty, 96SetNamespaceProperty, 97SetPowerPlayServerProperty, 99SetTransformerServerProperty, 100SetTransformerServerSignonProperty, 101SetUserBasicSignonProperty, 102SetUserClassProperty, 103SetUserFolder, 105SetUserOSSignonProperty, 105SetUserProperty, 106

connection stringsdatabase cubes, 112databases, 112

copyright, 2creating

input files, 11cubes

adding, 38, 40adding to users, 39, 41deleting, 70, 72removing from users, 70

Ddatabase cubes

changing names, 61connection strings, 112removing from users, 73

database signonsadding, 42adding to users, 43changing names, 62deleting, 74removing from users, 75

databasesadding, 39adding to users, 44changing names, 60connection strings, 112deleting, 71removing from users, 73

deletingbasic signons, 82cubes, 70database cubes, 72database signons, 74databases, 71folders, 76metadata, 77

deleting (cont'd)namespaces, 77OS signons, 85PowerPlay servers, 78Transformer server signons, 80Transformer servers, 79user classes, 83users, 82

Eextended characters

input files, 131

Ffolders


Ggraphical user interface

running batch maintenance tool, 11

Iinput files

creating, 11extended characters, 131line continuation characters, 9recommended for use, 9types, 9, 131, 133

Llocales

supported, 119log files, 13

Mmetadata

adding to users, 47changing names, 63deleting, 77removing from users, 89

Nnamespaces

deleting, 77logging off, 87logging on, 86

Oobjects (Batch Maintenance), 17

associations, 33BasicSignon, 17Cube, 18Database, 19DatabaseCube, 20DatabaseSignon, 21


Index

objects (Batch Maintenance) (cont'd)Folder, 23Metadataobjects, 24Namespace, 25OSSignon, 26PowerPlayServer, 27TransformerServer, 28TransformerServerSignon, 29User, 30UserClass, 32

operating system (OS) signons, 69adding, 57

PPowerPlay servers

changing names, 64deleting, 78

properties (Batch Maintenance), 109AccountIsDisabled, 110ActiveSignon, 110AuthenticateAs, 111AuthorFirstName, 111AuthorLastName, 111ChangePasswordAtNextLogon, 111ConnectionString, 112, 116DataSourcePrivileges, 113DaylightSavingsTimeInEffect, 113DayRestriction, 114Description, 91, 114, 115, 116Email, 116ExpiredPasswordWarningPeriod, 116ExternalIdentifyMapping, 117FirstName, 117HourRestriction, 117Keywords, 117Language, 118LastName, 118Locale, 119LockoutDuration, 122MaxInvalidAttempts, 122Password, 122PasswordCaseSensitivity, 123PasswordExpiry, 123PasswordMinLength, 123PasswordNeverExpires, 129PhoneNumber, 124PortNumber, 124PowerPlayServerPrivileges, 123PublicUserClass, 124RequiresSignon, 124SignonCaseSensitivity, 125SignonMinLength, 125Subject, 125TimeFormat, 125Timeout, 128TimeZone, 126Title, 128UserCanNotChangePassword, 129UserClassPrivileges, 129UserPrivileges, 130

Rregional settings

locales, 119time zones, 126

removingcubes from users, 70database cubes from users, 73database signons from users, 75databases from users, 73metadata from users, 89Transformer servers from users, 79Transformer servers signons from users, 81users from user classes, 84

runningbatch mainatenance tool, 11, 13

Sservers

PowerPlay servers, 27Transformer servers, 28

signonsdatabases, 21operating system (OS), 26Transformer servers, 29

Ttime zones, 126

supported, 126Transformer server signons

adding, 52changing names, 66deleting, 80removing from users, 81

Transformer serversadding, 50adding to users, 51changing names, 65deleting, 79removing from users, 79

UUser Class input file, 133user classes

adding, 56adding users, 58changing names, 68deleting, 83

user input file, 131users


Vversion of document, 2viewing

log files, 13, 135


Index


Date post:	25-Dec-2019
Category:	Documents
Upload:	others
View:	4 times
Download:	0 times

Access Manager - Batch Maintenance...

Documents