Export

Writes the entire datastore for the specified repository to a text or XML file.

NOTE: OmniGroupServer cannot import data that is exported in XML format.

This action generates individual user data in a single block where a user has alternative names.

For detailed information about the text file format, see the file textgsexample.txt. This file is installed in the InstallationDir\TextDir directory when you install OmniGroupServer with the Text component enabled.

Example

To write the data in the NT repository to a file in text format:

http://localhost:3057/action=Export&repository=NT&filename=export.txt

To write the data in the NT repository to a file in XML format:

http://localhost:3057/action=Export&repository=NT&filename=export.xml&format=XML

Parameters

Parameter Description Required
EncryptResponse Encrypt the output.  
FileName The file to which the datastore is written. Yes
ForceTemplateRefresh Forces the server to load the template from disk.  
Format The output format for the file, TEXT or XML.  
Repository The repository of the datastore that you want to export. Yes
Template The template to use for the action output.  
TemplateParamCSVs A list of variables to use for the specified template.  

CAUTION: Do not set the output action parameter with this action.

See Also