Ogolny wzor zgloszenia (feedback do Open API Solutions).
Proponuje plik tekstowy. Poszczegolne pola rozpoczynamy
gwiazdka (*):
* Date: [wiadomo - data]
* Developer name: [imie, nazwisko, e-mail]
* Problem description: [opis, najlepiej zwiezly]
* Details: [szczegoly wraz z kodami bledow,
wyjatkami itd. Jezeli bledem jest niezgodnosc z dokumentacja -
podajemy dokladne namiary na bledna informacje w dokumentacji]
* Environment: [w jakim srodowisku uruchamiamy program,
jakie sa wymagania: wersja Javy, ORB-a, Systemu operacyjnego]
* How to get problem: [co nalezy zrobic krok po kroku: jak skonfigurowac
srodowisko, jak zainstalowac aplikacje, jak ja uruchomic (parametry),
jak postepowac, zeby wystapil problem]
* Files included: [dolaczone pliki: kody zrodlowe (skompresowane) i
wykonywalne, konfiguracja (jesli potrzebna)]
Przyklad (example):
Poniższy przykład jest całkowicie fikcyjny (wymyślony na potrzeby
poniższego przykładu). Szczerze mówiąc podobnego błędu nigdy nie stwierdziliśmy.
******************************************************************************
Note, that
THE FOLLOWING EXAMPLE IS A FICTIOUS ONE (FOR THE PURPOSE OF THIS EXAMPLE)
WE HAVE NEVER ACQUIRED A SIMILAR PROBLEM WORKING WITH OAS PRODUCTS.
******************************************************************************
* Date: 2003-01-10
* Developer name: M. Roj, mroj@elka.pw.edu.pl
* Problem description: A second application cannot connect
to FW. The first connects and works fine.
* Details: We have one Open API Solutions Framework (with Call Control
SCF initiated) with the standard configuration (config files included).
We start an applications (id: xyzxyzxyz) and it connects and
registers to the Fw successfully. The second one (id: zxyzxyzxy)
is refused with error: yxzyxzyxz. We cannot find in docs that
only one app may be let in the same time. Is it the lack in documentation,
software restriction, or maybe a bug?
* Environment: Whole the system (Fw, SCF and apps) is located on a single
machine run by Windows XP. We use the XXX ORB, jdk1.yyy and ZZZ
profile/configuration. We use CORBA name services.
* How to get the problem: Start the Open API Solutions software with
options XYZ. Run the 1st application using the startApp.bat script.
The run the second application using startApp2.bat.
No other interaction is required to get an error.
* Files included:
o) To run the application: startApp.bat, startApp2.bat, osa.jar,
myApp.jar, config.dat
o) Sources: myApp.zip
o) Fw configuration: fw_conf.zip (copy it the your x/y/z/ catalogue)
Takie zgloszenie wraz z wszystkimi plikami (zrodla + jary) i konfiguracja
przysylamy na adres osa@tele.pw.edu.pl (byc moze lepiej bedzie zalozyc
liste dyskusyjna).
Pierwsze co robimy to proba powtorzenia problemu na innym systemie,
najlepiej z innym srodowiskiem (inny jdk, inny OS, ..), czyli de facto
przeslanie calosci do ktoregos z kolegow-developerow.
Jezeli blad wystepuje i tu, to probujemy jeszcze na uczelni i przygotowujemy
feedbeck dla Open API Solutions. Formula listu - jak wyzej. Moga byc konieczne
delikatne poprawki jezykowe (Problem description, details).
Informacje uzupelniamy o inne srodowiska (gdzie problem wystepuje).
Wazne: inny (niezalezny) developer musi bez wlasnego glowkowania powtorzyc
problem, tzn. nalezy uwaznie przygotowac pola Environment, How to get problem
i Files included. Niepelny feedback moze byc zupelnie bezwartosciowy.