Create an issue

ContentRocview

  • Issue


Menu location Rocview → Help → Issue
Toolbar icon or


Quick start

If you report a problem in the Rocrail Forum you need to provide some essential files which you can easily collect with this function in a few steps:

  1. Update the Rocrail installation. This is essential!
  2. Open the Help menu in Rocview.
  3. Select Issue.
  4. Write some text in the Subject field (do not use special characters); For example: “Switch does not work”.
  5. Optionally write some detailed information about your issue in the Description text area.
  6. Click on OK.
  7. A file explorer window will open with a file named issue.zip which can be attached in the Forum.
    At the bottom of the Forum entry is a “Upload Attachment” feature, select the issue.zip file just created.


Modular layouts

Creating an issue in case of a modular layout will flatten it into one plan file.
Zipping the complete directory will be the better way for this type of layouts.


Trace levels

Activate only server trace levels which are really necessary.

  • Byte trace level makes only sense in case of communication issues.
  • Automatic mode trace level makes only sense in case of automatic mode issues.
  • And so on…


Preparation

  1. Switch off all unnecessary trace levels.
  2. Prepare the environment as needed for reproduction of the issue.
  3. Restart if needed.
  4. Make the reproduction of the issue as short as possible.
  5. Write in the Issue Dialog a step by step list on how to reproduce it.


Location of the Issue

This issues folder is by default in the workspace environment but can be modified in the general Rocrail server settings.
In the server trace window the fully qualified path will be shown.
If the server runs on the same computer a file explorer window will be opened which contains all files which can be compressed into one file for uploading in to the forum. With newer revisions an issue.zip file is created automatically.
Optional another path can be selected if the server runs on the same computer.


Posting the Issue

Compress the Issue directory into a 'issue'.zip file on Mac/Windows or into a 'issue'.tar.gz on Linux.
Attach this 'issue' archive to the Forum posting.


Help Menu


Example

Dialog

Subject

The subject of the issue. (Mandatory)
Do not use special characters in the subject because it is used for building a filename, which can be platform dependent.

Path

Optional path for storing the issue files in case the server runs on the same computer as Rocview.

Description

Short description of the issue. This is optional but highly recommended.


Directory contents

issues/De_trein_vertrekt_niet./
issue.txt Content of issue dialog and statistics of server.
plan.xml Memory dump of model which includes all separate input XML files like modules and locos. (The file name will resemble the rocrail.ini and could be different, and the preceding path will be removed.)
occ.xml Memory dump of occupancy and placing.
rocrail.ini Memory dump of server settings. (The preceding plan file path will be removed.)
rocrail.trc Copy of current trace file.

These files are contained in an “issues” sub-directory.


Report

issue.txt:

Date: 20120930.112140.715
Rocrail 2.0.999-4021 Sunrise (linux)

started at Sun Sep 30 11:20:31 2012

process id         = 81373
working directory = /Users/rob/lp/Rocrail/unxbin/virt
allocation count  = 17555
allocated memory  = 3 MB
clients           = 1
connections       = 1
locos             = 2


De trein vertrekt niet.:
----------------------------------------
Ik heb al van alles geprobeerd maar zelfs met een zetje wilt de trein niet gaan rijden.


BackTrace: (last 10 exceptions and warnings)
----------------------------------------
 unable to open file: netroutes.xml
 Error open file [netroutes.xml] [rb]
 Error open file [netroutes.xml] [rb]
 block [03] not found
 block [02] not found
 block [01] not found
 createMap: locationlist NOT found.
 createMap: operatorlist NOT found.
 createMap: waybilllist NOT found.
 createMap: linklist NOT found.

13 threads:
----------------------------------------
timedoff "timedoff"
clockticker "clockticker"
r2rreader "r2rreader"
V200 "Elektrolokomotive E 41 der DB"
infw035C98E0 "127.0.0.1"
broadcast "ClientCon Broadcaster"
tick06F00E00 "tick06F00E00"
checker "checker"
cconmngr "ClientCon Manager"
r2rwriter "r2rwriter"
vcs-1 "vcs-1"
E03 "Elektrolokomotive BR 103 der DB"
cmdr035C98E0 "127.0.0.1"

Setting an Entry in the Forum as solved

Only the person (besides the administrators) that creates an Entry in the Forum can close it.
1. Select the first Entry of your Post in the Forum.
2. Select “Edit”
3. Prefix the Heading with [solved] or [fixed] or an appropriate description.
4. Submit

Example:
Entry in the Forum:

 The names in the View tab are inconsistent.

Entry in the Forum after changes were made:

 [fixed] The names in the View tab are inconsistent.

Personal Tools