List of AFExport utility parameters
- Last UpdatedDec 16, 2024
- 2 minute read
- PI System
- PI Server 2024 R2
- PI Server
The AFExport utility supports the following parameters.
|
Parameter |
Short form |
Description |
|---|---|---|
|
Path Additional details and examples follow this table. |
Path to the object that you wish to export. Typically of the form: \\afserver\database. Use '.' to export the default database. See List of sample export paths. |
|
|
/File:string |
/F |
Specify an output file. If not specified, then the output is streamed to the console. |
|
/StartTime:string |
/T |
Specify a start time to cause event frames, transfers, and cases to be exported that are between the start and end times specified. |
|
/EndTime:string |
/E |
Specify an end time when exporting event frames, transfers, and cases. |
|
/AllReferences[-] |
/A |
Export any referenced object from the specified PI AF object. This parameter cannot be used with the No References parameter. |
|
/NoReferences[-] |
/N |
Do not export any referenced objects, including child objects. This parameter cannot be used with the All References parameter. |
|
/DefaultValues[-] |
/D |
When this parameter is not specified, then properties that are set to the default values are not exported, resulting in a substantially smaller export file. Importing a file without default values over existing objects may result in values not being reset to their defaults. |
|
/Library[-] |
/L |
Export only the library objects from a database. Library objects include all categories, templates, enumeration sets, reference types, and tables. |
|
/Security[-] |
/Y |
Export security information. Exporting security information will increase both export time and subsequent import times. |
|
/SimplifiedConfigStrings[-] |
/Sc |
Export configuration strings for attribute templates or attributes derived from attribute templates without substituting parameters and do not export UniqueIDs or point identifiers in the configuration strings. |
|
/UniqueIDs[-] |
/U |
Export unique IDs of all objects. This allows the renaming of objects when imported back into the same database. This parameter increases the size of the output file and may increase the amount of time required to import. |
|
/Silent[-] |
/S |
Silent mode. Prevents informational messages from being displayed. If no output file is specified, this option is automatically chosen. |
|
/Summary[-] |
/M |
Summary mode. Output only minimal information on progress. This parameter is not valid with the Silent mode or if no output file is specified. |
|
/User:string |
/user |
Use to specify a different Windows user account to connect to the PI AF server. |
|
/Password:string |
/pw |
If a user name is specified, specify the network credentials password. |
|
/Version |
/V |
Use to display version information. All other parameters are ignored. |
|
/Flat[-] |
/flat |
Export hierarchical object in a flat format. Exporting in a flat style can make editing in some tools simpler. Hierarchical objects that will be exported flat are attributes, attribute templates, elements, and event frames. |
|
/Paste[-] |
/Pa |
Paste operation behaves as a typical copy/paste. |
|
/?, /help |
Prints the contents of this table. |
|
|
@file |
Use the specified file to provide additional input arguments. The file should contain one argument per line. Comment lines start with the # character. |