Help:Report Tutorial
From Star Trek: Gamma One
Contents |
Help File
A copy of the in-game report helpfile can be accessed here for reference to accompany this tutorial.
Creating a Reporting for Duty +report
The first report that almost any new character will need to write is his reporting for duty report. This report tutorial will track CDT James Smith reporting for duty as the Second Officer’s Yeoman aboard U.S.S. Vanguard-A. It will, in the process, cover the basic +report commands. More advanced commands are covered in a separate file.
First, Smith needs to create the report, adding it to the +report system. He does this using the +report/create command.
+report/create takes the syntax +report/create <dept>/<title>=<comments>. A ‘dept’ is a ‘Department.’ They work as areas where +reports can be filed, such as Operations, Command, Engineering, and so forth. Each department has an abbreviation that serves as its name. Most are obvious, such as ENG for Engineering, OPS for Operations, CMD for Command, and MED for Medical. To see the full list of departments for +reports, see +depts.
The <title> of a report is its name. <Comments> are the initial text of the report. So Smith might type,
+report/create cmd/RFD CDT Smith=Cadet James Smith reports for duty from Starfleet Academy for his cadet cruise as Second Officer’s Yeoman. My service record is attached to this report.
He doesn’t need to actually attach his service record. His boss can read it using the +sr commands.
Now that his +report is in the system, he can see it in the list of all +reports by typing +reports. If he wanted to just view the +reports in the CMD department, he could do so by typing +reports/cmd.
He can view his new report by typing +report <#>, where <#> is the number that was automatically assigned to his +report when he created it. Let’s say that the report was assigned number 5.
Now that Smith’s report is in the system, the Second Officer, Lieutenant Commander Jones, needs to tell him to report for his pre-duty physical and then his pre-duty briefing. To do that, he uses the +report/add 5=<text>.
So Jones might type:
+report/add 5=Cadet Smith, please report to Medical for your pre-duty physical. Have Medical return this report to me when that is completed, and then report for your pre-duty briefing.
Jones then needs to transfer the report to Medical, so it can see that it has a cadet coming by for a physical. To do this, he uses the +report/trans command. +report/trans shifts the +report into another +dept to work on it. Medical’s +dept is MED, so Jones would type:
+report/trans 5=med
Now Medical has the report in its +dept so that Medical staff can read it and add comments. Smith reports for his physical and everything turns out okay, so the doctor adds that Smith is cleared for duty using +report/add again.
The doctor might type:
+report/add 5=Cadet Smith reported on this date for a pre-duty physical. He is found in good health and is cleared for unrestricted, active duty.
The doctor would then transfer the +report back to the CMD bucket with +report/trans:
+report/trans 5=cmd.
Once Smith and Jones have gone through their pre-duty briefing together, Jones will close out the report using +report/complete. The syntax is +report/complete <#>=<Closing remarks>. He’ll type:
+report/complete 5=This officer has received his pre-duty physical and pre-duty briefing and is cleared for active duty. Welcome aboard, CDT Smith.
This tutorial should get you through your first report and will deal with the basics of most +reports: +report/create to create a report, +report <#> to read it, +report/trans to move it between +depts, +report/add to add comments to it, and +report/complete to complete it. Other tutorials will cover more advanced features.
Changing Restrictions on a +report
A set of +report commands allows someone to set who has access to a report. They can set a necessary clearance level to read the report (news clearance), allow individuals who would not normally have clearance to read a report, or lock a report to those who would normally have access to a report.
+report/ship
+report/ship <report #>=<Marathon|Vanguard|JNT> allows you to select which ships have access to the report. When a report is first created it is assigned one of this three values, and that default assignment is almost always correct. It should only be changed for a specific reason in order to give PCs from the other ship access to the report.
+report/clearance
+report/clearance sets the clearance level needed to read a report. Most reports, by default, are at Clearance 3, default clearance.
Using +report/clearance <report #>=<Level>, an officer can change the clearance level needed to read a report. Setting +report/clearance 10=5 means that +report 10 can only be read by Department Heads and above. An officer can lock himself out of a report by setting a clearance level higher than he has, so this should be used with care. Please see '+sop reports' for details about when you can and can not use this command.
+report/access
+report/access <report #>=<name> allows an officer to allow someone who would not normally have access to a report to read it. This works both across the +report/clearance setting and +dept boundaries. Thus, it has two very helpful uses. First, it allows a Department Head or Intelligence Officer who must bring in a junior officer to work on a classified project to read and work on the +report, granting a “need to know” sort of clearance for that particular project. However, it can be used in even non-classified situations. Say a medical officer and a science officer are working together to research a new virus. The +report is in the SCI department, but the science officer needs the medical officer to work on it. She could use +report/access to let the medical officer in on the report, crossing the +dept boundaries. Please see '+sop reports' for details about when you can and can not use this command.
Both +report/access and +report/restrict (see below) take series of names separated by a space, so someone can grant access to several people at once. E.g. +report/access 4=zeran mccall wifong mitellan to give access to Zeran, McCall, Wifong, and Mitellan.
+report/restrict
+report/restrict <report #>=<name> is just the opposite. It takes away access to a report from someone who would normally have access to a report, regardless of that person’s clearance level or what +dept she has access to. +report/restrict is used when, for example, a department head needs to lock out the subject of a discipline investigation from the disciplinary file. Please see '+sop reports' for details about when you can and can not use this command.
Captains and First Officers
The Captains and the Executive Officers have access to all reports. You can not restrict them from reading any reports.
Putting it all Together
When using the above commands, they have a cascading affect on report access. The following will demonstrate how they fit together.
- Are you trying to view the report from the same ship as the report? (Or is the report a JNT report?)
- If Yes, move on to section B
- If No, you can not access the report.
- Are you on the RESTRICT list?
- If Yes, you can not access to the report.
- If No, move on to section C.
- Are you on the ACCESS list?
- If Yes, you have access to the report.
- If No, move on to section D.
- Is the report clearance higher than the your clearance level?
- If Yes, you can not access the report.
- If No, move on to section E.
- Access given based on normal branch access restrictions. (IE, +dept/info <dept>)
Managing Reports
A series of +report commands allow an officer to sift and search for specific reports. +report/list <dept> allows a list of reports to be viewed by department. +report/list MED will list all Medical reports, while +report/list CMD will list all Command reports. It’s useful for Department Heads and other officers who have access to a variety of +depts, more than just their own department.
+report/sort will sort the full list of +reports by +dept. That is, instead of +reports, which shows +reports in numerical order, +report/sort will group +reports in the dame +dept together. +reports/mine will show +reports that have been assigned to that officer, using the +report/assign command. +reports/date will sort +reports by date last modified. And +reports/new will show reports modified since the player’s last log-in. Lastly, +report/pri will sort +reports in order of priority, from RED at the top to GREEN at the bottom.
An officer can use +reports/search <text> to search for a specific string in a +report. +reports/who <name> will return all of the +reports assigned to a specific person, like +reports/mine.
A set of ‘summary’ commands in +report are used to set certain fields for two +depts, OER and AAR. The two +depts are specific in their context, but both use the same form:
+report/sumset <#>/<field>=<value>.
For example, in an OER report, an officer might need to set an officer’s Peer Review evaluation score. Let’s say in +report 13, the reviewed officer received a 3.0 for his peer evaluation. To do this, he would +report/sumset 13/peer=3.0.
In an AAR report, an officer might need to list himself as the mission leader. So McCall, on +report 15, might need to +report/sumset 15/Mission Leader=McCall.
In order to see a listing of valid report summary options for a given department, check +dept/help <dept>. For instance, '+dept/help AAR' will show you the valid summary options for AAR reports.
Referencing Reports In Character
In some cases, it may be necessary for your character to reference another +report. For example, in a report that is following up on something discovered during a mission, an officer might need to point readers of the report back to the mission's after action report. Another example might be when a single project is being worked on across multiple departments and multiple reports.
Each +report has an in-character 'reference number' that goes with it. This number is <Numeric registry number of the vessel that the officer opening the report is assigned to>-<Stardate that the +report was opened on, truncating any decimals>-<+report number in the +report system>.
Take, for example, the following report:
| |
| \___________________________________________ __________
\________________________________________________| View Report 76 |__________)
Dept: FLEET Due On: -
Title: VAN: Acting Operations Manage Status: Green (New)
Opened On: Mon Jan 01 20:55:49 2007 Assigned To: Nobody
Opened By: McCall
____ ________________________________________________
|____| Report Access Details |________________________________________________)
Clearance: 2 (default clearance level)
Access: No personnel granted special access.
Restricted: No personnel restricted from report.
____ ________________________
|____| 1) McCall: 01 Jan 2378 20:55/Stardate 55525.1 |________________________)
It would be referenced in-character as: 61966-55525-76.
For reference, the numeric registry of Vanguard is 61966 and the numeric registry of Marathon is 68208. For these purposes, the registry of Allied Outpost Gamma One would be either "OG1-" or '19386-', the latter being the registry of the main assigned support craft, USS Tripoli.
