myAddons.com
Creating great RAD based add-ons to Centrinitys award winning FirstClass


Home
Our Policies
Purchasing
Support
Contact Us
Downloads
About Us
Applications
UserDetails
User Manual

14072003_42315_0.pngUserDetails
v1.0





Table of Contents
        [Setup]
        [Groups]
        [Labels]
        Multiple .ini Files


UserDetails License Agreement:
Distribution of this software: UserDetails is Shareware. You are hereby licensed to make any number of backup copies of this software and documentation. You can give the copy of the software to anyone or distribute the unlicenced version of the software providing that no additional fee is charged and the package files are not modified in any way.

Disclaimer of Warranty: This software and the accompanying files are supplied as is and without warranties as to performance or merchantability or any other warranties whether expressed or implied. Because of the various configuration options and purposes for which this tool may be used, no warranty of fitness for a particular purpose is offered. Any liability of the seller will be limited exclusively to product replacement.

Acceptance of Terms: Installing and using UserDetails means the acceptance of these terms and conditions of the license. If you do not agree with the terms of this license you must remove UserDetails files from your storage devices and cease to use the product.




July 2003



What Is UserDetails?
UserDetails is a RAD application. UserDetails allows you to create and edit user accounts, and and remove accounts from Privilege Groups (registered version only).


Requirements
UserDetails requires:
        -       FirstClass Server version 7.0 or higher
        -       RAD 2.50 Build 2352 or higher

FirstClass Server version 7.1 is recommended.


Installing UserDetails
Follow the steps outlined below to install UserDetails:
1.      Check the above requirements section to ensure you met them.
2.      Stop your FirstClass Server
3.      Run (double-click) on the UserDetails Setup.exe application program and follow the on-screen prompts.
4.      When prompted for the location to install the application, select the root of the volume containing the primary FirstClass Post Office folder (FCPO). \FCPO\ will automatically be appended to the installation path by the installer.
5.      When the installation process has completed, restart your FirstClass Server. Several batch files will be processed. A short-cut to the UserDetails application will be created in the FirstClass RAD\Built Applications folder, and this manual created in the Online Books area of the Online Help. Online help is also added to the Forms section of the Online Help.


Registering UserDetails
The unregistered version of UserDetails allows you to create and edit user accounts, but not change the Privilege Groups the account belongs to. The registered version will let you edit the Privilege Groups. A registration key can be purchased from www.myaddons.com.


Configuring UserDetails
Once installed, UserDetails can be customised. You might want to give some users access to more Privilege Groups than other users. You can also customise the application title. The Registration Key also gets added to the configuration (.ini) file.

When you installed Add2Group, a document called "UserDetails.ini" was created in the "FirstClass RAD\Settings Files" folder. By default, the "FirstClass RAD" folder is on the Admins Desktop.

The .ini file is separated into three sections - [Setup], [Groups] and [Labels]. If an .ini file cannot be found, the default value is used.

[Setup]
The following keywords are supported in the [Setup] section:
Keyword:                MembersOnly
Possible Values:        0 or 1
Default:                0
Description:    Controls the list of groups available for selection. If set to 0, then all the groups on the server will be available. If set to 1, only the groups that the person running the application is a member of will be available. This setting works in conjunction with the [Groups] section of the .ini file.

Keyword:                MaxBufferSize
Possible Values:        Any value
Default:                4096
Description:    The amount of memory to allocate to loading in the list of Privilege Groups on the server. The default should be enough for most sites. If you have a large number of Privilege Groups, or all your groups are not being displayed, try increasing the value.

Keyword:                Registration
Possible Values:        Valid Registration Key
Default:                0 (Unregistered)
Description:    Activates the application and enables the Privilege Groups.

Keyword:                LogLevel
Possible Values:        0 - 3
Default:                1
Description:    The level of detail to display on the Server Console:
0 = no logging
1 = Detail who has changed the group membership
2 = Level 1 + Detail who has run the application
3 = Level 2 + all individual additions/removals from a group

Keyword:                WriteToLogs
Possible Values:        0 or 1
Default:                0
Description:    If set to 1, the logging is also written to the Statics Log files; otherwise it is just written to the server console.

Keyword:                EditPassword
Possible Values:        0 or 1
Default:                0
Description:    If you want users to be able to view passwords on existing accounts, set EditPassword to 1. By default, passwords on existing accounts can not be viewed, or changed.

Keyword:                NoFind
Possible Values:        0 or 1
Default:                0
Description:    If you don't want users to be able to load existing accounts, set NoFind to 1. This will disable the Find icon next to the Userid field, and mean that only new accounts can be created.


[Groups]
The [Groups] section can be used to control the list of Privilege Groups the user has access to. Put the names of the groups you want to include and/or exclude under the [Groups] heading, one group to a line. A + in front of the group name means you want the group included, while a - means you want the group excluded e.g.
[Groups]
+WebMasters
-All Users

The above list would include the WebMasters group, but exclude the All Users group.

The Groups section works in conjunction with the MembersOnly setting above. If MembersOnly = 1 groups with a + sign in front of them will be added to the list of available groups, even if the user isn't a member of the group.


[Labels]
The following keywords are supported in the [Labels] section:
Keyword:                Title
Default:                UserDetails
Possible Values:        Anything
Description:    Changes the title window and application title displayed while running the application


Multiple .ini Files
Multiple .ini files can be created. This is particularly useful for giving different users access to different Privilege Groups to manage, or different features such as Find and Edit Password.

To specify a different .ini file to the default, you need to add a startup switch in the application stationary item that you use to launch the application.

Unprotect the stationary item and double-click on it to open it. In the "Application Name" field, you should see UserDetails. At the end of this, enter a space, followed by +I:"<.ini file name goes here>" e.g. if you've created a new document called "Jimmys Setup" UserDetails becomes UserDetails +I:"Jimmys Setup"

The document needs to be created in the "FirstClass RAD\Settings Files" folder.


Other Startup Switches
Several other features can be set with Startup switches.

To disable the Find icon, use the -NF switch.

To pass a Userid to the application, use the +U:"<userid goes here>" switch e.g. UserDetails -NF +U:"jimmy" would start the application with the Find option disabled and the user account details for userid Jimmy pre-loaded

 Last Modified: 8 December,2003