Using FirstClass scripting
New in this release
• ACTIVATE
A new SECUREPASSWORDS option has been added with the following syntax:
Syntax: ACTIVATE SECUREPASSWORDS +FINAL
This feature implements secure passwords and permanently disables cleartext password retrieval.
 WarningThis process is irreversible.
- Added the keyword VERSION to the IF command to allow the ability to check the version of the running server.
- Added the ability populate a Resume for a group using the PUT command.
Syntax
PUT ABOUT <GroupName> <FieldID> <FieldType> <FieldValue>...
Example
PUT ABOUT "Web Services" 1000 14 1978 1001 0 "Testing 1-2-3"
About FirstClass scripting
FirstClass scripting is a component of FirstClass with which you can send scripted commands to the FirstClass server. It is important to note that while the server is processsing a script, mail delivery is suspended until the script is finished. You may want to process large scripts during off peak hours.
You can use FirstClass scripting to quickly:
• add individual users, user groups, and conferences
• generate lists of users and remote names
• update user information forms and user group membership.
Allowing access to FirstClass scripting
By default, only the administrator can send FirstClass scripts.
To allow other users to send scripts:
1 Double-click Multi-Site Setup on the administrator's Desktop.
2 Double-click Multi-Site Setup.
3 Select "Allow FirstClass scripting".
If you don't select this field, FirstClass rejects all FirstClass scripting messages unless they are from the administrator.
4 Enter the FirstClass scripting password you want others to use at "Password".
All users (except the administrator) who submit FirstClass scripting messages must enter the password. FirstClass rejects messages lacking a password.
 Note• Do not use the admin account password.
• Make sure you change the password regularly to prevent unauthorized access.
5 Click OK.
6 Inform all users to whom you want to delegate FirstClass scripting authority of the password you specified.
FirstClass scripting syntax
What you need to know about FirstClass scripting syntax:
• you must place fields that contain spaces in quotation marks
Quotation marks are optional for other fields.
• you can use either single or double quotation marks
Make sure, though, that your opening and closing quotation marks match.
• your script must include optional fields that precede those fields you want to use
This is necessary because fields are recognized by their relative positions.
You can leave these fields blank by inserting empty quotation marks.
• you can omit trailing fields, those fields that follow the fields you are using
• line length maximum is 500 characters
• all time is stored in seconds.
An hour has 3,600 seconds.
A day has 86,400 seconds.
Identifying the correct commands to use
To avoid confusion and ensure you use the correct commands, you need to understand the differences between the following terms:
• network users/telecom users
The term 'network users' in FirstClass script commands refers to regular users.
The term 'telecom users' refers to remote users.
These terms are used for compatability with older scripts.
• remote users/remote names.
The term 'remote user' refers to a user who can only connect to a FirstClass system through a remote session.
The term 'remote name' refers to the Directory entry for a user on another server.
Sending FirstClass scripts to the server
There are two ways to send FirstClass script to the server:
• send a message containing your script to Batch Admin
The FirstClass scripting component executes the script on receipt. Use this method for immediate changes that will not affect users currently logged into your FirstClass system.
• place a plain text file with a .ba extension and all necessary files, for example, myscript.ba, containing your script in the FCNS/Server/Batch folder.
Within Core Services, the Server Control form's Batch Folder button can be pressed to immediately process the contents of the Batch folder. The contents of the Batch folder is also processed at server start up.
Using FirstClass scripting to generate lists
Using FirstClass scripting, you can produce a list (for example, of all users on your system), then import that list into a database or spreadsheet program.
To generate and import a list into another program:
1 Generate the list using a FirstClass script.
Make the script generate a reply message that contains the list. An example of a script that generates a list of regular and remote users is:
reply
list +ux
2 Save the reply message as a text file by choosing File > Save As.
3 Remove the envelope information from this file using a text editor.
4 Import the text file into the database or spreadsheet application.
Using Example.fc to find form and icon IDs
When you install the FirstClass Designer, a settings file called Example.fc is also installed. This settings file contains all of the standard forms and can be used to look up form IDs and field IDs. You will need those IDs for the GET, NEW, and PUT commands. Example.fc also contains standard user forms, which can be customized.
Note
Never alter the template forms such as the User Information, System Profile, Group Privileges, Internet Services configuration, or Directory forms, without consulting Open Text.
Using Example.fc to look up a field ID
To look up a field ID:
1 Start FirstClass Designer and open Example.fc.
2 Open the form.
3 Choose Form > Show Field IDs.
The message fields have special IDs, therefore disregard the field IDs shown in FirstClass Designer. The "To" field is 4, "Cc" field is 5, and "Bcc" field is 14.
Using Example.fc to look up an icon ID
Settings files will automatically contain a list of all of the default icons, even if they are not shown in the icon range. To look up an icon ID:
1 Start FirstClass Designer and open Example.fc.
2 Select the Icon range.
3 Choose Forms > Icon List.
| 
