C302 / Commands by name

ADD NETWORK/ADD TELECOM ADD REMOTE ADD ROUTE AN CHGALIAS COPYFLD DEL DELALL DELFLD DN ENABLEFIELDSUBSTITUTION EXIT EXPORT SETEXPORTFILTERS GET GETADMIN LICENSE LINK PATH LINK USER LIST NEW PATHCHAR PGADD PGDEL PUT PUT PERMISSIONS PW REMOVE RENAME REPLY SETEXPORTFILTERS SETOU SNAPSHOTF UPLOAD WRITE ADD NETWORK/ADD TELECOM Adds a regular (network) user or remote (telecom) user. Syntax ADD class userID first i last dept pw postaddr phone1 phone2 UG# UG1...UGn Parameters class                 Network creates a regular user. Telecom creates a remote user. userID         The user ID (maximum 15 characters).                 first                 Optional, unless i is also used. The first name (maximum 23 characters).                                     i                            Optional. The initials (maximum 3, no periods).           last                  The last name (maximum 23 characters). dept                  Not used; you must include a pair of quotation marks in the script.                pw                           The user's 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). UG#                   The number of user groups to follow.       UG1...UGn       The user groups to add user to (maximum 31 characters each). Example To add a regular user Susan A. Bram, with user ID “SBRAM” and password “broccoli”, and to put her into the Employees and East Coast user groups, you would enter: ADD NETWORK SBRAM Susan A Bram "" broccoli "123 Main St.\rToronto" "" "" 2 Employee "East Coast" To add remote user Susan A. Bram, with user ID “SBRAM” and password “broccoli”, and to put her into the Employees and East Coast user groups, you would enter: ADD TELECOM sbram Susan A Bram "" broccoli "123 Main St.\rToronto" "" "" 2 Employee "East Coast" The \r put a carriage return in the address field. Notes •       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), FirstClass still adds an account for that user. To correct this, either delete the account, unsend the message, correct the error, and resend, or correct the information on the user information form. •       If you want a user to be prompted to change his or her password the first time the user logs in, create a password that does not meet the criteria by password security. •       One of the most common errors is to exclude the number of user groups (UG#) in the script. The server console will show the phrase "Type a number between 0 and 255" if you fail to include the number of user groups. Another common error is failing to put the names of groups that contain a space in quotation marks. If you mistype the name of a user group, the server console will indicate that the group does not exist, and list error 1081. •       If the user ID already exists, the server console will indicate error 1031. •       If the exact name already exists the server console will indicate error 1080. An example of an exact name would be creating a second Susan A. Bram, with a user ID of susan. •       If there are no Regular licenses available, the server console will indicate error 1018. Related commands You can use the PUT USER command to create additional scripts that would add information unsupported by the ADD command.  For example, the following script would add a mail alias (field ID 1252), a voice DN (field ID 1255), and a voice password (field ID 1256) for Susan Bram: PUT USER sbram 1252 0 sabram 1255 0 9055551212 1256 0 1212 Top ADD REMOTE Adds a remote name. Note The term 'remote name' refers to the Directory entry for a user on another server. To add a remote user, use ADD NETWORK/ADD TELECOM. Before you can add a remote name, the site where the user is registered must be defined as a route or gateway. Syntax ADD REMOTE first i last dept sitename clientID gateway Parameters first          Optional, unless i is also used. The first name (maximum 23 characters). i                     Optional. The initials (maximum 3, no periods). last           The last name (maximum 31 characters). dept           Not used. sitename        The name of the site where the user is registered. clientID        The unique ID for the user. Use this field to distinguish between users with 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" Top ADD ROUTE Adds a route to a remote server. Syntax ADD ROUTE name siteID cost gateway Parameters name           The site name of the remote server. siteID  The serial number of the 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 50 "Husky Planes Boston" Top ADD TELECOM See ADD NETWORK/ADD TELECOM Top 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, see the FirstClass Gateway Toolkit Developer's Manual. Top CHGALIAS Changes the Internet alias for a user, conference, gateway, or route. Note This command replaces the contents of the mail alias field, it does not amend the field. Syntax CHGALIAS name alias Parameters name           The name of the Directory entry. It can be a registered user, conference, 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. Examples To change Susan A. Bram mail alias to sabram, you would enter: CHGALIAS "susan a bram" sabram To change the mail alias of the conference Employee Lounge to lounge, you would enter: CHGALIAS "employee lounge" lounge Related commands The PUT USER command can also be used to change the mail alias (field ID 1252). The PUT USER command uses the User ID, which is always unique. To change Susan A. Bram to sabram, you would enter: PUT USER sbram 1252 0 sabram Top COPYFLD Copies the contents of a field from one form to another where source field ID and destination field ID are the same. Syntax COPYFLD source_objdesc fieldID dest objdesc Parameters source_objdesc  The source where the form is located PATH path              A form specified by a path relative to the administrator's 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. CLIENT clientID The user information form specified by the client ID. DIRECTORY name  The Directory form of gateways, conferences, remote names, and user groups. fieldID               The number assigned to the field in FirstClass Designer and listed in the Example.fc file. dest_objdesc    The destination form. Uses the same set of parameters as source_objdesc above. Example To copy the address field (1205) from sbram's information form to pchu's, you would enter: COPYFLD user sbram 1205 user pchu The user ID can be changed by the administrator, however, the client ID can never be changed, nor is the number ever reused. Systems administrated solely by batch administration and external databases may prefer to use client ID. To copy the address field (1205) from sbram's (client ID 1612) User Info formto pchu's (client ID 1602), you would enter: COPYFLD CLIENT 1612 1205 CLIENT 1602 Top DEL Deletes a user registered on your server. Syntax DEL userID Parameters userID  The ID assigned to the user (maximum 15 characters). Example To delete user Susan Bram, you would enter: DEL sbram If the user ID does not match exactly, the command will fail and the server console will indicate error 1003. Related commands To remove all other Directory entries use the REMOVE or REMOVE DESKTOP command. Top DELALL Deletes all routes or remote names from your Directory, or 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 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, that is used only by the Directory synchronization process. If you are a developer and require more information, see 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 Top DELFLD Deletes field information on forms. Syntax DELFLD objdesc fieldID When used to delete an adress field: DELFLD objdesc addressID index address Parameters objdesc        Describes the target. fieldID        The field ID addressID       "To" field is 4, "Cc" field is 5, "Bcc" field is 14. The "Who", "Access", and "Permissions" field on the Permission form is 29. Disregard the field IDs displayed in the FirstClass Designer for these fields. index                 Position to insert in the list. Use zero 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, email address, conference, calendar, remote name, gateway, or route. If a unique name is not provided, the first matching name is used. Additional parameters: PATH path              A form specified by a path relative to the administrator’s Desktop. If 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 Permission form of a conference or calendar. Examples To delete the sixth entry from a mail list, enter: DELFLD path “Mail Lists:London” 4 5 “Roy Allen” To delete the sixth entry from a pesonal mail list in Sue Brams Address Book folder, enter: DELFLD DESKTOP sbram “address book: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 mail alias (field ID 1252), voice DN (field ID 1255), and Voice password (field ID 1256)  from sbram's user information form, enter: DELFLD user sbram 1252 1255 1256 To delete the first entry in the Employee Lounge conference's Permissions form, enter: DELFLD permissions "private conferences:employee lounge" 29 0 To delete the first and second entry in the Employee Lounge conference's Permissions form, enter: DELFLD permissions "private conferences:employee lounge" 29 1 29 0 The first 29 0, deletes the first entry, and moves the second entry up to the first postion.  The second 29 0, would delete the entry moved into the first position.  If you have five lines in the conference Permissions form, the command would be: DELFLD permissions "private conferences:employee lounge" 29 4 29 3 29 2 29 1 29 0 Top 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, see the FirstClass Gateway Toolkit Developer's Manual. Top ENABLEFIELDSUBSTITUTION Field data from forms sent to Batch Administration replace '#' field identifiers found in the body of the message. This option is disabled by default but can be enabled by using the EnableFieldSubstitution command. Subsequent lines will be preprocessed replacing '#' field identifiers with the data found in the identified field. After enabling the preprocessing, if a '#' is required as part of a string it must be preceded by a '\'. Syntax EnableFieldSubstitution #<Field ID>      #{<Field ID>}    Parameters <Field ID>      Must be numeric. {}                           Allows you to immediately follow the Field ID with a digit. Examples In order the take full advantage of field substitution, you will need to create custom forms. For example, every time you create a new conference to support employee training, you: 1       Create a conference. 2       Create a public chat. 3       Create a stationery that is preaddressed to the instructor. 4       Create a group calendar. 5       Set the permissions of the conference: instructor is the controller, employees are contributors, and all users are disallowed. 6       Set the permissions of the group calendar: instructor is the Editor, employee are Schedule+Details, and all users are disallowed. You could create a local form that contained the standard address fields. The editable fields added to the form are the name of the course (field ID 1000) and the name of the instructor (field ID 1001). To fill in the name of the course as "Power Presentations" (field ID 1000) and the name of the instructor as "Susan A. Bram" (field ID 1001), the body of the message contains the following script(lines starting with // are comments and are optional): enablefieldsubstitution //create a new conference called Power Presentations NEW "private conferences" "#1000" "" CONFERENCE 8 -1 -1 +p //create a public chat called Power Presentations Chat" NEW "private conferences:#1000" "#1000 Chat" "" CHAT 150 180 50 129 +p //Create a new message stationery NEW "private conferences:#1000" "Message to Instructor" "" PERMS 7010 60 50 141 //Add Susan A. Bram to the To field of the Message to Instructor stationery. PUT "private conferences:#1000:message to instructor" 4  0 "#1001" //Create a new calendar called Power Presentations Calendar NEW "private conferences:#1000" "#1000 Calendar" "" CONFERENCE 24011 325 50 21 +p //Set permissions of the Power Presentations conference PUT PERMISSIONS "private conferences:#1000" 29 0 "#1001" 131071 29 1 employee 122624 29 2 "all users" 0 //Set permissions of Power Presentations Calendar PUT PERMISSIONS "private conferences:#1000:#1000 calendar" 29 0 "#1001" 2219821 29 1 employee 2100992 29 2 "all users" 0 Supported field types These include the first entry in the From field, and the first entry in Attachments field (7). The following is a list of the most common fields you can add to a custom form: Editable fields        Contents of field is substituted in the script. For example, names of conferences or groups. Editable Selection Lists        Presents administrator with a predefined list. For example, a list of pictures available for use as background picture for a conference. FirstClass Designer allows you to limit this type of field to "Choose from List Only". For more information, see FirstClass Designer. Icon fields                   Presents the administrator with the Icon picker. For example, you could include an Icon field in forms that create new objects. You would then be able to choose the icon from the icon picker instead of submitting the icon ID. Number fields          Eliminates the need for {} to differentiate numbers from field IDs. Top EXIT Stops the server from processing any further information. It is used when submitting commands with a POP3 client. Syntax EXIT version Parameters version Optional. Server version number. processing is stopped if the server version is not equal or greater the version number. Example To stop processing a script if the server is not a 7.1 server, you would enter EXIT 7100 Top Top EXPORT Generates a cross-platform batch administration script based on existing objects on your server. Only the Admin account can submit EXPORT commands. Syntax •       for generating a script         EXPORT path name +rnpe -cv •       for generating and executing a script EXPORT path address BatchAdminPassword ObjDesc +b 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. The path can only include conferences and folders. 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. The path can only include conferences and folders. name                  Optional. The Directory name of the user or conference. The script is returned to the sender if the name parameter is not included. address        The name of the user that processes the batch admin command. Typically, within the same server, the parameter would be "batch admin".   BatchAdminPassword      Optional. The password required to process batch admin commands. ObjDesc               The target path. +r                           Recursive, exports subconferences and subfolders. +b                           Process script immediately. +n                           Includes target path container. +p                           Includes the Who section of the permission form. All other supported fields on the permission form are included by default. +e                           Includes container rules. -c                           Excludes messages, documents, and files. -v                           Excludes view properties. -c                           Excludes content. To use the EXPORT command: 1       Send a batch admin message containing a valid EXPORT command. FirstClass will extract the appropriate information and use it to generate an import script. 2       Create a forwarded copy of the message and address it to Batch Admin. 3       Replace <ObjDesc> with the destination path in the message body. Conferences, calendars, gateways, groups, and mail lists require unique names. Chats, folders, messages, conference items, documents, uploaded files, stationery, calendar tasks, and calendar events do not require unique names, and therefore no adjustments are necessary. Note The destination folder, conference, or calendar must exist.  It can be created manuallywith the NEW command, or by including the +n option in the EXPORT command. If your server console reports "object not found" errors, the path may not exist or it may have been typed incorrectly. 4       Send the message. The messages, documents, uploaded files, calendar events, and calendar tasks created by the EXPORT command are originals and do not include any history information. EXPORT will not include: •       aliases of folders, conferences, or calendars (use LINK PATH to recreate) •       The Who section of the permission form can be included with the script, however conference group membership and the list of subscribers are not included. If you are sending the outgoing batch admin scripts through your Internet gateway, ensure that your outgoing line length is set to accomodate the line length of the script. This field is found on the Outbound tab of the Advanced Mail form within the Internet Services folder. If your server console reports object not found errors, you may not have your line length high enough. You can use the EXPORT command to help you create scripts that create new objects and enter field data.  For example, say you want to create 50 new conferences but don't know what the correct syntax is: 1       Create a folder within Private Conferences called BATest. 2       Send the following command         EXPORT "private conferences:batest" +rn -vc 4       The server will return:         New Relative "" "batest" "" Conference 8 491 82 5       Replace Relative "" with your path, and test with the name of your conference. New "private conferences" "Employee Lounge" "" Conference 8 -1 -1 Note See SETEXPORTFILTERS for instructions on how to limit the import script based on last modified or thread ID. EXPORT examples The Employee Lounge conference is located in the Private Conferences folder. It contains messages, documents, uploaded files, a subconference, a folder, and a calendar. To have the server return a script that would include (in addition to all the messages, documents, calendar items, and uploaded files) the conference, folder, and calendar contained in the Employee Lounge conference, and the view properties of the Employee Lounge conference, you would enter: EXPORT "Private Conferences:Employee Lounge" +r To add the contents of the Employee Lounge conference to the existing Management conference, you would forward the message containing the script to Batch Admin, then change the <objdesc> to: "private conferences:management area" Upon sending the message, the structure, contents, and view properties of the Employee Lounge, will be recreated within the Management conference. However, the Employee Lounge conference will not be created. To generate and process the script in one step, you would enter: EXPORT "private conferences:employee lounge" "batch admin" "" "private conferences:management area" +br To have the server return a script that would include the Who section of permission forms (+p) of the subconferences and calendars, you would enter: EXPORT "Private Conferences:Employee Lounge" +rp The above script would not include the command to create a conference called Employee Lounge or any of the contents of the permission form of Employee Lounge. To have the server return a script that would include the Who section of the permission forms of the subcontainers, but no content (-c) or view properties (-v), you would enter: EXPORT "Private Conferences:Employee Lounge" +rp -cv The script would not include the command to create an Employee Lounge conference or the permissions of Employee Lounge. To have the server return a script that would include the Who section of the permission form (+p) of the Employee Lounge conference (+n), but not the subcontainers (the absence of +r), not the content (-c), and not the view properties (-v), you would enter: EXPORT "Private Conferences:Employee Lounge" +pn -cv To have the server return a script that would include the rules (+e) of the Employee Lounge conference (+n), but not the subcontainers (the absence of +r), not the content (-c), and not the view properties (-v), you would enter: EXPORT "Private Conferences:Employee Lounge" +en -cv To have the server return a script that would recreate an additional Employee Lounge conference (+n), the Who section of the permission forms (+p), the rules (+e), and all the recursive containers (+r). All the recursive containers' rules, content, permissions forms, and view properties would also be returned. Content and view properties are included by default. EXPORT "Private Conferences:Employee Lounge" +nper To have the server return a script that would recreate an additional Employee Lounge conference (+n), the Who section of the permission forms (+p), the rules (+e), and all the recursive containers (+r). The permissions and rules of the recursive containers would also be included. To exclude content (-c) and view properties (-v), you would enter: EXPORT "Private Conferences:Employee Lounge" +nper -cv EXPORT DESKTOP examples To export the contents of sbram's address book to pchu's address book, submit the following command: EXPORT DESKTOP sbram "address book" When the server returns the script, forward the message and replace <ObjDesc> with the following: DESKTOP pchu "address book" To export the contents of sbram's address book to pchu's address book in one step, submit the following command: EXPORT DESKTOP sbram "address book" "batch admin" "" DESKTOP pchu "address book" +b To export the Voice Menus folder from sbram's Voice Greetings folder to pchu's existing Voice Greetings > Voice Menus folder in one step, submit the following command: EXPORT DESKTOP sbram "voice greetings:voice menus" "batch admin" "" DESKTOP pchu "voice greetings:voice menus" +b To export the mailbox rules from sbram's mailbox to pchu's mailbox, submit the following command, EXPORT DESKTOP sbram "mailbox" +ne -cv When the server returns the script, forward the message and make the following changes: -       replace <ObjDesc> with         desktop pchu "mailbox" -       remove the commands that recreate the Mailbox. The following script is returned - comments in italics have been added. // * * * * * * * * * *  Import Script * * * * * * * * * * SetBase <ObjDesc> SetRelative FromBase Path "" //the following command needs to be removed New Relative "" "Mailbox" "" Conference 23009 60 57 +P //the following command needs to be removed Put Permissions Relative "Mailbox" 1012 7 0 1006 14 0 1004 14 0 2008 7 0 1000 6 0 1002 6 0 1001 6 0 1007 7 0 2009 7 6 SetBase FromBase Path "Mailbox" SetRelative FromBase Path "" // Reference: 1:10509 New Relative "" "Advanced Rule" "" FormDoc 7027 30 15 23 23 -U Put Previous 8120 7 1252 8140 0 8141 0 Put Previous 9 "" -T Put Previous 13801.0 7 10 13810.0 7 33 13830.0 7 15 13831.0 7 57 SetRelative FromBase Path "" The script would be changed to the following: SetBase desktop pchu "mailbox" SetBase FromBase Path "Mailbox" SetRelative FromBase Path "" // Reference: 1:10509 New Relative "" "File in folder" "" FormDoc 7027 30 15 23 23 -U Put Previous 8120 7 1252 8140 0 8141 0 Put Previous 9 "" -T Put Previous 13801.0 7 10 13810.0 7 33 13830.0 7 15 13831.0 7 57 SetRelative FromBase Path "" Top SETEXPORTFILTERS Used with the EXPORT command to filter the results of the information returned in the import script. You can specify items based on the last modified date or message thread ID. Syntax SetExportFilters type parameter1 parameter2 options Parameters                            MODIFIED "After specified date" "Before specified date"                Returns a script based on the last modified date.                 THREAD "Thread Site ID" "Thread ID"                Returns a script based on the thread ID of the message. +D             Used with the MODIFIED parameter to enter a formatted date. Examples To export a series of messages based on the thread ID, you would enter: SETEXPORTFILTERS THREAD 34537 35410266 EXPORT "private conferences:staff lounge" To display the thread site ID and thread ID, press the control + shift key and click on the last column in the list view, and then choose Thread ID from the drop down menu. To export a series of messages created on April 21, 2002, enter: SETEXPORTFILTERS MODIFIED "2002/04/20" "2002/04/22" +D EXPORT "private conferences:staff lounge" Top GET Extracts data from FirstClass objects at the field level. GET returns a single line of field triplets (fieldID, fieldtype, fieldvalue), one triplet per field ID requested, in a format that matches the PUT command fieldlist. The REPLY command must precede GET. For additional information, see the PUT command. Syntax REPLY GET objdesc fieldIDs +d +D •       when used to retrieve address fields:         GET objdesc addressID index Parameters objdesc               Describes the target. USER userID            The user information form specified by the user ID: USER userID         CLIENT clientID The user information form specified by the client ID. The Directory form of remote names and routes. DIRECTORY directorytype                                            Directory form of conferences (ODInfo), folders (ODInfo), gateways (ODGateway) and user groups (ODInfo). Directory type keywords are conference, calendar, maillist, and group.                USER USERCONFIG userID  Used to retrieve field information from the Mail Import form. 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. If objdesc is missing, PATH is assumed. PATH DESKTOP userID path               A form, message or document specified by path, 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. PREFERENCES userid      A user’s Preferences form and Print Layout form.        PROPERTIES PATH path    Used to retrive file information from 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 userID path  Used to retrieve field information from 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. RESUME userid   A user’s résumé. ABOUT name             A conference or calendar résumé. RULES path rulename     A container's Rule folder. Path is relative to the administrator's Desktop. RULES DESKTOP userid path rulename      A container's Rule folder. Path is relative to the user's Desktop. SYSPROFILE             The System Profile. fieldIDs                      The field IDs of the fields to be retrieved. Field IDs can be obtained from the Example.fc file that installs with FirstClass Designer. +d +D                        Optional and case sensitive. +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 the "Created" (field ID 1235) and "Last logged in" (field ID 1230) fields on the user information form. addressID              "To" field is 4, "Cc" field is 5, "Bcc" field is 14. Do not use the field IDs displayed in FirstClass Designer for these fields. index                        Position in the list. Use zero for the first name, 1 for the second name and so on. Use -1 to retrieve all address entries. GET USER examples To get user sbram's user ID (field ID 1201), first name (field ID 1202), middle initial (field ID 1203)and last name (field ID 1204) fields, enter: REPLY GET USER sbram 1201 1202 1203 1204 The server returns the following information: 1201 0 "sbram" 1202 0 "Susan  1203 0 "A" 1204 0 "Bram" Asking for the user ID to be included in the reply message will identify which user the information pertains to. Asking for multiple fields in a single command puts less load on the server than submitting multiple commands. Only the main admin account can retrieve data from the password field (field ID 1217). To retrieve Susan's password, enter: REPLY GET USER sbram 1201 1217 The server returns the following information: 1217 0 "brocoli" To retrieve the date and time Susan last logged in, enter: REPLY GET USER sbram 1201 1230 +d If the server returns a date of January 1, 1904, the user has never logged into the server. 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 "Regular Users" 4 1 "Employee" 4 2 "East Coast" If you want to know the second group Susan is a member of, enter: REPLY GET USER sbram 4 1 For additional field IDs, see the User Info, form ID 125, or ODinfo, form ID 115. The user ID can be changed by the administrator, however, the client ID can never be changed, nor is the number ever reused. Systems administrated solely by batch administration and external databases may prefer to use client ID. Susan Bram's client ID is 1602. To get sbram's user ID (field ID 1201), first name (field ID 1202), middle initial (field ID 1203) and last name (field ID 1204) fields based on the client ID, enter: REPLY GET CLIENT 1602 1201 1202 1203 1204 The server returns the following information: 1201 0 "sbram" 1202 0 "Susan  1203 0 "A" 1204 0 "Bram" The client ID can also be used to retreive information from the Directory forms including those supported by the DIRECTORY keyword. The CLIENT keyword allows you to retrieve information from the Directory form of remote names and routes. To retrieve the mail alias field from a Remote name with the client ID of 1956, enter REPLY GET CLIENT 1956 1252 Note Use the List Directory to obtain the correct client ID. GET USERCONFIG example To retrieve the icon ID (field ID 2005), mail server (field ID 2000), user name (field ID 2001), password (field ID 2003), and email address (field ID 2004) from Susan Brams' Internet Mail Import form, enter: REPLY GET USERCONFIG sbram 2005 2000 2001 2002 2003 For additional field IDs, see Message Import Setup, form ID 68. GET PATH example To retrieve the primary domain name (field ID 1001) from the Basic Internet Setup form, enter: REPLY GET "internet services:basic internet setup" 1001 GET DESKTOP example To retrieve the body of Susan's Home Page, enter: REPLY GET DESKTOP sbram "home page folder:home page" 6 GET PREFERENCES example To retrieve the Reply text (field ID 1106) enter: REPLY GET PREFERENCES sbram 1106 Notes •       Fields with a value of greater than 10000 cannot be retrieved. •       Default values are not stored. For example, if the user's reply preference is the default Automatic, the reply will be empty. GET PROPERTIES example To retrieve the icon ID (field ID 1304), name (field ID 1017), location (field ID 1020), creator (field ID 1043), and determine if the Employee Lounge conference is protected (field ID 1016), enter: REPLY GET PROPERTIES "private conferences:employee lounge" 1304 1017 1020 1043 1016 Susan has created a conference called Presentations on her Desktop. To retrieve the icon ID (field ID 1304), name (field ID 1017), location (field ID 1020), creator (field ID 1043), and determine if the conference is protected (field ID 1016), enter: REPLY GET PROPERTIES DESKTOP sbram presentations 1304 1017 1020 1043 1016 For additional field IDs, see the Get Info form (form ID 111) and Folder Info (form ID 92). GET RESUME example To retrieve Susan Bram résumé title (field ID 1000) and the body (field ID 6), enter: REPLY GET RESUME 1000 6 GET ABOUT example To retrieve About form's title (field ID 1000) and the body (field ID 6), enter: REPLY GET ABOUT "employee lounge" 1000 6 About and Résumé use a single form named Résumé (form ID 97). GET RULES example To determine if the File in Folder Rule is enabled or disabled (field ID 13800) enter: REPLY GET RULES "private conferences:employee lounge" "File in Folder Rule" 13800 A reply of 13800 6 1 indicates the rule is enabled. A reply of 13800 6 0 indicates the rule is disabled. To retrieve the message body (field ID 6) of the Rules Log document, enter REPLY GET RULES "private conferences:employee lounge" "Rules Log" 6 To retrieve the message body (field ID 6) of the Rules Log document from Susan Bram's Mailbox, enter REPLY GET RULES DESKOP sbram "mailbox" "Rules Log" 6 GET SYSPROFILE example To retrieve the contents of the "Create users and conferences on this volume" field (field ID 1224) server serial number (field ID 1217) and version number (field ID 1202) from the System Profile, enter: REPLY GET SYSPROFILE 1224 1217 1202 For additional field IDs, see the System Profile, form ID 122. The GET command can help you create PUT commands. For example, if you want to add a voice DN (field ID 1255) and voice password (field ID 1256) to all your users, you could use the GET command to help you create the PUT syntax: 1       Open Example.fc using FirstClass Designer. 2       Open the User Data form (form ID 125) and look up the field IDs. 3       Fill in the voice DN and voice password of any user. 4       Send a GET command:         reply         GET USER sbram 1255 1256         The server will return the field ID, field type and field value:         1255 0 "9055551212" 1256 0 "1212" 5       Compose the PUT command by replacing the field value with appropriate data. To add a voice DN and voice password to Paul Chu's account: PUT USER pchu 1255 0 "9055551213" 1256 0 "1213" Related commands To change fields, see the PUT command. To create objects, see the NEW command. To generate import scripts automatically, see the EXPORT command. Top 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 FirstClass synchronized with other server software. Use this command in conjunction with the REPLY command. Syntax REPLY GETADMIN Top LICENSE Used with FirstClass license files to upgrade your system without shutting down the FirstClass server. The license files can also be used with FirstClass Tools. Syntax LICENSE operation licensenumber Parameters operation              ADD or REMOVE licensenumber   License number of the license file. Examples LICENSE ADD 123456789.LIC LICENSE REMOVE 987654321.LIC Top LINK PATH Makes a link to a conference or folder and places it in another conference or folder. Batch administration supports the creation of an alias relative to the administrator's Desktop, this command cannot be used to create a link to an object of a user's Deskop. Syntax LINK PATH newpath currentpath Parameters newpath        The desired location of the new link, 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. currentpath     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 a link to the Existing Policies conference located in the Private Conferences folder, and place the link in a conference called Management, also located in the Private Conferences folder, you would enter: LINK PATH "Private Conferences:Management" "Private Conferences:Employee Lounge" Related commands To change the horizontal and vertical position of the conference alias see PUT PROPERTIES To place a folder or conference on a user's Desktop see LINK USER. Top LINK USER Makes a link to a conference or folder and places it on a user’s Desktop. The user’s name is added to the subscription section of the conference's Permissions form. Batch administration supports the creation of an alias only on the user's Desktop; objects cannot be placed within other folders or conferences. Syntax LINK USER userID currentpath Parameters userID                The user ID of the user to whom you want to give the link. currentpath     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 a link to a conference called Employee Lounge and to place the link on sbram’s Desktop, you would enter: LINK USER sbram "Private Conferences:Employee Lounge" Related commands To change the horizontal and vertical position of the conference alias see PUT PROPERTIES DESKTOP. Top LIST Generates a list of users, remote names, conferences, calendars, mail lists, or groups. The list can be generated from the whole Directory or just within specified groups. The output file is in batch administration format. The LIST command must be preceded by a REPLY command. Passwords are exported as blanks (""). To export a list of passwords, see the GET command. Syntax •       for user accounts         LIST pattern number G1...Gn +uraxl •       for other Directory entries         LIST pattern number G1...Gn +cgoz Parameters pattern Optional; the string you want to search for. number  Optional; the number of groups to follow. G1...Gn The names of the groups you want to search. +u                    Exports all regular and remote users. The entries in the output file are in ADD NETWORK/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" parameter. (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" parameter. (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 IDs, first names, initials, and last names 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. Examples To produce a list of all users and the extended information, you would enter: Reply LIST +ux To produce a list of users within the Employee groups: Reply LIST "" 1 employee +ux To produce a list of users with the a first or last name of Susan within the Regular users: Reply LIST "Su" 1 "regular users" +ux To produce a list of conferences: Reply LIST +c Top NEW Creates a new object such as a conference, folder, group, gateway, calendar, monitor, rule, 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 •       for creating a conference, message, document, unprotected folder, or uploaded file:         NEW path name subj objtype icon h v +p •       for creating a calendar: 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 object 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         Type of object to be created. CHAT                  Creates a public chat CONFERENCE      Creates a conference, calendar, group calendar, resources calendar, or location calendar Unique names are required. FOLDER         Creates a folder, unique names are not required FCF                   Creates an uploaded file FORMDOC        Creates a form PERMS                 Creates a stationery message TEMPS                 Creates a voice monitor, Internet monitor, or server monitor SYSINFO        Creates a session monitor CONFITEM               Creates an unsent conference item MESSAGE        Creates a message DOCUMENT        Creates a document 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. Form IDs can be found in Example.fc. +p                    Optional. Protects the object. CHAT example To create a chat file, use the object type CHAT. The icon number is 150 and the form ID is 129. For example, to create a chat file inside a conference, enter: NEW "Private Conferences:Employee Lounge" "Water Cooler" "" CHAT 150 -1 -1 129 CONFERENCE examples Conferences do not require the form ID parameter. To create a new protected conference called Employee Lounge with the standard conference icon, in the Private Conferences folder, enter: NEW "Private Conferences" "Employee Lounge" "" CONFERENCE 8 41 15 +p The conference does not require a subject field, therefore the field has been left blank by including two quotation marks. The conference objtype is also used to create calendars; however, the type parameter must be included. 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 28 +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. FOLDER example 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. For example, to create a new unprotected folder called Archived Messages in the Employee Lounge conference, with the standard icon, enter: NEW "Private Conferences:Employee Lounge" "Archived Messages" "" Folder 26093 41 15 To create a new protected folder, enter: NEW "Private Conferences:Employee Lounge" "Archived Messages" "" Folder 26093 41 15 0 +p A conference needs to be created on Susan Bram's Desktop, so the path is represented by a pair of quotation marks. To create a conference, you would enter: NEW desktop sbram "" "Presentations" "" conference 8 41 65 +p FCF example 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. For example, to upload the staff settings.fc file to Employee Lounge, enter the following: NEW "private conferences:employee lounge" "staff settings.fc" "" FCF 17044 -1 -1 UPLOAD "private conferences:employee lounge:staff settings.fc" "staff settings.fc" FORMDOC examples To create a new user group called Executive Users, enter: NEW "Groups" "Executive Users" "" formdoc 23003 -1 -1 124 +p To create a new personal address called "Paul" in an existing address book, enter: NEW desktop sbram "address book" "Paul" "" formdoc 23004 -1 -1 105 The form ID of 21 (receive rule), 22 (send rule) or 23 (advanced rule) automatically creates the new rule in the container's rules folder. To create a new receive rule (form ID 21) for the Susan Bram's Mailbox with the standard icon (7027), enter: NEW desktop sbram mailbox "Receive Rule" "" 7027 -1 -1 21 To create a send rule, use form ID 22, to create an advanced rule use form ID 23. To create a new receive rule for the Employee Lounge conference, enter: NEW "private conferences:employee lounge" "Receive Rule" "" 7027 -1 -1 21 PERMS example The form must be available in the Admin > Add New Stationery menu. For example, to add a user-defined stationery, whose form ID is 1001, you would enter: NEW "Private Conferences:Employee Lounge" "Suggestions" "" PERMS 17044 -1 -1 1001 +p TEMPS examples These objects must be protected in order to function. To create these monitors, enter: NEW "Monitors" "Server Monitor" "" Temps 23007 -1 -1 7900 +p NEW "Internet Services" "Internet Monitor" "" Temps 23007 244 19 8900 +p NEW "Voice Services" "Voice Services Monitor" "" Temps 23007 244 19 7901 +p Sysinfo example The icon number is 23007. No form ID is required. The object must be protected in order to function. To create a session monitor, enter: NEW "FirstClass Services" "Session Monitor" "" SysInfo 23007 -1 -1 +p CONFITEM example To create a message in the Employee Lounge conference, enter: NEW "private conferences:employee lounge" "Susan A. Bram" "Away today" ConfItem 23032 273 21 0 MESSAGE example To create a message in Susan's Mailbox, enter: NEW DESKTOP sbram "mailbox" "Susan A. Bram" "Away today" Message 23032 273 21 0 DOCUMENT example To create a new personal web page document for Susan, enter: NEW DESKTOP sbram "home page folder" "Home Page" "" Document 23019 30 15 900 -U Related commands To fill in field data on objects created with the NEW command see the PUT command and the EXPORT command. Top PATHCHAR Changes the default path separator command when specifying objects using a path name. By default this character is a colon (:) but it 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. Can also be used to add a subject field as part of the path. Any object can contain a name and subject path, however, you will need to specify the path separator. Syntax PATHCHAR char Example To set the separator character to a slash and use it in a command, you would enter: PATHCHAR "/" NEW "Private Conferences/Employee Lounge" "Archived Messages""" CONFERENCE 8 41 15 +p You have a conference with two documents from Susan Bram but both documents have unique subjects. You cannot use the path "Employee Lounge:Susan Bram" because both documents would have the same path. To set the name separate to :, and the subject path separator to the / character, enter: PATHCHAR ":" "/" PUT "private conferences:employee lounge:Susan Bram/Presentations" 6 "Available Presentations" Top PGADD Adds a user, conference, mail list, or group calendar to one or more groups. Syntax •       for users:         PGADD userID G1 ... Gn •       for conferences, calendars, or mail lists         PGADD name G1 ... Gn Parameters userID         The user ID of the user who you want to assign to the user group(s). name                  The Directory name of the conference, mail list, or calendar. G1 ... Gn       The name(s) of the user group, conference group, or calendar group. Examples To add Sue Bram to the Employee and East Coast user groups, you would enter: PGADD sbram Employee "East Coast" To add Employee Lounge to the Employee Conferences group, you would enter: PGADD "Employee Lounge" "Employee Conferences" Related commands To add a user to a group at registration see ADD NETWORK/ADD TELECOM To remove a user, conference, mail list, or group calendar see PGDEL Top PGDEL Deletes a user, conference, mail list, or calendar group from one or more groups. Syntax •       for users:         PGDEL userID G1 ... Gn •       for conferences, calendars, or mail lists:         PGDEL name G1 ... Gn Parameters userID         The user ID of the user who you want to remove from the user group(s). name                  The Directory name of the conference, mail list, or calendar. G1 ... Gn       The name(s) of the user group, conference group, mail list, or calendar. Examples To remove sbram from the East Coast user group, you would enter: PGDEL sbram "East Coast" To remove Employee Lounge from the Employee Conferences group, you would enter: PGDEL "Employee Lounge" "Employee Conferences" Related commands To add a user, conference, calendar, or mail list to a group see PGADD. Top PUT Updates FirstClass forms at the field level. The PUT command requires a field ID, fieldtype, and fieldvalue. The GET command can be used to generate the fieldtype and fieldvalue. The field IDs can be found in Example.fc. Syntax PUT objdesc fieldlist +a •       When used to insert address fields:         PUT objdesc addressID index address Parameters objdesc                       Describes the target. USER userID     User information form specified by the userID CLIENT clientID The user information form specified by the client ID. The Directory form of remote names and routes. USERCONFIG userid              The Mail Import form, available from the user info form. path                         A form, message or document specified by the path, relative to the administrator’s Desktop. Separate the components of the path with colons. Path is the default object type; if no objdesc is included, PATH is used. DESKTOP userid path     A form, message, or document specified by a path relative to the user’s Desktop. DIRECTORY directorytype                                     Directory form of conferences (ODInfo), folders (ODInfo), gateways (ODGateway)and user groups (ODInfo). Directory type keywords are conference, calendar, maillist, and group PROPERTIES path         The Info form. The path is relative to the administrator's Desktop. PROPERTIES desktop userid path         The Info form. The path is relative to the user's Desktop. PREFERENCES userid      A user’s Preferences form and Print Layout form. RESUME userid   A user’s résumé. ABOUT name             A conference or calendar résumé. RULES path rulename     A form within a container's rule folder. Path is relative to the admin's Desktop. RULES DESKTOP userid path rulename      A form within a container's rule folder. Path is relative to the user's Desktop. SEARCH userid   A user’s search form. SYSPROFILE             The System Profile. fieldlist              A list of field descriptor triplets of the form:         fieldID fieldtype fieldvalue         fieldID               The field ID.         fieldtype      The field type. Supports:                                           0=String; includes fields defined as text and editable lists.                                     6=CheckBox; includes fields defined as checkboxes or radio groups.                                     7=Popup; includes fields defined as static lists and icons.                                     14=Number, includes fields defined as numeric or date & time.                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. +a                           Used only to append the body of a message, or document. addressID       "To" field is 4, "Cc" field is 5, "Bcc" field is 14. Do not use the field ID displayed in FirstClass Designer for these fields. 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, email address, conference, or remote name. If a unique name is not provided, the first matching name is used. PUT USER examples The USER object type changes the user info form. To change a user’s first name (field ID 1202) from Susan to Sue and her password (field ID 1217) to carrot enter: PUT USER sbram 1202 0 Sue 1217 0 carrot To change Sue from a remote user to regular user, enter: PUT USER sbram 1223 7 1 To change Sue from a regular user to a remote user, enter: PUT USER sbram 1223 7 5 To add a mail alias (field ID 1252), Voice DN (field ID 1255), and Voice password (field ID 1256) for Susan, enter: PUT USER sbram 1252 0 "sabram" 1255 0 9055551212 1256 0 1212 The user ID can be changed by the administrator, however, the client ID can never be changed, nor is the number ever reused. Systems administrated solely by batch administration and external databases may prefer to use client ID. Susan Bram's client ID is 1602. To add a mail alias (field ID 1252), Voice DN (field ID 1255), and Voice password (field ID 1256) for client ID 1602, enter: PUT CLIENT 1602 1252 0 "sabram" 1255 0 9055551212 1256 0 1212 The client ID can also be used to update information on the Directory forms including those supported by the DIRECTORY keyword. The CLIENT keyword allows you to update information on the Directory form of remote names and routes. To add a mail alias to a Remote name with the client ID of 1956, enter PUT CLIENT 1956 1252 0 "royallen" Note Use the List Directory to obtain the correct client ID. PUT DIRECTORY example To add a mail alias (field ID 1252) and Voice DN (field ID 1255) for the Employee Lounge conference, enter: PUT DIRECTORY CONFERENCE "Employee Lounge" 1252 0 "lounge" 1255 0 9055551212 Note Use PGADD and PGDEL to update group membership. For addititional fields see the Example.fc file.  The user info form is form ID 125, ODInfo is form ID 115. PUT USERCONFIG example The USERCONFIG object type updates the Mail Import form. To add the icon ID (field ID 2005), mail server (field ID 2000), user name (field ID 2001), password (field ID 2002), email address (field ID 2003) to Susan's Internet Import form, enter: PUT USERCONFIG sbram 2005 14 8 2000 0 springfield.com 2001 0 suebram57 2002 0 f1504x2 2003 0 suebram57@springfield.com  For additional field IDs, see Mail Import Setup (form ID 68) included with Example.fc. PUT PATH examples The PATH object type updates a form, document, or message. For example, the command can be used to change fields in user groups, gateway settings, address books, and mail list forms. To change fields in the View Properties form see the SNAPSHOT command. To fill in the primary domain name in the Basic Internet Setup from, enter: PUT PATH "internet services:basic internet setup" 1001 0 huskyplanes.com To take away Chat from the All Users group, enter: PUT PATH "Groups:All Users" 1206 6 0 To enter information in a text field on a custom form you have created enter: PUT PATH "Private Conferences:Employee 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 an existing mail list enter: PUT PATH "Mail Lists:Sales" 4 0 "David Smith" PUT PATH "Mail Lists:Sales" 4 1 "sbram@springfield.com" 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: FirstClass consists of two parts: a client application (you) and 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 FirstClass server to which you want to connect • you must have FirstClass installed on your computer. you would submit the following commands. The +a appends the message body, and the \r enters a carriage return: PUT "test:body" 6 "FirstClass consists of two parts: a client application (you) and a server application.\r \r" PUT "test:body" 6 "To connect to a particular server:\r" +a PUT "test:body" 6 "- there must be a network or modem connection between your computer and the computer that is running" +a PUT "test:body" 6  "the FirstClass server to which you want to connect\r" +a PUT "test:body" 6 "- you must have FirstClass installed on your computer." +a Note To create styled text and graphics, see the EXPORT command. PUT DESKTOP userid examples The DESKTOP object type updates forms, such as personal address books, personal mail lists, documents, messages, and stationery forms, at the field level, relative to the user’s Desktop. Sue Bram has a Presentations conference on her Desktop and you want to update a Phone Call form contained in the conference. To enter information in the Of: field (field ID 1012) enter: PUT DESKTOP sbram "Presentations:To Paul" 1012 0 "Springfield" To fill in the "To" field on a stationery form, use the syntax for address fields. To insert the first addressee (paulchu@springfield.edu), enter: PUT DESKTOP sbram "Presentations:To Paul" 4 0 "paulchu@springfield.edu" To set Sue Bram's Desktop to use a picture called desktop.png  (field ID 13083), enable the Use Background Picture field and disable the Tile background which are both controlled by field ID 13082: PUT DESKTOP sbram "" 13082 7 112 13083 0 "desktop.png" To specify the Desktop at the path use two quotation marks. PUT PROPERTIES examples The PROPERTIES object type changes the Info form. The path is relative to the administrator's Desktop. To protect an existing conference, enter: PUT PROPERTIES "Private Conferences:Employee Lounge" 1016 6 1 To unprotect an existing conference, enter: PUT PROPERTIES "Private Conferences:Employee Lounge" 1016 6 0 To make the conference open automatically, enter: PUT PROPERTIES "Private Conferences:Customer Support" 1015 6 1 For example, to change the horizontal (field ID 1306) and vertical (field ID 1307) position of the Employee Lounge conference, enter: PUT PROPERTIES "Private Conferences:Employee Lounge" 1306 14 205 1307 14 5 PUT PROPERTIES DESKTOP userid examples The PROPERTIES DESKTOP userid object type changes the Info form. The path is relative to the user's Desktop. To unprotect Sue Bram's Presentations conference, enter: PUT PROPERTIES DESKTOP sbram "presentations" 1016 6 0 PUT PREFERENCES example The PREFERENCES object type updates a user’s Preferences form. You can change any field with field IDs less then 10000. To set sbram's Reply preference to Reply to Sender, enter: PUT PREFERENCES sbram 1107 7 2 To set the first line of Sue Bram's signature (field ID 1109) to "Sue Bram", the second line to "Husky Planes" and enable the Automatically add signature to new message field (field ID 1108), enter: PUT PREFERENCES sbram 1109 0 "Sue Bram\rHusky Planes" 1108 6 1 The \r enters a carriage return. To disable sbram's Print envelope (field ID 4508) on the Print Layout form (form ID 180), enter PUT PREFERENCES sbram 4508 6 0 PUT RESUME example The RESUME object type changes a user's Résumé form. 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. To add Sue Bram's name, enter: PUT RESUME sbram 1000 0 "Susan Bram, Extension 1212" To add content to this résumé, enter: PUT RESUME sbram 6 "My name is Susan Bram, and I have worked for Husky Planes for 5 years.\r\rMy normal hours are 0700 to 1500" The /r inserts a carriage return. To append content to this résumé, enter: PUT RESUME sbram 6 "If you need help outside my normal hours, please contact Paul Chu." +a PUT ABOUT example To fill in the About Conference form (also known as a conference résumé) for the Employee Lounge conference, enter: PUT ABOUT "employee lounge" 1000 0 "About the Employee Lounge" 6 "This conference is used to share ideas and knowledge." The About Conference form can be appended with the +a option. PUT RULES example To disable the Employee Lounge's advanced rule called "File by Subject", enter: PUT RULES "private conferences:employee lounge" "file by subject" 13800 6 0 To disable Susan Bram's Mailbox's advanced rule called "File by Subject", enter: PUT RULES DESKTOP sbram "Mailbox" "file by subject" 13800 6 0 PUT SEARCH userID example The SEARCH object type sets the parameters on the search form. To set sbram's search form to search subconferences and folders, enter: PUT SEARCH sbram 1204 6 1 PUT SYSPROFILE example The SYSPROFILE object type updates fields on the System Profile form. To set the server priority to High, enter: PUT SYSPROFILE 1226 7 0 To change the priority to Medium, the fieldvalue would be 1, and for Low priority, the fieldvalue would be 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. A fieldvalue of 60 would be 60 seconds, not 60 days. The GET command can help you create PUT commands.  For example, if you wanted to add a voice DN (field ID 1255) and voice password (field ID 1256) to all your users, you could use the GET command to help you create the PUT syntax. 1       Open Example.fc using FirstClass Designer. 2       Open the User Data form (form ID 125) to look up the field IDs. 3       Fill in the Voice DN and Voice password of any user. 4       Send a GET command: REPLY GET USER sbram 1255 1256 The server will return the field ID, field type and field value: 1255 0 "9055551212" 1256 0 "1212" 5       Compose the PUT command by replacing the field value with appropriate data. To add a voice DN and voice password to Paul Chu's account: PUT USER pchu 1255 0 "9055551213" 1256 0 "1213" If you create an object, and then fill in the field contents, you can use Previous to substitute for the path. For example, if you created a user group and wanted to set the Organizational Unit (field ID 1272) to Department, enter: New groups "Employee" "" FormDoc 23003 3 302 124 Put Previous 1272 7 600 Top PUT PERMISSIONS The PERMISSIONS object type updates the fields on the conference Permissions form, the Mailbox Permissions form, and the calendar Permissions form. 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 Mailbox, conference or calendar. Each form has its own syntax. The EXPORT command can be used to extract the permissions of an existing conference or calendar. Syntax •        for "Who", "Access", and "Permissions" field (29) on the Permissions form for conference or calendar groups: Note The field ID for setting both the "Who" and "Access" fields is 29. Both parameters are set at the same time. PUT PERMISSIONS MODEL conferencegroup path 29 index name fieldvalue •        for other fields on the Permissions form for a conference or calendar group: PUT PERMISSIONS MODEL groupname path fieldlist •        for "Who', "Access", and "Permissions" field (29) on the Permissions form for a conference or calendar Note The field ID for setting both the "Who" and "Access" fields is 29. Both parameters are set at the same time. PUT PERMISSIONS path 29 index name fieldvalue •        for other fields on the Permissions form for a conference or calendar 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. groupname       The name of the conference group or calendar group. index                 The position to insert in the list. Use 0 for the first name, 1 for the second name, and so on. fieldlist       A list of field descriptor triplets of the form: fieldID fieldtype fieldvalue fieldID                The field ID. fieldtype       The field type. Supports:                                    0=String, includes fields defined as text and editable lists.                              6=CheckBox, includes fields defined checkboxex and radio groups.                              7=Popup, includes fields defined as a static lists and icons.                              14=Number, includes fields defined as numeric and date & time. 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 Conferences" so that the Employee group is a contributor, type the following: PUT PERMISSIONS MODEL "employee conferences" "" 29 0 "Employee" 87552 Note The path is always represented by empty quotation marks. To set the permissions for the Employee Lounge conference so the Employee group members are contributors and All Users are disallowed, enter the following: PUT PERMISSIONS "private conferences:employee lounge" 29 0 "employee" 87552 29 1 "all users" 0 To create custom permissions, add the values of all the permissions you want assigned to the user, group, or gateway as the value of fieldvalue. The value of the send permission is 2048 and the value of Delete own items is 256.  Adding these two values together will give you a field value of 2304. To set the permissions of the Employee Lounge conference to enable all users to send and delete their own mail, enter: PUT PERMISSIONS "private conferences:employee lounge" 29 0 "all users" 2304 To set the permissions of the Employee Conferences group to enable the employees to send and delete their own mail, enter: PUT PERMISSIONS MODEL "Employee Conferences" "" 29 0 "Employee UG" 2304 To set the permissions of Susan Bram's Mailbox so Paul Chu to Send and Unsend, you would enter PUT PERMISSIONS desktop sbram mailbox 29 0 "Paul Chu" 2304 To stop Susan Bram from recieving any Internet mail, enter the following: PUT PERMISSIONS desktop sbram mailbox 29 0 "internet" 0 Field values 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 Field values for individual conference permissions:         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 and attachments         32768         View permissions         65536         View history To create custom permissions add the values of all the permissions you want assign to the user, group, or gateway as the fieldvalue. Field values for preset calendar permissions:         Value                Permission Set         0                           No Access         2097152               See Times         2304                 Schedule Only         2099456               Schedule+Times         2100992               Schedule+Details         2219821               Editor Field values for individual calendar permissions:         Value                Permission         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 The form ID of the Phone Call form is 128. To set the "Form to use" field (field ID 2008) to the Phone Call form on the Permissions form of a conference called Employee Lounge, enter: PUT PERMISSIONS "Private Conferences:Employee Lounge" 2008 14 128 The form ID of the Phone Call form is 128. To set the "Form to use" field (field ID 2008) to the Phone Call form on the Permissions form of a conference group called Employee Read, enter: PUT PERMISSIONS MODEL "Employee Conferences" "" 2008 14 128 Notes The conference Permissions form is called ACL, form ID 103 in Example.fc. Calendar Permissions is form ID 64, Conference Group Permissions is form ID 100, Calendar Group Permissions is form ID 63. Fields not supported: •        Messages require approval •       Attachments require approval •  Use Layout from server •  Message Expiry Related commands To fully update the Permissions form, four commands are required. The About button gives you access to the conference's Résumé. Use PUT ABOUT <conference name> to update. The Directory info button gives you access to the Directory form. Use PUT DIRECTORY CONFERENCE <conference name> or Use PUT DIRECTORY CALENDAR <calendar name> to update. The subscription list is updated with the LINK USER command. The group membership is updated with the PGADD or PGDEL command. Top PW Sends the batch administration password to the batch administration component Syntax PW password Parameter password        The password (maximum 12 characters). Example If the batch admin password is f1504x2s, and if you are not the administrator, enter: PW f1504x2s Note If you are not the administrator, you must submit the password before any other commands. If you do not, your commands are not processed. Top REMOVE Deletes an object Notes •       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 targetpath 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  The user ID of the user from whom you want to remove items. Path is relative to the user's 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 pchu’s Desktop, enter: REMOVE DESKTOP pchu "Home Page Folder:index.html REMOVE DESKTOP pchu "Home Page Folder" Top RENAME Renames an object on the administrator’s Desktop. Syntax RENAME targetpath objname Parameters targetpath      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. RENAME DESKTOP userID   The path 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. objname                The new name of the object. Example To rename a conference from Employee Lounge to Staff Lounge, enter: RENAME “Private Conferences:employee lounge” “Staff Lounge” To rename a conference on sbram’s Desktop from Presentations to Presentations Archive, enter: RENAME DESKTOP sbram "Presentations" "Presenations Archive" If the Presentations conference is protected, you will need to unprotect it first with the PUT PROPERTIES DESKTOP command.   To unprotect sbram's Presentations conference, rename it to Presentations Archive, then protect the conference again, enter: PUT PROPERTIES DESKTOP sbram "presentations" 1016 6 0 RENAME DESKTOP sbram "Presentations" "Presentations Archive" PUT PROPERTIES DESKTOP sbram "presentations archrive" 1016 6 1 Top REPLY Requests generated output to be sent back to you as a reply. It must be used with the GET, GETADMIN, SNAPSHOT, 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 To send the reply to another Mailbox, use the syntax: REPLY name Parameters name    a name from the FirstClass Directory as it would appear if you were addressing mail to that individual or conference. Example To produce and export a list of all users, and to view the output as a message, enter: REPLY LIST +ur Top SETOU Specifies to which group a user will be added. Syntax SETOU Example To add another user called Susan A Bram to the Consultant group, you would enter: SETOU consultant add network susan susan a bram "" carrot Top SNAPSHOT Returns the view properties of a conference in the format of a PUT command. The EXPORT command generates a script that can include view properties. Syntax REPLY SNAPSHOT targetpath Parameter targetpath      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: 1       Configure the view properties of a conference, including split, size, column order, column width, where it appears on the computer desktop, in addition to the choices presented on the View Properties form. 2       Enter the following command: REPLY SNAPSHOT "Private Conferences:Employee Lounge" The server returns the following information (comments are not included): \\size and location of window, split location and size, column position and location Put "private conferences:employee lounge"  900 51 901 271 902 10 903 621 904 735 Put "private conferences:employee lounge"  13000.0 122 0008000500100009000C000A000C0007008200060028FFFD000E000800DC00020064 -S \\View properties of upper window Put "private conferences:employee lounge"  13075.0 7 8 13016.0 7 0 13015.0 0 "" 13065.0 14 -2147483646 13062.0 7 13 13063.0 7 13 13064.0 7 0 13074.0 7 2 13084.0 7 1 13053.0 7 0 13003.0 7 24 13082.0 7 80 13083.0 0 "l_pane1.png" Put "private conferences:employee lounge"  1101.0 14 10289154 Put "private conferences:employee lounge"  13100.0 122 0007000500100009000C000A000C0007008200060028000800DC00020064 -S \\View properties of lower window Put "private conferences:employee lounge"  13175.0 7 -1 13116.0 7 0 13115.0 0 "" 13165.0 7 8 13162.0 7 13 13163.0 7 13 13164.0 7 0 13174.0 7 0 13184.0 7 0 13153.0 7 0 13103.0 7 24 13182.0 7 32 13183.0 0 "" 3       Forward the message sent by the server, and address the new message to Batch Admin. 4       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 path. For example, to apply the same view properties to Susan's, you'd change the path from PUT "private conference:employee lounge" to PUT DESKTOP sbram "" The quotation marks represent the path of the Desktop. Top UPLOAD Uploads a file to a conference or folder. Both the NEW command and the UPLOAD command are required. Syntax UPLOAD path name +b Parameters path           PATH name           The name of the file, including any extensions. +b                    Uploads a file contained in 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 file: NEW "private conferences:employee lounge" "staff settings.fc" "" FCF 17044-1 -1 UPLOAD "private conferences:employee lounge:staff settings.fc" "staff settings.fc" To upload the staff settings.fc file contained in the Batch folder, within the FirstClass Post Office, enter: NEW "private conferences:employee lounge" "staff settings.fc" "" FCF 17044-1 -1 UPLOAD "private conferences:employee lounge:staff settings.fc" "staff settings.fc" +b Top WRITE Specifies text that you want sent back to the administrator’s Mailbox in reply to a batch command Syntax WRITE text Note You can enter a maximum of 255 characters. Example When you use the REPLY and NEW batch commands to create a conference, FirstClass sends you a reply only if the conference was not created correctly. However, you may want to receive a message indicating the batch administration command has completed. To achive this, enter: REPLY NEW "Private Conferences:Employee Lounge" "" CONFERENCE 13107 10 10 WRITE Command completed. Top