System Admin Configuration of Word Export
The Word export is implemented as a separate application from Codebeamer. It can run locally on the same host as Codebeamer or, it can run as separate service on another host. By default, the Word export is running as a separate process on the same host where Codebeamer is running. For each export job, a new process is started. When a job is started Codebeamer is passing some initial data to export application through file system (like IDs of trackers to export). However, most of data is queried from Codebeamer REST and Swagger API-s.
For making these calls export application needs to know where Codebeamer is accessible. This is why a callback URL is necessary. Codebeamer tries to calculate this URL automatically however in cases where Codebeamer is behind a frontend (eg. Apache httpd
) this is not possible and administrators have to configure this URL manually.
) this is not possible and administrators have to configure this URL manually.From Codebeamer version 10.1 Word export can be run as separate service on another host as well however this needs extra installation/configuration. See: Application Configuration.
Configuration can be done at > .
An example configuration:
"applicationApi" : {
"callbackUrl" : "http://localhost:8080/cb"
},
"wordExport" : {
"debugLogging" : false,
"jvmArguments" : "-Xmx3G",
"maxParallelProcesses" : 3,
"restLoaderPageSize" : 50,
"timeoutSeconds" : 3600
},
"interactive" : {
"maxAllowedWordExportItemCount" : 5000
}
"callbackUrl" : "http://localhost:8080/cb"
},
"wordExport" : {
"debugLogging" : false,
"jvmArguments" : "-Xmx3G",
"maxParallelProcesses" : 3,
"restLoaderPageSize" : 50,
"timeoutSeconds" : 3600
},
"interactive" : {
"maxAllowedWordExportItemCount" : 5000
}
See the relevant documentation of Application Configuration: Application Configuration "wordExport" section.
Accessing logs of Word Export component
When word export is running locally then logs can be found under Codebeamer log folder.
Before Codebeamer version 21.09:
• Logs are under a sub folder "cb-export-app-logs" under Codebeamer log folder.
• Each export job had its own log with the process id in the file name.
Starting from Codebeamer version 21.09:
• Logs can be found directly under Codebeamer log folder as a single rolled log file: cb-export-app-log.txt.
• When you download logs from Server Status Dashboard then it will include that as well.