 |
Help Document |
|
 |
|
Batch Administration Overview
Batch administration is a process for transmitting scripted commands to the FirstClass Intranet Server. You can use batch administration to add large groups of users, conferences, or groups quickly.
An organization with a large user base will find that batch administration can streamline the administration of its system. If your user base changes constantly, invest some time in exploring the capability of batch administration. If you are beginning a new system, batch administration can quickly create all user groups and users.
How FirstClass uses batch administration
Batch administration provides a batch interface to FirstClass administration; that is, an interface in which commands are executed from a file, rather than from manual input.
The Directory synchronization feature uses batch administration to replicate user information among all the servers in a FirstClass network.
Setting up batch administration
To use the batch administration function, send a message containing your commands to "Batch Admin". The batch administration task executes the commands in the message.
You can also create a text file with the extension BA (for example, myfile.ba). Place the file in the FCPO\Server\Batch folder (Windows) or in the FirstClass Post Office: Server: Batch folder (Mac OS). The next time the server is started, the batch administration script will execute. After finishing, the text file is deleted from the folder.
Allowing others to use batch administration
By default, only the administrator can send batch administration requests.
To allow other users to execute batch administration commands, follow these steps:
1 On the administrator's Desktop, double-click the Multi-Site Setup folder.
2 In the Multi-Site Setup folder, double-click the Multi-Site Setup icon.
3 Select Allow Batch Administration to enable the batch administration feature. If you don't select this option, FirstClass rejects all batch administration messages unless they are from the administrator.
4 For Password, enter the batch administration password. All users (except the administrator) who submit batch administration messages must enter a password. FirstClass rejects messages lacking a password.
5 Close the form and save the changes.
6 Inform all users to whom you want to delegate batch administration authority of the password you specified.
Note
Make sure you define a password, and change it regularly, to prevent unauthorized access to the Directory. Do not use the admin account password.
Using batch administration
When you use batch administration, keep the following tips in mind:
• Many batch administration commands refer to "network users" and "telecom users". These terms are used for compatibility with older batch scripts. Network users are Regular users, telecom users are Remote users. Whether a user is Regular or Remote depends on the "Class" field of his user information form. It has nothing to do with how users connect.
• Many batch administration commands refer to "remote users" and "remote names". Be sure you understand the difference.
• A remote user is classified as such in the "Class" field on the user information form.
• A remote name is the Directory entry for a user on another server.
• Batch administration commands are not case-sensitive, except for the parameters for the LIST command and the NEW command that must be typed in lower case. Parameters that contain spaces must be enclosed in quotes (either single or double). A single command line cannot exceed 500 characters in length.
• You can omit trailing fields. For example, when you are adding a regular user, you can omit the <dept> to <PGn> fields. However, the batch administration task recognizes fields by their relative position. For example, in the ADD NETWORK command, <class> is followed by <userID> which is followed by <first>, and so on. If you want to use an optional field, like <phone1>, you must include all preceding optional fields, although you can leave them empty by typing two double quotation marks ("").
• You can use some batch administration commands to produce text files readable in FirstClass. Depending on session memory limits, however, you might not be able to read the list in FirstClass if your system is large. If the file is too large, you can save it as a text file and view it in a text editor application.
• All time is stored in seconds. Each hour has 3,600 seconds, and each day has 86,400 seconds.
Using batch administration to produce a database or spreadsheet list
Using batch administration, you can automate tasks that could otherwise be very time consuming. For example, you might want a list of all users on your system that you can import into a database or spreadsheet program.
You can generate such a list using the commands described in Setting up batch administration. For details about other commands, see the individual Batch administration commands, then follow this procedure:
1 Save this message as a text file by choosing File > Save As.
2 In a text editor application, remove the envelope information.
3 Import the text file into a 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 the standard forms and can be used to look up form IDs and field IDs. You will need those IDs to get or put information from and into those fields and forms. Example.fc also contains standard user forms, which can be customized. You should never alter the template forms such as the User Information, system profile, user group, Internet Services configuration, or Directory forms without consulting Centrinity.
Using Example.fc to look up a field ID
To look up a field ID, follow these steps:
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 you should 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 the default icons, even if they are not shown in the icon range. To look up an icon ID, follow these steps:
1 Open a settings file with FirstClass Designer.
2 Select the Icon range.
3 Choose Forms > Icon List.
Batch administration commands
The following lists provide information on all the commands you can use.
ADD NETWORK/ADD TELECOM
ADD REMOTE
ADD ROUTE
AN
CHGALIAS
COPYFLD
DEL
DELALL
DELFLD
DN
EXIT
GET
GETADMIN
LINK PATH
LINK USER
LIST
NEW
NEW desktop
PATHCHAR
PGADD
PGDEL
PUT
PUT user
PUT path
PUT properties
PUT sysprofile
PUT desktop
PUT preferences
PUT resume
PUT search
PW
REMANE
RENAME desktop
REMOVE
REPLY
SNAPSHOT
WRITE
Batch administration commands by function
Managing user accounts
Create regular user - ADD NETWORK
DEL
LIST
PGADD
PGDEL
REPLY
Creating new conferences, folders, gateways, groups, stationery, public chats, or mail lists:
CHALIAS
LINK PATH
NEW
NEW desktop
REMOVE
RENAME
REPLY
Adding, changing, or extracting information at the field levels of forms:
GET
PUT
REPLY
Batch administration script samples
Batch administration scripts can be combined to reduce much of the repetitive nature of administering a large FirstClass system
Script samples for creating users on different volumes
This example shows how to alter the Create user and conferences on this volume field.
// Change the Create user and conferences on this volume field
// to the second volume in the list
PUT sysprofile 1224 7 2
// Add a regular user with user ID PChu, first name Paul, initial
// C, and last name Chu
ADD network PChu Paul C Chu
// Change the Create user and conferences on this volume field
// to the first volume in the list
PUT sysprofile 1224 7 1
// Add a regular user with user ID Sbram, first name Sue, no
// initial, and last nam Bram
ADD network Sbram Sue "" Bram
Script samples for creating a course structure
This script creates a user group, conferences, folders, a private chat, and displays a tiled background picture that opens icons with a single click.
REPLY
// Creates the protected user group MTH101 Users in the
// Groups folder with the standard user group icon in the next
// available position
NEW "Groups" "MTH101 Users" "" formdoc 23003 -1 -1 124 +p
// Creates a new protected private conference called MTH101
// in the Private Conferences folder with the standard icon and
// in a specified location
NEW "Private Conferences" "MTH101" "" Conference 8 337 15 +p
// Creates a new protected private conference with the
// standard icon and in a specific position within MTH101
NEW "Private Conferences:MTH101" "MTH101 Instructor" "" Conference 8 41 15 +p
// Creates three new unprotected folders FAQ’s, WWW Links,
//and Curriculum, with the standard icon and in a specific
// position within MTH101
NEW "Private Conferences:MTH101" "FAQ's" "" Folder 23000 41 65
NEW "Private Conferences:MTH101" "WWW Links" "" Folder 23000 112 65
NEW "Private Conferences:MTH101" "Curriculum" "" Folder 23000 194 65
// Creates an unprotected public chat called Student Lounge
// within MTH101 with the standard icon and in a specified
// postion
NEW "Private Conferences:MTH101" "Student Lounge" "" Chat 150 41 115
// Adds the MTH101 Instructor conference to an existing
// conference group called Instructor Mail Confs
PGADD "MTH101 Instructor" "Instructor Mail Confs
// Sets the view properties of MTH101 to display a
// background picture called cross.jpg
PUT PATH "Private Conferences:MTH101" 13083 0 cross.jpg
// Sets the view properties fo MTH101 to have icons open with
// a single click
PUT PATH "Private Conferences:MTH101" 13082 6 86
Script samples for creating user address books
If you are migrating to FirstClass, you can use this script to recreate address books. These commands create the Address Book folder, create a private address book, and then put data into the form.
// Creates a new address book folder with the standard icon on
// Sue Bram’s (user ID sbram) Desktop
NEW desktop sbram "" "Address Book" "" Folder 23004 -1 -1
// Creates a new protected addresss book form, my addresses,
// with the standard icon within the folder
NEW desktop sbram "address book" "my addresses" "" formdoc 23004 -1 -1 105 +p
// Adds the telephone number 905-555-0181 to the address
// book my addresses
PUT desktop sbram "address book:my addresses" 1007 0 "9055550181"
// Adds an Internet address sl@abc.com to the address book
// my addresses
PUT desktop sbram "address book:my addresses" 4 0 "sl@abc.com"
Script samples for setting user preferences
This script sets the Reply preferences field to Reply to sender, enables automatic use of the signature, and adds information to the Signature field.
// Sets the reply preference of Sue Bram (user ID sbram) to
// Reply to sender
PUT preferences sbram 1107 7 2
// Enables the Automatically add signature to new messages
// field on the preferences form for sbram
PUT preferences sbram 1108 6 1
// Adds the signature
// ABC Corporation
// 123 Main Street
// Toronto
// www.abccorp.com
// the \r forces a line break
PUT preferences sbram 1109 0 "ABC Corporation\r123 Main Street\rToronto\rwww.abccorp.com
Script samples for making changes to your entire user base
If you want to set the Reply Preference field to Reply to Sender for every user on your system. The first step is to create a list of users:
REPLY
LIST +ul
Save the message and import it into a spreadsheet program. Discard everything, but the user ID column. Change the information to reflect the syntax of the PUT preferences command.
PUT preferences <userid> 1107 7 2
ADD NETWORK/ADD TELECOM
Adds a regular (network) user/ Adds a remote user
Syntax
ADD NETWORK <userID> <first> <i> <last> <dept> <pw> <postaddr> <phone1> <phone2> <PG#> <PG1>...<PGn>
Note
If you want to add a remote user, type ADD TELECOM instead of ADD NETWORK.
Parameters
<userID> The user ID (maximum 15 characters)
<first> Optional, unless <i> is also completed. The first name (maximum 23 characters).
<i> Optional. The initials (maximum 3, no periods).
<last> The last name (maximum 23 characters).
<dept> Not used.
<pw> The password (maximum 12 characters).
<postaddr> Optional. The postal address (maximum 249 characters). Use \r to enter a carriage return.
<phone1> Optional. The phone number (maximum 79 characters).
<phone2> Optional. The fax number (maximum 79 characters).
<PG#> The number of user groups to follow.
<PG1>...<PGn> The user groups to add user to (maximum 23 characters each).
Example
To add network user Paul Chu, with user ID “PCHU” and password “broccoli”, and to put him into the Employees and Contractors user groups, you would enter:
ADD NETWORK PCHU Paul C Chu "" broccoli "123 Main St.\rToronto" "" "" 2 Employees Contractors
Note
If you use the ADD command, and make a mistake in any of the parameters after the <dept> parameter (for example, if you spell the user group name incorrectly), FCIS still adds an account for that user. To correct this, delete the account, unsend the message, correct the error, and resend. Or, you can correct the information on the User Information form.
ADD REMOTE
Adds a remote name
Syntax
ADD REMOTE <first> <i> <last> <dept> <sitename> <clientID> <gateway>
Parameters
<first> Optional, unless <i> is also completed). The first name (maximum 23 characters).
<i> Optional. The initials (maximum 3, no periods).
<last> The last name (maximum 23 characters).
<dept> Not used.
<sitename> The name of site where user is registered. (The site must have been defined as a route or gateway. Always add routes and gateways before remote names.)
<clientID> The unique ID for the user. Use this field to distinguish between identical names.
<gateway> The gateway through which to route mail for this user.
Example
To add remote user Allen Smith, who is registered on the Husky Planes Los Angeles server, and whose mail is routed through Husky Planes Boston, you would enter:
ADD REMOTE Allen "" Smith "" "Husky Planes Los Angeles" 1234 "Husky Planes Boston"
ADD ROUTE
Adds a route to a remote server.
Syntax
ADD ROUTE <name> <siteID> <cost> <gateway>
Parameters
<name> The site name of remote server.
<siteID> The serial number of remote server.
<cost> The cost (typically 50 per hop).
<gateway> The gateway to which messages for this server will be delivered.
Example
To define a route for Husky Planes Los Angeles, whose messages are routed through Husky Planes Boston, you would enter:
ADD ROUTE "Husky Planes Los Angeles" 1001030 100 "Husky Planes Boston"
AN
Adds a remote name to your server.
This command is used only by the Directory synchronization process. If you are a developer and require more information, refer to the FirstClass Gateway Toolkit Developer's Manual.
CHGALIAS
Changes the internet alias for a server, conference, gateway, or route.
Syntax
CHGALIAS <name> <alias>
Parameters
<name> The name of the directory entry. It can be a registered user, conference, remote name, gateway, or route. If a unique name is not provided, the first matching name is used.
<alias> One or more internet aliases separated by commas. For gateways and routes, this is the domain name.
Example
To change Roy Allen (default alias Roy_Allen) to rallen, use the following command:
CHGALIAS “Roy Allen” rallen
To change the mail alias of a conference, use the following command:
CHGALIAS "Husky Planes Sales" sales
COPYFLD
Copies the contents of one field to another form where source fieldid and destination fieldid are the same.
Syntax
COPYFIELD <source objdesc> <fieldid> <dest objdesc>
Parameters
<source objdesc> The source of where the form is located.
PATH<path>A form specified by a path relative to the administrators Desktop. If <source objdesc> is missing PATH is assumed.
DESKTOP <userid> The location of the form relative to the user’s Desktop.
SYSPROFILE The System Profile
USER <userid> The User Information form
DIRECTORY <name> The directory form of gateways, conferences, remote names, and user groups.
<fieldid> Numeric number of field, as assigned by the FirstClass Designer.
<dest objdesc> The destination form. Uses the same set of parameters as <source objdesc>.
Example
To copy the address field from one User Information form to another you would type:
COPYFLD user SBRABM 1205 user RALLEN
DEL
Deletes a user registered on your server.
Syntax
DEL <userID>
Parameters
<userID> The user ID assigned to the user (maximun 15 character).
Example
To delete user Paul Chu, you would enter:
DEL PCHU
DELALL
Deletes all routes or remote names from your Directory, or deletes all the routes or remote names at a selected site. After using this command, you should resynchronize Directories with the remote site to add all current remote names and routes.
Syntax
DELALL <class> <siteID>
Parameters
<class> REMOTE or ROUTE.
<siteID> The site ID, or 0 (zero) for all sites. If you specify a site when deleting remote names, you delete all names originating from that site. If you specify a site when deleting routes, you delete all routes received from that site.
(There is also a +t parameter used with the DELALL command, used only by the Directory synchronization process. If you are a developer and require more information, refer to the FirstClass Gateway Toolkit Developer’s Manual.)
Example
To delete all remote names for users registered at Husky Planes Boston (Site ID 1019026), you would enter:
DELALL REMOTE 1019026
DELFLD
Deletes information at the field level of forms.
Parameters
<objdesc> Describes the target
Syntax
DELFLD <objdesc> <fieldid>
PATH<path>A form specified by a path relative to the administrator’s Desktop. If <source objdesc> is missing PATH is assumed.
DESKTOP <userid> <path>The location of the form relative to the user’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
SYSPROFILE The System Profile
USER <userid> The User Information form
DIRECTORY <name> The directory form of gateways, conferences, remote names, and user groups.
PERMISSIONS <path> The Conference Permission form of a conference or calendar.
<fieldid> Numeric ID of a field, as assigned by the FirstClass Designer.
The syntax for the DELFLD command when used to delete an address field is as follows:
DELFLD <objdesc> <addressid> <index> <address>
<addressid> To field is 4, cc: field is 5, bcc is 14. The Who, Acces, and Permissions field on the Conference Permission form is 29. Disregard the field IDs displayed in the FirstClass Designer.
<index> Position to insert in the list. Use 0 for the first name, 1 for the second name and so on.
<address> The name of the directory entry. It can be a registered user, e-mail address, conference, remote name, gateway, or route. If a unique name is not provided, the first matching name is used.
Example
To delete the mail alias from the User Information form, enter:
DELFLD user sbram 1252
To delete the sixth entry from a mail list, enter:
DELFLD path “Mail Lists:London”4 5 “Roy Allen”
The 4 in the command represents the To: field. The 5 represents the sixth entry in the mail list.
To delete the first entry in a Conference Permissions form, enter:
DELFLD permissions "private conferences:secret project" 29 0
DN
Deletes a remote name registered on your server.
This command is used only by the Directory synchronization process. If you are a developer and require more information, refer to the FirstClass Gateway Toolkit Developer’s Manual.
EXIT
This command stops the server from processing any further information. It is used when submitting commands with a POP3 client.
Syntax
EXIT
EXPORT
Generates a cross-platform batch administration import script that creates objects supported by the NEW command. The import script can include contents and view properties.
Permissions or group memberships are not included in the script.
Scripts sent through the Internet gateway may word wrapped if the Line length field on the Internet Services > Advanced Mail > Outbound tab is not configured properly.
Syntax
EXPORT <path> <name> +r -cl
Parameters
PATH <path> Target path is relative to the administrator's Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
Desktop <userid> <path> Target path is relative to the user's Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
<name> Optional. The directory name of the user or conference. The script is returned to the sender if the name parameter is not included.
+r recursive
-c excludes content
-l excludes view properties
Options
The Sales Course conference is located in the Private Conference folder. The Sales Course conference contains messages, documents, and uploaded files. The conference also houses a folder, a conference, and a calendar. If the following command was submitted:
EXPORT "Private Conferences:Sales Course" administrator
The server would return a script addressed to the administrator that would create the messages, documents, and uploaded files in the Sales Course conference. The script would also contain the view properties of the Sales Course conference.
The script would not recreate the folder, conference, or calendar or their contents.
If the following command was submitted:
EXPORT "Private Conferences:Sales Course" administrator +r
The server would return a script addressed to the administrator that would create the conference, the folder, and the calendar. All conference, folder, and calendar items would be included in the script. The script would include the view properties of the Sales Course conference, the conference, the folder, and the calendar.
If the following command was submitted:
EXPORT "Private Conferences:Sales Course" administrator +r -c
The server would return a script addressed to the administrator that would create the conference, the folder, and the calendar. The script would include the view properties of the conference, the folder, and the calendar.
The script would not recreate any messages, documents, or uploaded files within the conference, folder, or calendar items.
If the following command was submitted:
EXPORT "Private Conferences:Sales Course" administrator +r -l
The server would return a script addressed to the administrator that would create the conference, the folder, and the calendar. All conference, folder, and calendar items would be included in the script. The script would recreate any of the conference, folder, or calendar items.
The script would not contain the view properties of the Sales Course conference, the folder, conference, or the calendar.
To use the EXPORT command, follow these steps:
1 Send a message addresses to Batch Admin containing a valid EXPORT command.
2 Once the server generates the script, forward the message and address it to Batch admin.
3 Replace the <ObjDesc> with the destination path.
Note
The destination folder, conference, or calendar must exist. It can be created manually or with the NEW command.
4 Send the message.
Conferences, calendars, gateways, groups, and mail lists require a unique name. When exporting these items adjust the script to indicate a unique name.
The following is the portion on the script that creates the Presentations conference within the Sales Course conference:
SetRelative FromBase ""
New Relative "" "Presentations" "" Conference -8 595 200
SetRelative FromBase "Presentations"
To create a conference called Spring 01 Presentations, adjust the script to read as follows.
SetRelative FromBase ""
New Relative "" "Spring 01 Presentations" "" Conference -8 595 200
SetRelative FromBase "Spring 01 Presentations"
Chats, folders, messages, documents, uploaded files, stationery, calendar tasks, calendar events do not require unique names, and therefore no adjustments are necessary.
The messages, calendar events, and calendar tasks created by the EXPORT command are originals and do not include any history information. The EXPORT command also creates copies of the documents and uploaded items, but neither of these items record history.
Annotated script
The following command was submitted:
export "private conferences:sales course" admin +r
The server returned the following import script:
\\ <ObjDesc> is replaced with the destination path. Subsequent commands containing Relative refer to this path.
SetBase <ObjDesc>
SetRelative FromBase ""
\\ Sets the size, location, and split value of the conference or folder.
Put Relative "" 901 108 902 224 903 583 904 935
Put Relative "" 1101 7 0 900 0
\\ Sets view properties of the conference or folder.
Put Relative "" 13074 7 0 13065 14 -2147483646 13075 7 8
Put Relative "" 13015 0 "" 13016 7 0
Put Relative "" 13003 7 24
Put Relative "" 13082 7 48 13083 0 ""
Put Relative "" 13084 7 0
\\ Creates a new conference.
SetRelative FromBase ""
New Relative "" "Presentation" "" Conference -8 595 200
SetRelative FromBase "Presentation"
\\ Sets the size, location, and split value of the Presentation conference.
Put Relative "" 901 0 902 0 903 0 904 0
Put Relative "" 1101 7 0 900 0
SetRelative FromBase ""
\\ Creates a new folder
SetRelative FromBase ""
New Relative "" "Archived Messages" "" Folder 26093 339 221 0
SetRelative FromBase "Archived Messages"
\\ Sets the size, location, and split value of the folder
Put Relative "" 901 0 902 0 903 0 904 0
Put Relative "" 1101 7 0 900 0
SetRelative FromBase ""
\\ Creates copy of the "Welcome to the course" message.
New Relative "" "Administrator" "Welcome to the course" ConfItem 23032 30 15 -U
Put Previous 8120 7 1252 8140 0 8141 0
Put Previous 9 "Welcome to the course"
Put Previous 8 "Administrator"
Put Previous 4 0 "Sales Course"
\\ Creates copy of the "Course Objectives" document.
New Relative "" "Course Objectives" "" Document 17044 339 221 -U
Put Previous 8120 7 1252 8140 0 8141 0
Put Previous 9 ""
\\ Creates copy of the "training.fm" file.
New Relative "" "training.fm" "Uploaded File" FCF 17044 194 15-U
Upload Previous "Attach1"
SetRelative FromBase ""
Examples
To export the contents of Sbram's Address Book folder to Jallen's Address Book folder to the administrator's Mailbox, submit the following command:
EXPORT desktop sbram "address book" admin
When the server returns the script, adjust the <ObjDesc> to the following:
Desktop jallen "address book"
To export preconfigured voice greetings from Sbram Voice Greetings folder to Jallen's existing Voice Greetings folder, submit the following command:
EXPORT desktop sbram "voice greetings" admin
When the server returns the script, adjust <ObjDesc> to the following:
Desktop jallen "voice greetings"
To export the contents of the Internet Services > WWW > .templates folder to the existing Internet Services > WWW > huskyplanes > .templates folder, submit the following command:
EXPORT "internet services:www:.templates" administrator
When the server returns the script, adjust <ObjDesc> to the following:
"internet services:www:huskyplanes:.templates"
To export a single document with the .templates folder, submit the following command:
"internet services:www:huskyplanes:.templates:141"
GET
Extracts data from FirstClass objects at the field level. GET returns a single line of field triplets, one triplet per field ID requested, in a format that matches the PUT command <fieldlist>. The REPLY command must precede the GET. For additional information see the PUT command.
Syntax
GET <objdesc> <fieldids> <+d> <+D>
Parameters
<objdesc> describes the target
USER <userid> User Information form (UserData in Example.fc) of <userid> and the Directory form of conferences (ODInfo), folders (ODInfo), gateways (ODGateway), remote names (odRemote), routes (odRoute) and user groups (ODInfo).
PATH <path> A form, message or document specified by path, relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
PROPERTIES PATH <path> Used to change the Get Info form for Mac OS or Properties form for Windows. The path is relative to the administrator's Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
PROPERTIES DESKTOP <user ID> <path> Used to change the Get Info form for Mac OS or Properties form for Windows. The path is relative to the user's Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
SYSPROFILE -The System Profile
<fieldids> Numeric field IDs of the fields to be retrieved as assigned by FirstClass Designer. For information about how to look up field IDs see “Using Example.fc to find form and field IDs."
<+d> <+D> Optional. +d will return the time as formatted in the client. +D will return the time formatted to system default. These parameters can be used with Created (field ID 1235) and Last logged in (field ID 1230) fields on the User Information form.
The syntax for the GET command when used to retrieve address fields is as follows:
GET <objdesc> <addressid> <index>
<addressid> To field is 4, Cc field is 5, Bcc is 14. Do not use the field ID displayed in FirstClass Designer.
<index> Position in the list. Use 0 for the first name, 1 for the second name as so on. Use -1 to retrieve all address entries.
To create GET and PUT commands you need to know the field ID of the field you want to work with. The PUT commands also require a field type and field value, in addition to the field ID. To obtain the field type and field value, follow these steps.
1 Alter the form to reflect the desired result of the command.
For example, if you want to change the class of a user from
Regular to Remote then set a test user to Remote, you
would enter:
Reply
GET USER pchu 1223
The server would return the following information:
1223 7 5
2 Use the GET command to generate the field type and field value. Use this data to construct your PUT command. For example to change a user from a Regular user to a Remote user, enter:
PUT USER sbram 1223 7 5
Example
To get the user's user ID, first name, middle initial and last name fields, enter:
REPLY
GET user dmichaels 1201 1202 1203 1204
The server returns the following information:
1201 0 "dmichaels" 1202 0 "David" 1203 0 "E" 1204 0 "Michaels"
Asking for the user ID to be included in the reply message will allow you to work with data to update the User Information form.
Only the main admin account can retrieve data from the password field (field ID 1217). To retrieve David’s password, enter:
REPLY
GET user dmicheals 1217
The server returns the following information:
1217 0 "f1504x2"
If you want to know what groups members of a user group can see in their directory, you need to retrieve the Restrict view to these groups field. This field is a Bcc field therefore the field ID is 5 and no field type is required. To retrieve all entries, you would enter:
REPLY
GET "Groups:Staff" 5 -1
The server will return the following information:
5 0 Customer
5 1 All Conferences
To retrieve only the first entry, enter:
REPLY
GET "Groups:Staff" 5 -1
If you want to know which groups a user is a member of, you need to retrieve data from the User groups field. This field is a To field, therefore the field ID is 4 and no field type is required.
REPLY
GET USER sbram 4 -1
The server will return the following information:
4 0 "Remote Users"
4 1 "Students"
4 2 "Customer"
Field Name Field ID
User ID 1201
First Name 1202
Initial 1203
Last Name 1204
Password 1217
Mail alias 1252
Tel 1206
Fax 1207
Address 1205
Comments 1224
Section inactivity 1222
limit
Disk space limit 1257
Maximum number of
multimatch names 1219
Voice DN 1255
Voice password 1256
Example
To have the server return the conference name and conference location, enter the following:
REPLY
GET USER "Customer Support" 1204 1236
The server returns the following information:
1204 0 "Customer Support" 1236 0 "[D:\] admin/Private Conferences/"
This command is also useful if the Directory form does not have room to display the full path. Asking for the conference name to be returned will allow you to use the location information in the RENAME command. To obtain a list of all your conferences, follow these steps:
1 Choose Admin> List Directory, and select Conferences, then Search. Note that only the first 20 characters of the conference name will display.
2 Choose File> Save As.
3 Import the text file into a speadsheet program and change the data into PUT user command.
4 Use Paste Special to copy text into a FirstClass message.
The above method can be used to generate a list of any items the Admin > List Directory command displays. For example, you could generate a list of all users belonging to a user group.
To get a gateway serial number, follow these steps:
REPLY
GET path "Gateways:RockFish" 1102
The server returns the following information:
1102 0 "76000203"
To get the contents of the Create users and conference on this volume field enter:
REPLY
GET sysprofile 1224
The server returns the following information:
1224 7 2
GETADMIN
Finds the user ID of the person who is the main administrator of a system. You may find this command useful if you use automated administration software to keep FCIS synchronized with other server software. Use this command in conjunction with the REPLY command.
Syntax
GETADMIN
Example
To find the user ID of the main administrator, and to view the output as a message in FCIS, you would enter:
REPLY
GETADMIN
LINK PATH
Makes an alias of a conference or folder and place it in another conference or folder.
Syntax
LINK PATH <path> <link path>
Parameters
<path> The desired location of the new alias, relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
<link path> The location of the existing object, relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
Example
To make an alias for the Existing Policies conference located in the Private Conferences folder, and place an alias in a conference called New Information, also located in the Private Conferences folder, enter:
LINK PATH "Private Conferences:New Information" "Private Conferences:Existing Policies"
LINK USER
Makes an alias of a conference or folder and place it on a user’s Desktop. The user’s name is added to the subscription section of the Conference Permission form.
Syntax
LINK USER <userID> <link path>
Parameters
<userID> The user ID of the user to whom you want to give the alias.
<link path> The location of the existing object, relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
Example
To make an alias for a conference called Read These First!, and to place the alias on Paul’s Desktop, you would enter:
LINK USER pchu "Private Conferences:Customer Support:Read These First!"
LIST
Generates a list of users or remote names. The output file is in batch administration format. By saving the message, you can import it into a database application, spreadsheet application, or into the Directory of another FirstClass Intranet Server. Once you have a list of user IDs, you can import the information into a spreadsheet and create additional commands, such as GET, PUT, LINK USER, and CHGALIAS. The LIST command must be preceded by a REPLY command, and the parameters must be typed in lower case. Passwords are exported as blanks (""). To export a list of passwords see the GET command.
Syntax for user accounts
LIST +uraxl
Syntax for other directory entries
LIST +cgoz
Parameters
+u Exports all regular and remote users. The entries in the output file are in ADD NETWORK or ADD TELECOM command format, including all parameters up to <dept>.
+r Exports all remote names. The entries in the output file are in ADD REMOTE command format, excluding the <gateway> field. (This field would not be meaningful on a remote system.)
+a Exports all regular users, remote users, and remote names. The entries in the output file are in ADD REMOTE command format, excluding the <gateway> field. (This field would not be meaningful on a remote system.)
+x Includes extended information for users (the <pw> to <PGn> parameters). Valid only in conjunction with the +u parameter.
+l Returns a list of user ID, first names, initials, and last name without the ADD command. Valid only in conjunction with the +u parameter.
+c Returns a list of conferences.
+g Returns a list of user groups, conference groups, and calendar groups.
+o Returns a list of resource calendars, location calendars, group calendars, and gateways.
+z Returns a list of all users, conferences, user groups, conference groups, calendar groups, calendars, mail lists, and gateways.
Example
To produce and export a list of all users and the extended information, you would enter:
Reply
LIST +ux
To produce a list of conferences, you would enter:
Reply
LIST +c
NEW
Creates a new object such as a conference, folder, group, gateway, calendar, monitor, stationery, chat, message, or document. The EXPORT command will automatically generate the scripts necessary to create new objects.
Syntax
NEW <path> <name> <subj> <objtype> <icon> <h> <v> <formid> +p
Syntax for creating a conference, unprotected folder, or upload file
The syntax for creating a conference or unprotected folder does not include the <formid> parameter.
NEW <path> <name> <subj> <objtype> <icon> <h> <v> +p
Syntax for creating a calendar
The syntax for creating a calendar must include the <type> parameter.
NEW <path> <name> <subj> <objtype> <icon> <h> <v> <formid> <type> +p
Parameters
<path> The location of the new object, relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
DESKTOP <userid> <path> Creates an ohject on a user's Desktop. The path is relative to the user's Desktop.
<name> The name of the new object.
<subj> The content of the Subject field.
<objtype> FOLDER, CONFERENCE, FOLDER, FORMDOC, OFORM, PERMS, TEMPS, SYSINFO.
<icon> The ID of the icon.
<h> The horizontal pixel position for the new object relative to the top left corner of the administrator’s desktop. To place the object automatically, enter -1.
<v> The vertical pixel position for the new object relative to the top left corner of the administrator’s Desktop. To place the object automatically, enter -1.
<formid> The ID of the form. All standard forms are contained in the Example.fc file. For a user-defined form, open the settings file with FirstClass Designer and look up the form ID.
+p Optional. Protects the object. The parameter must be typed in lower case
Chat
To create a chat file, use the object type CHAT. The icon number is 150 and the form ID is 129.
Example
To create a chat file inside a conference, enter
NEW "Private Conferences:Staff Lounge" "Water Cooler" "" CHAT 150 -1 -1 129
Conference
Conferences do not require the form ID field. The conference objtype is also used to create calendars, however the type field must be included.
Example
To create a new protected conference called Staff Lounge with the standard conference icon, in the Private Conferences folder, enter:
NEW "Private Conferences" "Staff Lounge" "Employee conference" CONFERENCE 8 41 15 +p
To create a protected group calendar named Staff Events, without a subject, and with the standard icon 24011, in the Private Conferences folder, enter:
NEW "Private Conferences" "Staff Events" "" CONFERENCE 24011 41 15 21 +p
The type for a resource calendar is 22 and the icon ID is 24013.
The type for a location calendar is 23 and the icon ID is 24014.
Note
If you cannot decide where to place a new conference or folder on the Desktop, type -1 for each of the <h> and <v> parameters. This instructs FCIS to place the conference according to the last known conference creation.
FCF
The FCF objtype is used to upload a file to a FirstClass folder or conference. Both the NEW command and the UPLOAD command are required. You also need to attach the file to the message that contains the batch administration command. The form ID parameter is not required.
Example
Upload the staff settings.fc file to your message, and enter the following to create an uploaded a file:
NEW "private conferences:new settings files" "staff settings.fc" "" FCF 17044-1 -1
UPLOAD "private conferences:new settings files:staff settings.fc" "staff settings.fc"
Folder
The form ID is not required when you create an unprotected folder. The form ID 0 is required if you want to create a protected folder. You cannot drag items into a protected folder, therefore most folders are created unprotected.
Example
To create a new unprotected folder called Archived Messages in the Staff Lounge conference, with the standard icon, enter:
NEW "Private Conferences:Staff Lounge" "Archived Messages" "" Folder 26093 41 15
To create a new protected folder, enter:
NEW "Private Conferences:Staff Lounge" "Archived Messages" "" Folder 26093 41 15 0 +p
To create a new protected conference, called "Presentations" on a user's Desktop, enter:
NEW desktop sbram "" "Presentations" "Personal Conference" CONFERENCE 13107 41 65 +p
Note
If you can’t decide where to place a new conference or folder on the Desktop, type -1 for each of the <h> and <v> parameters. This instructs FCIS to place the conference according to the last known conference creation.
Formdoc
The objects listed below are created with the FORMDOC objtype. The default icon number is listed, but any icon number can be used. Once the form is created the PUT command can be used to fill in the fields. The EXPORT command is also useful if you are recreating objects.
Object name (Designer Icon number Form ID
description, if different)
Address book (New
Address Book) 23014 105
Calendar group (New
Calendar Group) 24015 65
Conference group (New
Conference Group) 23015 88
Calendar event (New
Calendar Event) 23034 161
Calendar event (New
Calendar Event) 23035 163
Gateway settings 23001 126
Mail list 23005 118
User group (Privilege group) 23003 124
Example
To create a new user group called Executive Users, enter:
NEW "Groups" "Executive Users" "" formdoc 23003 -1 -1 123 +p
Note: If you can't decide where to place a new conference or folder, type -1 for each of the <h> and <v> parameters. This instructs the server to place the folder according to the last known position.
To create a new address book in an existing Address Book folder called "Paul", enter:
NEW desktop sbram "Address Book" "Paul" "" formdoc 23004 -1 -1 105
The PUT command can be used to fill in the fields of the Address Book. The EXPORT command can help you construct the script.
Perms
Objtype PERMS can be used to create a new stationery form. The form must be available in the Admin > Add New Stationery menu. The default icon number is listed, but any icon number can be used. Once the form is created the PUT command can be used to fill in the fields on the stationery form. The EXPORT command is also useful if you are recreating objects.
Object name (Designer Icon number Form ID
description, if different)
Alternate message 23032 134
Announcement 7014 300
Ballot 9136 142
Course registration 7014 304
Document 17044 96
Equipment booking 7014 305
File transfer 2003 131
Graduation request 7014 306
Image message 23032 136
Lesson planner 7014 301
Memo 23032 146
Monthly calendar (Calendar) 7014 302
Phone call 2024 128
Project estimate 7004 148
Quick message 23032 132
Quick note 23032 152
Request for information 2408 133
Requisition form 24016 135
Room booking 7014 307
While you were out 2024 154
To add a user-defined stationery, whose form ID is 1001, you would enter:
NEW "Private Conferences:Staff Lounge" "Suggestions" "Submit your ideas" PERMS 17044 -1 -1 1001 +p
To create a new phone call stationery on the user's Desktop, enter:
NEW desktop sbram "" "Message for Roy" "" PERMS 2024 123 65 128 +p
Once the form is created the PUT command can be used to fill in the fields on the stationery form. The EXPORT command can help you construct the script.
Sysinfo
To create the Session monitor use the objtyp SYSINFO, the icon number is 23007, no form ID is required. The object must be protected in order to function.
Example
NEW "FirstClass Services" "Session Monitor" "" SysInfo 23007 -1 -1 +p
Temps
The objects listed below are created with the TEMPS objtype. These objects must be protected in order to function.
Object name (Designer Icon number Form ID
description, if different)
Server monitor 23007 7900
Internet monitor 23007 8900
Example
NEW "FirstClass Services" "Server Monitor" "" Temps 23007 -1 -1 7900 +p
NEW "Internet Services" "Internet Monitor" "" Temps 23007 244 19 8900 +p
NEW desktop
Creates an object relative to the user’s Desktop.
Syntax
NEW desktop <userid> <target path> <name> <subj> <objtype> <icon> <h> <v> <formid> +p
Parameters
<userid>The userid of the user where you want create the new object.
<target path> The location of the new object relative to the users’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
<name> The name of the new object.
<subj> The content of the Subject field.
<objtype> FOLDER, CONFERENCE, FORMDOC, PERMS, TEMPS, OFORM, SYSINFO. See the NEW command for more information on each objtype.
<icon> The ID of the icon.
<h> The horizontal pixel position for the new object relative to the top left corner of the administrator’s Desktop. To place the object automatically, enter -1.
<v> The vertical pixel position for the new object relative to the top left corner of the administrator’s Desktop. To place the object automatically, enter -1.
<formid> The ID of the form. All standard forms are contained in the Example.fc file. For a user-defined form, open the settings file with FirstClass Designer and look up the form ID.
+p Optional. Protects the object. The parameter must be typed in lower case.
Example
To create a new protected conference, called “Presentations” on a user’s Desktop, enter:
NEW desktop sbram "" "Presentations" "Personal Conference" CONFERENCE 13107 41 65 +p
Note
If you cannot decide where to place a new conference or folder on the Desktop, type -1 for each of the <h> and <v> parameters. This instructs FCIS to place the conference according to the last known conference creation.
To create a new address book in an existing Address Book folder called "Paul", enter:
NEW desktop sbram "Address Book" "Paul" "" formdoc 23004 -1 -1 105
To create a new phone call stationery on the user’s Desktop, enter:
NEW desktop sbram "" "Message for Roy" "" PERMS 2024 123 65 128 +p
PATHCHAR
Changes the default path separator command when specifying objects using a path name. By default this character is ":" but can be changed to another character (for example "/") to specify targets containing colons. The setting persists until the end of the current batch administration script.
Syntax
PATHCHAR <char>
Example
To set the separator character and use it in a command, enter:
PATHCHAR "/"
Reply
GET path "Gateways/RockFish" 1102
PGADD
Adds a user, a conference, a mail list, or group calendar to one or more groups.
Syntax
PGADD <userID> <G1> ... <Gn>
PGADD <name> <G1> ... <Gn>
Parameters
<userID> The user ID of the user that you want to assign to the user groups.
<name> The directory name of the conference, mail list, or group calendar.
<G1> ... <Gn>The name of the user group, conference group, mail list or calendar group.
Example
To add Sue Bram to the Employees and Engineering Group user groups, you would enter:
PGADD SBRAM Employees "Engineering Group"
To add Staff Lounge to the Employee Conferences group, you would enter:
PGADD "Staff Lounge" "Employee Conferences"
PGDEL
Deletes a user, conference, mail list, or calendar group from one or more groups.
Syntax
PGDEL <userID> <G1> ... <Gn>
PGDEL <name> <G1> ... <Gn>
Parameters
<userID> The user ID of the user that you want to remove from the user groups.
<name> The directory name of the conference, mail list, or group calendar.
<G1> ... <Gn>The name of the user group, conference group, mail list, or group calendar.
Example
To remove Sue Bram from the Executives user group, you would enter:
PGDEL SBRAM Executives
To remove Staff Lounge from the Employee Conferences group, you would enter
PGDEL "Staff Lounge" "Employee Conferences"
PUT
Updates FirstClass forms at the field level. Forms that can be updated are System Profile, user group, gateway settings , User Information, résumés, user preferences, address books, mail lists, Get Info/Properties forms, user search forms, bookmarks and user-defined forms. The forms which cannot be updated by batch administration include the Conference Permission form, the Gateway Permissions form, the Login form, Logout from FirstClass form, Service Setup, and the POP3 imported mailbox form.
Warning
Protected fields cannot be updated. Never change the attributes of fields on forms identified as Templates in the Example.fc file.
To create GET and PUT commands ,you need to know the field ID of the field you want to work with. See “Using Example.fc to find form and field IDs” for information on how to look up fieldids.
The PUT commands also requires a fieldtype and fieldvalue, in addition to the field ID. To obtain the fieldtype and fieldvalue, follow these steps.
Alter the form to reflect the intended result of the command. For example, if you want to change the class of a user from Network to Remote then set a test user to Remote.
Use the GET command to generate the fieldtype and fieldvalue. Use this data to construct your PUT command. The EXPORT command can also be used to create scripts.
Syntax
PUT <objdesc> <fieldlist>
Parameters
<objdesc> describes the target
USER <userid> User Information (named UserData in Example.fc) form of <userid> and the Directory form of conferences (ODInfo), folders (ODInfo), gateways (ODGateway), remote names (odRemote), routes (odRoute) and user groups (ODInfo).
PATH <path> A form, message or document specified by the path, relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
SYSPROFILE The System Profile
DESKTOP <desktop> A form, message, or document specified by a path relative to the user’s Desktop
PROPERTIES PATH <path> The Get Info (Mac OS) or Properties (Windows) form. The path is relative to the administrator's Desktop
PROPERTIES desktop <userid> <path> The Get Info (Mac OS) or Properties (Windows) form. The path is relative to the user's Desktop.
PREFERENCES <preferences> a user’s preferences form
RESUME <resume> a user’s résumé
SEARCH <search> a user’s search form
<fieldlist> is a list of field descriptor triplets of the form:
<fieldID> <fieldtype> <fieldvalue>
<fieldID> The field ID as shown in Designer
<fieldtype> The field type. Supports 0=String, 6=CheckBox, 7=Popup, 14=Number
<fieldvalue>The field value. May be enclosed in quotes if needed. The field value must be numeric for Checkbox, Popup and Number. Popup values can be found using FirstClass Designer.
The syntax for the PUT command when used to insert address fields is as follows:
PUT <objdesc> <addressid> <index> <address>
<addressid> To field is 4, Cc field is 5, Bcc is 14. Do not use the field ID displayed in FirstClass Designer.
<index> Position to insert in the list. Use 0 for the first name, 1 for the second name as so on.
<address> The name of the directory entry. It can be a registered user, e-mail address, conference, remote name. If a unique name is not provided, the first matching name is used.
The field ID for the body of a message, form, or document is 6. This special field does not require a field type. Only 250 characters can be sent with each command, but you can append to the field. Entering empty quotation marks will insert a line break into the body of a message, document, or form.
PUT user
Updates fields on the User Information form. The command can be used to change most fields including user ID, user class (Remote/Regular), disk quota, and privilege checkboxes. The command cannot be used to update the user group membership. Use PGADD and PGDEL to update group membership. The command can also be used to update the directory forms of the Directory form of conferences (ODInfo in Example.fc), folders (ODInfo), gateways (ODGateway), remote names (odRemote), routes (odRoute) and user groups (ODInfo).
Note
Only the main admin account can retrieve or update the password fields (field ID 1217).
In the Example.fc settings file the User Information form is called UserData. See “Using Example.fc to find form and field IDs” for more information how to look up the remaining field IDs.
Field name Length Fieldid Field type
User ID 15 1201 0
First Name 23 1202 0
Initial 3 1203 0
Last Name 23 1204 0
Password 12 1217 0
Mail alias 200 1252 0
Class 1223 7
Tel 79 1206 0
Fax 79 1207 0
Address 249 1205 0
Comments 249 1224 0
Daily connection time 1220 7
Section inactivity limit 1222 7
Disk space limit 1257 7
Maximum number of
multimatch names 1219 7
Syntax
PUT user <userid> <fieldlist>
Example
To change a user’s firstname from "dave" to "David" and set disk quota to 400K, enter
PUT user dave 1202 0 "David" 1257 14 400
To change David from a Remote user to Regular user, enter:
PUT user david 1223 7 1
To change Dave from a Regular to a Remote user, enter:
PUT user dave 1223 7 5
To update the domain name of a gateway use the remote serial number as the user ID.
PUT user 7600203 1252 0 "subdomain.com"
PUT path
Updates a form, document, or message. For example the command can be used to change fields in user groups, gateway settings, address books, view properties, and mail lists forms.
Syntax
PUT path <path> <fieldlist>
Example
To take away Chat from the All Users group, enter:
PUT path "Groups:All Users" 1206 6 0
To enter information in a string field on a user-defined form enter:
PUT path "Private Conferences:Staff Lounge:Contact Info" 1001 0 "555-1212"
The field where you add names to a mail list field is a To: field, so you would use the syntax for address fields. To enter the first two names in a mail list enter
PUT path "Mail Lists:Sales" 4 0 "David Smith"
PUT path "Mail Lists:Sales" 4 1 "sbram@abccorp.com"
For information about setting the view properties of a conference or Desktop, see the SNAPSHOT command.
To add text into an existing document, you would use field id 6. This field does not require a field type. You can only send 250 characters at once. If you wanted your document to appear in the following format:
Both FCIS and FCCC consist of two parts: FirstClass, a client application (you) and FCIS, a server application.
To connect to a particular server:
• there must be a network or modem connection between your computer and the computer that is running the FCIS server to which you want to connect
• you must have FirstClass installed on your computer
You would submit the following commands. The comment lines are not necessary.
//First paragraph (appended to any current content)
PUT Path "News:Parts" 6 "Both FCIS and FCCC consist of two parts: FirstClass, a client application (you) and FCIS, a server application."
//Inserts two line breaks
PUT Path "News:Parts" 6 "" 6 ""
//inserts next line and a line break
PUT Path "News:Parts" 6 "To connect to a particular server:" 6 ""
//Inserts next two lines, plus the line breaks
PUT Path "News:Parts" 6 "- there must be a network or modem connection between your computer and the computer that is running the FCIS server to which you want to connect" 6 "" 6 "- you must have FirstClass installed on your computer" 6 ""
PUT permissions
To update the fields on the Conference Permissions form and the calendar Permissions form. To set the permissions for a conference group or calendar group refer to PUT permissions model.
There are two types of permissions forms, the first is used with the conference groups and calendar groups located in the Groups folder on the Admin Desktop. The second is used with a conference or calendar. Each form has its own syntax.
To fully update the Permissions form four different commands are required. The permissions form is called ACL in the Designer.
The About button gives you access to the conference's Résumé. Use the PUT resume <conference name> to update.
The Directory button gives you access to the Directory form. Use the PUT User <conference name> to update. The subscription list is updated with the LINK USER command.
The group membership is updated with the PGADD or PGDEL command.
The DELFLD command can be used on the Who, Access, and Permission field.
Fields not supported
• Messages require approval
• Attachments require approval
• Use Layout from server
Syntax for Who, Access, and Permissions field (29) on the conference or calendar group form
The field ID for setting both the Who and Access fields is 29. Both parameters are set at the same time.
PUT permissions model <conference group> <path> <29> <index> <name> <field value>
Syntax for other fields on the Conference Permissions form of a conference or calendar
The fields outlined in the table below follow this syntax:
PUT permissions model <group name> <path> <fieldlist>
Syntax for Who, Access, and Permissions field (29) on the Conference Permissions form of a conference or calendar
PUT permissions <path> <29> <index> <name> <field value>
To set conference permissions for users, groups, and gateways at the conference and calendar level use the following syntax. The field ID for setting both the Who and Access fields is 29. Both parameters are set at the same time.
Syntax for other fields on the Conference Permissions form of a conference or calendar
The fields outlined in the table below follow this syntax:
PUT permissions <path> <fieldlist>
Parameters
<path> Conference or calendar specified by the path, relative to the administrator's Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
Note When making changes to a conference group or calendar group the path is always represented by a two quotation marks.
<group name> The name of the conference group or calendar group.
<index> Position to insert in the list. Use 0 for the first name, 1 for the second name as so on.
<fieldlist> is a list of field descriptor triplets of the form:
<fieldID> <fieldtype> <fieldvalue>
<fieldID> The field ID as shown in Designer
<fieldtype> The field type. Supports 0=String, 6=CheckBox, 7=Popup, 14=Number
<fieldvalue>The field value. May be enclosed in quotes if needed. The field value must be numeric for Checkbox, Popup and Number. Popup values can be found using FirstClass Designer .
Examples
To set the permissions of a conference group called "Employee Read CG", type the following:
PUT permissions model "Employee Read CG" "" 29 0 "Employee UG" 87552
Note: The path is always represented by empty quotation marks.
To set the permissions for the News conference so the FT Faculty group are contributors and All Users are disallowed, you would enter the following:
PUT permissions "news" 29 1 "ft faculty" 87552 29 2 "all users" 0
Value for preset conference permissions
Value Permission Set
0 Disallowed
512 Summary
4608 Browser
87552 Reader
122624 Contributor
122752 Approver
122798 Moderator
131054 Creator
131071 Controller
Custom permissions
To create custom permissions add the values of all the permissions you want assign to the user, group, or gateway as the value as the <fieldvalue>.
Examples
To set the permissions of the Orders conference to enable to all users to send and delete their own mail, enter:
PUT permissions "private conferences:orders" 29 0 "all users" 2304
To set the permissions of the Employees Send conference group to enable the Employees to send and delete their own mail, enter:
PUT permssions model "Employee Send" "" 29 0 "Employee UG" 2304
Value Permission
1 Edit permissions
2 User is the moderator
4 Delete any item
8 Directly create items
16 Edit read only items
32 Edit items
64 Save window and view properties
128 Approve items
256 Delete own items
512 Open conference
1024 Search
2048 Send
4096 Open items
8192 Create Subconferences
16384 Download files & attachments
32768 View permissions
65536 View history
Value for preset calendar permissions
Value Permission Set
0 No Access
2097152 See Times
2304 Schedule Only
2099456 Schedule+Times
2100992 Schedule+Details
2219821 Editor
Custom calendar permissions
To create custom permissions add the values of all the permissions you want assign to the user, group, or gateway as the <fieldvalue>.
0 Disallowed
1 Edit permissions
2 Moderator
4 Delete any item
8 Create items
16 Edit read only
32 Edit items
64 View properties
128 Approve items
256 Delete own items
512 View unrestricted details
1024 Search items
2048 Add participants
4096 Open items
16384 Download files
32768 View permissions
65536 View history
2097152 Open calendar
Example
To set the Form to Use field on the Conference Permissions form of the a conference called Reception Desk, enter:
PUT Permissions "Private Conferences:Reception Desk" 2008 14 128
To set the Form to Use field on the Conference Group called Employee Read, enter:
PUT permissions model "Employee Read" "" 2008 14 128
Other Fields on Permission Forms
Field Name: Limit messages above
Field ID: 1006
Field Type: 14
Field Value No Limit = 0
Field Name Handling
Field ID 1007
Field type 7
Field Value Reject with NDN = 0
Reject and Report =1
Requires
Approval = 2
Reject Quietly = 3
Field Name Expire old messages when number of items reaches
Field ID 1012
Field Type 14
Field Value Default=0
Never= 2147483647
Numbers only
Field name Default message expiry
Field ID 1004
Field Type 14
Field Value Default=0
Never = 2147483647
Field name Form to use
Field ID 2008
Field Type 14
Field Value Form ID number (see chart below)
Field name Reply Preference
Field ID 2009
Field Type 7
Field Value Automatic = 0
Reply All = 1
Reply Sender=2
Default = 6
Checkbox fields are not supported.
FormID list
If you want to use a form, other than the Message form, use the Form ID list as assigned by the FirstClass Designer.
Form name Form ID
Phone Call 128
File Transfer 131
Quick Message 132
Request for Information 133
Alternate Message 134
Requisition From 135
Image Message 136
Message 141
Memo 146
Project Estimate 148
Quick Note 152
While You Were Out 154
New Calendar Event 161
Home Page 900
PUT properties
Changes the Get Info (Mac OS) or Properties (Windows) form. The path is relative to the administrator's Desktop.
Syntax
PUT properties path <path> <fieldlist>
Example
To protect an existing conference, enter
PUT PROPERTIES PATH "Private Conferences:Customer Support" 1016 6 1
The NEW command describes how to protect objects when created.
To make the conference auto-open, enter
PUT PROPERTIES PATH "Private Conferences:Customer Support" 1015 6 1
The Properties (Windows) Get Info (Mac OS) form has two hidden fields which indicate the location of an icon. The horizontal position is field ID 1306, and vertical position is field ID 1307.
Both fields type are numbers (14). To change the form use the PROPERTIES object type.
Example
To change the location of a conference called MTH202, type the following:
PUT properties "Private Conferences:Mth202" 1306 14 205 1307 14 5
1306 is the horizontal field ID
14 is the field type
205 is the position of the icon
1307 is the vertical field ID
14 is the field type
5 is the position of the icon
PUT properties desktop
Used to change the Get Info (Mac OS) or Properties (Windows) form. The path is relative to the user's Desktop.
Syntax
PUT properties Desktop <userid> <path> <fieldlist>
Example
To unprotect the Address Book folder, enter
PUT properties desktop sbram "address book" 1016 6 0
PUT sysprofile
Updates fields on the system profile.
Syntax
PUT sysprofile <fieldlist>
Example
To set the server priority to High, enter:
PUT sysprofile 1226 7 0
To set the priority to Medium, the <fieldvalue> would be 1, and Low would be 2.
To change the volume, where users are created on the volume second in the list, enter:
PUT sysprofile 1224 7 2
Note
The server stores time in seconds. There are 86400 seconds in a day. Exercise caution when updating the Private mail expiry and Conference item expiry fields.
PUT desktop
Updates forms at the field relative to the user’s Desktop, such as personal address books, personal mail lists, documents, messages, and stationery forms.
Syntax
PUT desktop <userid> <path> <fieldlist>
Example
To fill in the To field on a stationery form use the syntax for address fields. To insert the first addressee, you would enter:
PUT desktop sbram “Reception Desk:To Roy” 4 0 “Roy Allen”
The syntax for this command when used to add an address field is as follows:
PUT desktop <userid> <path> <addressid> <index> <address>
<addressid> To field is 4, cc: field is 5, bcc is 14. Disregard the field IDs displayed in the FirstClass Designer.
<index> Position to insert in the list. Use 0 for the first name, 1 for the second name and so on.
PUT preferences
Updates a user’s Preference form. This only works for fields on the Mailbox, Mail Rules and Signature tabs of the Preference form. The remaining tabs are stored locally in the FCIC.fcd file in the FirstClass folder.
Syntax
PUT preferences <userid> <fieldlist>
Example
To set the Reply Preference to reply to sender, enter:
PUT preferences sbram 1107 7 2
PUT resume
Adds the user’s name to the résumé form.
Syntax
PUT resume <userid> <fieldlist>
Example
Unless you have customized the résumé form, the only two fields you can update are the fields that contain the name and the body of the résumé. The picture field cannot be updated through batch administration. Batch administration cannot delete the contents of a user's resume.
To add a user's name, enter the following:
PUT resume sbram 1000 0 "Susan Bram, Extension 592"
To add content to the résumé, enter:
PUT resume sbram 6 "My name is Susan Bram, never call me Sue"
For more information on inserting information into the body of a message, document, form, or résumé see the PUT path command.
To fill in the About Conference form (also known as a conference résumé) enter the following:
PUT resume 1000 0 "Staff Lounge" 6 "This conference is used to share ideas and knowledge"
PUT search
Sets the parameters on the search form.
Syntax
PUT search <userid> <fieldlist>
Example
To set a user’s search form to search subconferences and folders, enter:
PUT search sbram 1204 6 1
PW
Sends the batch administration password to the batch administration task. If you are not the administrator, you must submit the password before any other commands. If you do not, your commands are not processed. To find out how to define the password, refer to Allowing others to use batch administration.
Syntax
PW <password>
Parameter
<password> The password (maximum 12 characters).
Note
If you are not the administrator, but are authorized to use batch administration, you would use the following command before any other batch command:
PW secret
RENAME
Renames an object on the administrator’s Desktop.
Syntax
RENAME <target path> <objname>
Parameter
<target path> The path relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
<objname> The new name of the object.
Example
To rename a folder from Staff Lounge to Staff Conference, enter:
RENAME “Private Conferences:Staff Lounge” “Staff Conference”
RENAME desktop
Renames an object on a user’s Desktop.
Syntax
RENAME <userid> <target path> <objname>
Parameter
<userid> The user ID of the user.
<target path> The path relative to the administrator’s Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
<objname> The new name of the object.
Example
To rename a folder on a user’s Desktop, enter:
RENAME DESKTOP sbram "IS Policies" "IT Policies"
REMOVE
Deletes an object. The object will be deleted even if protected. Objects deleted with the REMOVE command cannot be undeleted. Target path is relative to the administrator’s Desktop.
Syntax
REMOVE <target path>
Paramenter
PATH <path> Target path is relative to the administrator’s desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
DESKTOP <userid> The user ID of the user from whom you want to remove items. Path is relative to the user Desktop.
Example
To remove the London gateway, you would enter:
REMOVE “Gateway:London”
To remove the index.html followed by the Home Page folder from a user’s Desktop, you would enter:
REMOVE DESKTOP pchu "Home Page Folder:index.html
REMOVE DESKTOP pchu "Home Page Folder"
REPLY
Requests generated output to be sent back to you as a reply. It must be used with the GET, GETADMIN, and LIST commands. It can be used with most commands. Some commands reply only if the command is unsuccessful. You can also enable the Batch Admin Log at the Server console by choosing Diagnostics > Batch Admin Log.
Syntax
REPLY
Example
To produce and export a list of all users, and to view the output as a message, you would enter:
REPLY
LIST +ur
SNAPSHOT
Returns the View Properties of a conference in the format of a PUT command. Reply command must be used with the SNAPSHOT command. The EXPORT command generates a script that can include view properties.
Syntax
Reply
SNAPSHOT <target path>
Parameter
<target path> the location of the conference, relative to the administrator's Desktop. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
Example
To apply the View Properties of one conference to another conference follow this procedure.
Configure the view properties of a conference, including View > split, size and location, in addition to the choices presented on the View Properties form, then enter the following command.
Reply
SNAPSHOT "Conferences:Benefits"
The server returns the following information:
PUT PATH "conferences:benefits" 901 178 902 75 903 365 904 594
PUT PATH "conferences:benefits" 1101 14 -65535 900 0
PUT PATH "conferences:benefits" 13074 7 0 13065 14 -2147483646 13075 7 8
PUT PATH "conferences:benefits" 13015 0 "" 13016 7 0
PUT PATH "conferences:benefits" 13003 7 24
PUT PATH "conferences:benefits" 13082 7 16
PUT PATH "conferences:benefits" 13084 7 0
PUT PATH "conferences:benefits" 13174 7 0 13165 14 -2147483646 13175 7 8
PUT PATH "conferences:benefits" 13115 0 "" 13116 7 0
PUT PATH "conferences:benefits" 13103 7 24
PUT PATH "conferences:benefits" 13182 7 32
PUT PATH "conferences:benefits" 13184 7 0
Copy and paste the information into a new message addressed to Batch Admin
Choose Edit > Replace and insert the path of the conference you want to apply the View Properties to. After batch admin processes the command, the conference will have the same view properties as the conference you took the snapshot of.
The view properties can be applied to a user's Desktop by changing the target of the object. For example, to apply the same view properties to a user called Roy, you'd send the following command to the server. The empty quotation marks represent the Desktops.
PUT DESKTOP roy "" 901 178 902 75 903 365 904 594
PUT DESKTOP roy "" 1101 14 -65535 900 0
PUT DESKTOP roy "" 13074 7 0 13065 14 - 2147483646 13075 7 8
PUT DESKTOP roy "" 13015 0 "" 13016 7 0
PUT DESKTOP roy "" 13003 7 24PUT DESKTOP roy "" 13082 7 16
PUT DESKTOP roy "" 13084 7 0
PUT DESKTOP roy "" 13174 7 0 13165 14 - 2147483646 13175 7 8
PUT DESKTOP roy "" 13115 0 "" 13116 7 0
PUT DESKTOP roy "" 13103 7 24
PUT DESKTOP roy "" 13182 7 32
PUT DESKTOP roy "" 13184 7 0
UPLOAD
Uploads a file to a conference or folder. Both the NEW command and the UPLOAD command are required.
Syntax
UPLOAD <path> <name> +b
<path> PATH
<name> name of the file, including any extensions
option +b Uploads a file contained the FirstClass Post Office\Server\Batch folder (Mac OS) or FCPO\Server\Batch folder (Windows NT).
Example
Upload the staff settings.fc file to your message, and enter the following to create an uploaded a file:
NEW "private conferences:new settings files" "staff settings.fc" "" FCF 17044-1 -1
UPLOAD "private conferences:new settings files:staff settings.fc" "staff settings.fc"
To upload the staff settings.fc file contain in the Batch folder, within the FirstClass Post Office, you would enter:
NEW "private conferences:new settings files" "staff settings.fc" "" FCF 17044-1 -1
UPLOAD "private conferences:new settings files:staff settings.fc" "staff settings.fc" +b
WRITE
Specifies text that you want sent back to the administrator’s mailbox in reply to a batch command.
Syntax
WRITE <text> Maximum 255 characters.
Example
When you use the REPLY and NEW batch commands to create a conference, FCIS sends you a reply only if the conference was not created correctly. However, you may want to receive a message confirming a successful conference creation. To receive a confirmation for the new conference in the example in NEW, you would enter:
REPLY
NEW "Conferences:Customer Service" "Read These First!" "Commonly Asked Questions" CONFERENCE 13107 10 10
WRITE Conference created successfully.