|
Summary
Import-TopicMap [-TopicMapAddress] <Uri> [-FilePath] <String> [-BaseUri] <String> [-Follow] [-DefaultLanguage] <String>
Description
Imports topic map data into a topic map from an XTM 1.0 or XTM 2.0 file. The import works be creating a long-running import task on the topic map and uploading the XTM data to the server for processing. To use this command successfully the user must have the Create Job privilege on the topic map store.
Parameters
| • | TopicMapAddress <Uri>
The web address of the topic map to import into. This is a positional parameter - it must appear as the first parameter and the parameter name can be omitted. |
| • | FilePath <String>
The path to the XTM file to be imported. This is a positional parameter - it must appear as the second parameter and the parameter name can be omitted. |
| • | BaseUri <String>
The base URI used to resolve any relative references in the imported XTM data. This is a positional parameter - it must appear as the third parameter and the parameter name can be omitted. |
| • | Follow
This is an optional parameter. If specified on the command-line the command will monitor the progress of the processing job, displaying the current job status message as a Powershell progress message (usually displayed at the top of the Powershell screen), and not returning until the job has completed processing (either with or without errors). If omitted from the command-line then the command will return immediately after creating the import job without waiting to see if the job processing was successful. In this latter case you can use the Get-TopicMapJobs command to monitor progress manually. |
| • | DefaultLanguage
This is an optional parameter. If present it must be a two-letter ISO language code or a two-letter language code followed by a dash and a two-letter ISO country code (e.g. en, en-us, fr, fr-ca etc.). This parameter specifies the language code that will be assigned to topic labels generated by the import processor. If omitted from the command-line, the language code for the current user environment will be used by default. |
Returns
If the -Follow parameter is omitted, the command will return the web address of the import job. If the -Follow parameter is specified on the command-line then the command will not produce any return value.
|