Publish
Syntax
Publish {hr | sr} -f Path {-a | -i | -x[q]} [-e] [-l LanguageCode] [-r ReportFolderPath] [-n UserOrGroupName] [-rt ReportTitle] [-c {a|c}] [-b] [-h] [-date "YYYY-MM-DD HH:mm:SS"] [-msg LanguageCode]
Examples
- publish -f d:\data\sample.ivt -a -e
-Adds the file "sample.ivt" to the current WDS site. It is an "Empty" table with no dimension selections, which will open on the WDS Item selection page. - publish -f d:\data\sample.pdf -a -l fra,deu
-Adds the PDF file "sample.pdf" to the current WDS site, for French and German only.
Command reference
Name | Required | Notes |
publish | Yes | The name of the executable. It is located in the \bin directory of a WDS site. For example, the following is a typical location: · \WDS 8.2\wds82_1\bin\Publish.exe |
-hr | -sr | No | Used to hide or show the file specified in -f Path. The file to be shown or hidden must already have been published. |
-f Path | Yes | The complete path to the table or other file to be processed, or to an input file that lists the files or folders to be processed. All folders in the path should be separated with back slashes (\). If the path contains any spaces, enclose it in double quotes ("). File names may contain the following wildcard characters: ? to represent a single character, and * to represent one or more characters. If the -b argument ("use input file") is used, FilePath must refer to a text file that contains the names and full paths to the files that are to be added. File names listed in the input file must be separated by a linefeed character or a carriage return/linefeed pair. They cannot contain wildcards. For example, the contents of an input file might appear as follows: C:\Program Files\Beyond 2020\WDS 8.2\wds82_1\Data\DIABBZ.ivt C:\Program Files\Beyond 2020\WDS 8.2\wds82_1\Data\Sample.ivt |
-a | No | Adds the specified table or other file. Uses the table title in each language as the default report name for that language. (If the IVT is missing one of the WDS languages, the report name for the missing language will be the table title in the default IVT language.) |
-i | No | Imports a folder and its contents, including subfolders and their contents. Cannot be used with -c. |
-x[q] | No | Deletes the specified file. q (optional), immediately following the -x command, specifies that the delete command is to be carried out quietly without prompting for confirmation. Otherwise each deletion will produce a message asking you to choose whether to continue or to abort the operation. |
-e | No | Specifies that the report will have an empty default view. That is, no dimension items will be selected in the report. The report will open on the Item Selection page of WDS so the user can select dimension items and create their own report. (This command can only be used when adding an IVT.) |
-l LanguageCode | No | Specifies that the file being added will be associated with one or more of the supported languages. The file being added must be one of the publishable file types listed in the mime_map table of the WDS repository. This command is often used to provide separate PDF files for each supported language. LanguageCode must be one or more of the comma-separated values found in the Preferences table for the SupportedLanguages key in the site's repository, such as eng (English), fra (French), deu (German) or esn (Spanish). (For example, -l eng,deu,esn) |
-r ReportFolderPath | No | Specifies the path to the folder where the report or folder will be created. If this option is not present, the report will be added to the root folder of the specified user or group (if the -n option is used), or else to the public reports folder. If the path contains any spaces, enclose it in double quotes ("). The path should not include the report name or the name of the root folder. All folders in the path should be separated with forward slashes (/). Report and folder names should not contain slashes. The folder must exist. It will not be created. If the folder does not exist, the command will fail with a message that the specified folder was not found. The report folder name is language dependent. If more than one folder exists with the same name, whether or not they are in the same language, the first one that is found by the search algorithm will be used. To sort reports into folders named after their authors or their categories, see the -c ("category") argument, below. |
-n UserOrGroupName | No | Specifies the name of the user or group which will own the added report. If this option is not present, the owner of the report will be administrator and the report will be a public report. (This is also the case if administrator is specified for UserOrGroupName.) |
-rt ReportTitle | No | Specifies a title for the added report. · If used you must provide a title for each language in which the report is being published, as specifed in the -l LanguageCode command. Specify titles in the form "-rt eng "Name" fra "Nom" deu "Name" esn "Nombre"" · Not used with -b. |
-c {a|c} | No | Publishes tables or files into folders that are named for their authors or their categories. The folders will be created. Can be used in combination with the -r argument, above, to create a folder structure inside a user or group folder. (If the tables or files do not have a valid author or category property they will still be added, but folders will not be created.) (Note that to duplicate an existing folder structure you can use the "import" command instead. See Importing folders.) Cannot be used with -i. The -c option requires one of the following arguments: a -Adds the files into folders that are named for their authors. c -Adds the files into folders that are named for their categories. |
-b | No | Processes all the files that are listed in the input file named in the -f argument. |
-h | No | Specifies that the files which are being added (-a) or imported (-i) will remain hidden until they are unhidden using the online publisher. |
-date "YYYY-MM-DD HH:mm:SS" | No | The publishing date. The format must be as shown. For example, 2010-06-29 05:30:00 specifies that the files will be published on June 29, 2010, at 5:30 AM. |
-msg LanguageCode | No | Specifies the language in which publishing messages will appear. For example, -msg fra specifies that feedback messages in the command prompt window, such as "Report successfully added" or "Path not found," will appear in French. If not present, messages appear in the language that is specified in the operating system's "Regional and language options." (If no valid language information is found, defaults to English.) Note that errors which occur while parsing a command will appear in English. This is because at that time in the publishing process, the language resource files have not yet been initialized. |
See also:
Publishing from the command line