edmiRemoteGetDatabaseLogFiles


 

EdmiError edmiRemoteGetDatabaseLogFiles(SdaiServerContext       serverContextId,
                                        SdaiString              location,
                                        SdaiString              databaseName,
                                        SdaiString              logFilesFirstPart,
                                        SdaiString              logFiles,
                                        SdaiString              destinationFolder,
                                        SdaiString              outputFile,
                                        SdaiOptions             options,
                                        SdaiInvocationId       *edmiInvocationId); 
  

Transfer database log files from an EDM server to a client machine.

Arguments


1TypeNameComment
2SdaiServerContext  

serverContextId

Context identification, from edmiDefineServerContext

3 SdaiString

location

The full path to the directory on the remote file system where the database files will be located. The remote file system is the file system of the EDMserver.

4 SdaiString

databaseName

The name to assign to the EDMdatabase. EDMdatabase names are case sensitive on Unix platforms and case insensitive on Windows platforms.

5
SdaiString
logFilesFirstPart

A log file name has the following syntax: EDM.<database name>.<database creation time>.<database server startup time>.<log type specific part>. The two time parts have the following syntax: YYYYMMDD-HHMMSS. When this parameter is specified, only log files matching this part are transferred to the the client. If the parameter is blank, only files related to the last database creation / startup time are transferred. If the value is equal to * and the option ALL_OF_SPECIFIED_TYPE is checked, all files of the specified types are transferred regardless of the database creation / startup time

Exception: There is only one server report file and it has not server startup time as part of its name.

In the EDMS command "Get remote database log files" this field is named "Database creation-start time".

6
SdaiString
logFiles

The log files specified here, separated by space, will be transferred. The names shall only consist of the <log type specific part>. The full file name will consist of the logFilesFirstPart + part specified here.

In the EDMS command "Get remote database log files" this field is named "Database log file name".

7
SdaiString
destinationFolder

Folder where the the transferred database log files will be stored.

In the EDMS command "Get remote database log files" this field is named "Local destination folder".

8
SdaiString
outputFile
A file where a log from the transfer is written. By using the option GET_DATABASE_FILE_LIST, a list of all files in the database folder is written to this file.
9SdaiOptions
options

ALL_OF_SPECIFIED_TYPE, GET_DATABASE_FILE_LIST, GET_AND_DELETE, ONLY_DELETE, OPEN_DATABASE_INFO, SERVER_TRACE, APP_SERVER_TRACE, VM_TRACE, SERVER_DUMP, SERVER_REPORT_FILE

Return Value


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_EDMInterface'.

 

Options


  

OptionComment

ALL_OF_SPECIFIED_TYPE

If no log file is explicitly specified in parameter logFiles, all files of the specified types are transferred.

GET_DATABASE_FILE_LIST

A list of all files in the database folder is written to the file specified in parameter outputFile.

GET_AND_DELETE

All files that are transferred to the client are deleted from the server log file folder after transfer.

ONLY_DELETENo files are transferred. The specified files are deleted from the server log file folder.
OPEN_DATABASE_INFOTransfer open database info file.
SERVER_TRACETransfer EDM server trace file.
APP_SERVER_TRACETransfer EDM application server trace files.
VM_TRACETransfer Virtual Machine dump files.
SERVER_DUMPTransfer EDM server / application server dump files.
SERVER_REPORT_FILETransfer the Server Report File.

 

Example


 

 

 

See also

Filter by label

There are no items with the selected labels at this time.