Create new report
Syntax
Publish -cnr -f Path [-l LanguageCode] [-r ParentReportFolderPath] [-n UserOrGroupName] [-rt ReportTitle] [-c {a|c}] [-e] [-h] [-date "YYYY-MM-DD HH:mm:SS"] [-msg LanguageCode]
Note: The file from which you want to create a new report must already have been published. For more information, see
Publish files in the WDS Online Publisher help.
Examples
- Publish -cnr -f "F:\SharedFolder\bulk1\Table 1.ivt" -l fra -n bill –r B2RTest1/F2f
-Owner is the user "bill," report is in French only. - Publish -cnr -f "F:\SharedFolder\bulk1\Table 1.ivt" -n group1 –r F3f/F4f
-Owner is a group, report is created in all supported languages
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 |
-cnr | Yes | Creates a new report for a file. |
-f Path | Yes | The complete path to the file from which a report will be created. All folders in the path should be separated with back slashes (\). If the path contains any spaces, enclose it in double quotes ("). |
-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 |
-r ParentReportFolderPath | No | Specifies the path to the folder where the report 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 (/). For example, -r folder1/folder2 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. |
-n UserOrGroupName | No | Specifies the name of the user or group which will own the updated 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. |
-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.) |
-h | No | Specifies that the reports which are being created will remain hidden until they are unhidden using the online publisher. |
-date "YYYY-MM-DD | 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 MessageLanguageCode | 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: