EXPORT
Examples
Function
Generates a cross-platform FirstClass script based on existing objects on your server. Only the Admin account can submit EXPORT commands. Separate the components of the path with colons. The PATHCHAR command can be used to change the default path character.
Membership lists and group membership are not included in script returned by the server.
Syntax
For generating a script:
EXPORT path name +rnpe -cv
For generating and executing a script:
EXPORT path address ScriptPassword objDesc +b
Parameters
path |
Target path is relative to the administrator's Desktop. |
Desktop userID path |
Target path is relative to the user's Desktop. |
name |
The Directory name of the user or conference. The script is returned to the sender if the name parameter is not included. Optional. |
address |
The name of the user that processes the batch admin command. Typically, within the same server, the parameter would be "batch admin". |
ScriptPassword |
The password required to process scripting commands. Optional. |
objdesc |
The target path. |
+r |
Recursive: exports subconferences and subfolders. |
+b |
Processes the script immediately. Used only with when generating and exporting objects in a single step. |
+g |
Exports the contents of resources folder, the view properties of the model view and permissions of a container template group. Exports the contents of the resources folder and view properties of a user group. |
+h |
Includes history records. |
+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. Does not include membership lists or group membership. |
+e |
Includes container custom column forms, rules, and resources. |
-c |
Excludes messages, documents, and files. |
-v |
Excludes view properties. |
-m |
Excludes last modified date. When the import script is run, object will be created with the current date. |
-f |
Excludes folder creations to allow importing into a single container. |
Procedure
To use the EXPORT command:
1 Send a message addressed to Batch Admin 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 manually with 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.
EXPORT will not include:
• aliases of folders, conferences, or calendars (use LINK SPECIAL to recreate)
• The Who section of the permission form can be included with the script, however conference group membership and the list of members are not included.
If you are sending the outgoing 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.
Note
See SETEXPORTFILTERS for instructions on how to limit the import script based on last modified or thread ID. See SETEXPORTOPTIONS for instruction on how choose the attachment name.
Examples
Exporting a conference with various options
The Employee Lounge conference is located in the General 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 "general conferences:Employee Lounge" +r
To generate and process the script in one step, you would enter:
EXPORT "general conferences:employee lounge" "batch admin" "" "general 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 "general 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 "general 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 "general 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 "general 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 "general 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 "general conferences:Employee Lounge" +nper -cv
To have the server return a script to create a container template including its model view and the contents of Student Conferences group, enter
EXPORT "groups:Student Conferences" +g
Exporting contents from a Desktop
To export the contents of sbram's Contacts folder to pchu's Contacts folder, submit the following command:
EXPORT DESKTOP sbram "Contacts"
When the server returns the script, forward the message and replace <ObjDesc> with the following:
DESKTOP pchu "Contacts"
To export the contents of sbram's Contacts folder to pchu's Contacts folder in one step, submit the following command:
EXPORT DESKTOP sbram "Contacts" "batch admin" "" DESKTOP pchu "Contacts" +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
Exporting rules
Rules have limited support with FC Scripting, you are able to create and modify existing rules, but FC Scripting does not support the deletion of rules.
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:
• change the <ObjDesc> to DESKTOP pchu
• comment out the commands that create the mailbox and set the permissions
• add command to create Conference Mail folder within Paul's Mailbox:
//add a folder to mailbox
NEW DESKTOP pchu "mailbox" "Conference Mail" "" folder 26093 -1 -1
SetBase DESKTOP pchu
SetRelative FromBase Path ""
//New Relative "" "MailBox" "" Conference 23009 60 57 +P
//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:20134
New Relative "" "File in Folder" "" FormDoc 23047 112 15 23 23 -U+X
Put Previous 8120 7 1252 8140 0 8141 0 9 ""
Put Previous 13801.0 7 1 13810.0 7 11 13806.0 7 21 13821.0 7 2 13830.0 7 1 13832.0 0 "Conference Mail"
Put Properties Previous 13801 7 1
Put Properties Previous 13830 7 1
Put Properties Previous 1018 14 -1127673958
Compile Relative ""
SetRelative FromBase Path ""
Exporting group information
User groups and container templates groups consist of a group form, but they may also contain permissions, view properties and resources.
This command would simply return a script that would recreate a group form:
EXPORT "groups:employee"
For a user group, this command would return a script that would recreate a user group form and the view properties of the model desktop and the contents of the resources folder:
EXPORT "groups:employee" +g
For a container template group, this command return a script that would recreate a container template form and the permissions, the view properties of the model view and the contents of the resources folder:
EXPORT "groups:employee read conferences" +g
| 