SAVEASXML Function (Reports)

Saves a report as an .xml file on the computer that is running Microsoft Dynamics NAV Server.

Syntax


[Ok :=] REPORT.SAVEASXML(Number, FileName[, Record])  
[Ok :=] ReportVariable.SAVEASXML(FileName)  

Parameters

Number
Type: Integer

The ID of the report that you want to run. From the C/AL Editor, on the View menu, choose C/AL Symbol Menu to select the report from a list.

If the report you specify does not exist, then a run-time error occurs.

FileName
Type: Text

The path and the name of the file that you want to save the report as. The path must exist, the file must not be being used, and the Microsoft Dynamics NAV Server must have permission to write to the file. Otherwise, you will get errors.

Tip

If you call this function from a Dynamics NAV client, such as from an action on a page, then you can use the DOWNLOAD Function (File) to send the .xml file from the computer that is running Microsoft Dynamics NAV Server to the computer that is running the Dynamics NAV client.

Record
Type: Record

Specifies which record to use in the report. Any filters that have been applied to the record that you specify will be used.

ReportVariable
The report that you want to run.

Property Value/Return Value

Type: Boolean

If you omit this optional return value, then run-time errors can occur. If you include a return value, then it is assumed that you will handle any errors.

true if the report was saved; otherwise, false.

Remarks

You can use the SAVEASXML function on the global REPORT object and on Report variables. If, at design time, you do not know the specific report that you want to run, then use the global REPORT object and specify the report number in the Number parameter. If you know which report you want to run, then create a Report variable, set the Subtype of the variable to a specific report, and then use this variable when you call the SAVEASXML function.

When you call the SAVEASXML function, the report is generated and saved to "FileName." The request page is not shown.

If the destination folder that you specify in FileName does not exist, then you get the following error:

The specified path is invalid.

If the file that you specify in FileName is being used, then you get the following error:

An I/O exception occurred during the operation.

If the Microsoft Dynamics NAV Server does not have permission to write to the file that you specify in FileName, then you get the following error:

Either the caller does not have the required permission or the specified path is read-only.

To resolve this issue, verify that the service account that is running the Microsoft Dynamics NAV Server instance has write permissions on the path.

Example

This example shows how to use the SAVEASXML function to save a report as an .xml file on the computer that is running Microsoft Dynamics NAV Server and then download the file to a different computer that is running the Microsoft Dynamics NAV Windows client. This example requires that you create the following variables.

Variable name DataType Length
TempFile File Not applicable
Name Text 250
NewStream InStream Not applicable
ToFile Text 250
ReturnValue Boolean Not applicable
// Specify that TempFile is opened as a binary file.  
TempFile.TEXTMODE(FALSE);  
// Specify that you can write to TempFile.  
TempFile.WRITEMODE(TRUE);  
Name := 'C:\Temp\TempReport.xml';  
// Create and open TempFile.  
TempFile.CREATE(Name);  
// Close TempFile so that the SAVEASXML function can write to it.  
TempFile.CLOSE;  

REPORT.SAVEASXML(406,Name);  

TempFile.OPEN(Name);  
TempFile.CREATEINSTREAM(NewStream);  
ToFile := 'Report.xml';  

// Transfer the content from the temporary file on Microsoft Dynamics NAV  
// Server to a file on the client.  
ReturnValue := DOWNLOADFROMSTREAM(  
  NewStream,  
  'Save file to client',  
  '',  
  'Excel File *.xml| *.xml',  
  ToFile);  

// Close the temporary file.  
TempFile.CLOSE();  

You can create an action on a page and set the action to run this code. When you run the action, the Export File dialog box opens. Choose Save to save the file to the client.

See Also

Report Data Type