 |
Adding Organizations
|
This help file applies to an out-of-date version of MainBoss.
The most recent version of MainBoss is MainBoss 4.2.4.
This help file does not exist in MainBoss 4.2.4, but the index for that version can be found here.
< Previous section | Table of Contents | Index | Next section >
The AddOrganization verb of MBUtility lets you add an organization to a user's organization list. By default, this will be the current user (i.e. the person who executes the mbutility command). However, some options let you specify a different user's organization list.
The database associated with the organization must already exist and the user must have appropriate permissions on the database. This means that the user's name must be specified in the database's Users table.
For example, if you are logged in under the name jsmith, you can use AddOrganization to put a new organization in jsmith's list of known organizations, provided that jsmith appears in the database's Users table.
The format of the command is
mbutility AddOrganization option option ...
where the options are:
- +Replace
- This option is relevant if the user's organization list already contains an organization with the same name. +Replace says the old organization should be replaced with the new organization. If you do not specify +Replace, MBUtility will not replace old organization's with new ones; if there is a name conflict, you will be receive an error message.
- +Probe
- If you specify this option, MBUtility will attempt to verify that the user can actually access the database. If you do not specify +Probe, the database will be added to the user's organization list, but MBUtility doesn't check to see if the user can actually connect to the database.
- +SetDefault
- Marks the added database as your default database. This is the database that will automatically be opened whenever you start MainBoss.
- /Mode:startmode
- Specifies the default start-up mode when the user connects to the database. The startmode value must be one of the following strings:
MainBoss Requests
MainBoss
View Sessions
Administration
For explanations of these startup modes, see Start Modes of this guide.
- +CompactBrowsers
- Tells MainBoss that the database should be opened in a mode that initially hides the details panel for records selected in table viewers.
- /AuthenticationType:type
- Specifies the type of authentication to be used with SQL Server when mbutility accesses the database. The type value must be one of the following strings:
WindowsAuthentication
SQLPassword
ActiveDirectoryPassword
ActiveDirectoryIntegrated
By default, mbutility uses Windows authentication, using your user name (i.e. the name of the person who invokes the mbutility command).
- /AuthenticationUsername:name
- Specifies a username that mbutility should use when accessing the database through SQL Server. This option must be specified if you wish to access the database under a different name than your own login name, or with an /AuthenticationType that requires some different user name.
- /AuthenticationPassword:password
- Specifies a password that mbutility should use when accessing the database through SQL Server. This must be specified if you wish to access the database under a different name than your own login name, or with an /AuthenticationType that requires a password.
- /OrganizationName:name
- The name that should be used in the user's organization list. This name is case-insensitive.
- /DataBaseServer:servername
- The name of the server where the database resides.
- /DataBaseName:name
- The actual name of the database that you want to add.
You must specify all three of /OrganizationName, /DataBaseServer and /DataBaseName.
- +AllUsers
- Adds the organization to the special AllUsers list rather than to the list associated with an individual user. Organizations in the AllUsers list are available to all users (although security roles still control what the user can or can't do with the database). The AllUsers list may be particularly helpful for ClickOnce users. Organizations may be deleted from the AllUsers list by using the DeleteOrganization verb. The current AllUsers list may be displayed with the ListOrganizations verb.
If both +AllUsers and +SetDefault are specified in the command line, the organization's database becomes the default for all users at your site. This may be surprising for users whose default is some other database, so you should think carefully before doing this. If a user's default database is different from the AllUsers default, the Pick Organization window will be opened the next time that user starts MainBoss, so that the user can see which database is now the default.
< Previous section | Table of Contents | Index | Next section >