'Content of a Good log Entry" - Thomas Jefferson National ...

'Content of a Good log Entry" - Thomas Jefferson National ...

Content of a Good Log Entry Ron Lauz Electrical Engineering Deputy Department Head There are Many Types of Entries

Automated QuickPic TaskList Follow-up Downtime Readme Non-routine Etc. There is No Perfect Log Entry I acknowledge up front that

realistically there is no perfect log entry and especially one that spans all log books and types of entries. Gathering Data I will attempt to describe what readers of the logs would like to see in mostly what the Accelerator Operations Directives calls Non-routine entries. From the AOD These are entries that describe events as they unfold and should contain enough detail to describe: Who, What, When, Where, and Why. From group feedback

Operators, Operability, Engineering, Software, CASA, Installation, and others. Attributes of a Good Log Entry Document in the correct location(s) Unless I miscounted there are 57 logbooks available from the Jefferson Lab Electronic Logbook page. Should the information be logged in a single place or multiple locations? Sending it to the correct location(s) will: Get the attention of the correct person(s) Likely generate a quicker response (sense of priority)

Make searching for repeat offenders easier Should it be a Down Time (DT) entry? Attributes of a Good Log Entry (cont.) Descriptive Keywords Keywords must describe what is written in the body of the log. The first decision a reader must make is to: Read this entry or not? Important information can be skipped or time wasted by the reader based on poor Keywords. In addition, Keywords are often used when searching for past problems that are similar. Poor Keywords can lead to

missing the entry and possibly crucial information. Text or Body of the Entry Body should be sufficiently informative to enlighten the reader What preceded the problem, what process was running when the problem occurred, who was working on the problem, what workstation was being used, error messages, beam conditions, etc. Short text entries Get to the point but dont leave out critical information that the reader will need. Long text entries

Sometimes its necessary to write very long entries. When this is the case its helpful to put a summary statement at the top. Entries that include screen grabs Entries typically capture the writers view (the symptom) when the reader is ultimately looking for the problem. Screen grabs are very helpful in this case (picture is worth a 1000 words). Dont go overboard. Short Vs. Long Entries Entries should only be as long as necessary. Novels can be interesting but usually not as a log entry. While writing an entry try to take the perspective of the reader

and give them what they need, nothing else. Not all entries can be short. Entries that must be long should start with a 1-2 line summary. This allows those interested, but not in the gory details, to get the bottom line quickly. Similar to Keywords: you may loose a critical reader if they are rushed to read the logbook. Long entries with lots of technical speak can sometimes be improved by stating a conclusion for clarification. Good Short Entry COMMENT ON RF System Repair & Recovery Log number: Submitted by:

References the ATLis Last updated on: Logbooks: ELOG RFLOG External References: ATLis: *RF System Repair & Recovery (OK) 2L23-4 IFPWP Fault. Removed and replaced FCC. Of course, acronyms can be confusing to the casual reader Good Short Entry (text only) Investigated Hall A PA not functioning correctly.

Found out that it appears to be an amplifier overheating issue. Internal heat sinks have allot of dirt/dust on them. Plan to clean unit and retest. Adding an ATLis number (if existing) would be helpful Poor Short Entry Keywords "Attempted CW to Hall D, Ion Chambers say "No"" Lognumber: Doesnt even state which Chambers. Some text would help.

Last updated: Logbooks: ELOG Entry Makers: Should Avoid CW Beam to Hall D at 50 nA. x: -1mm y: -4mm Lognumber: Submitted by: S a Last updated: m e

Logbooks: ELOG HDLOG Entry Makers: CW Beam to Hall D at 50 nA. x: -1mm y: -4mm Good Long Entry No cryotargets this weekend - solid target running only Lognumber: Submitted by: Logbooks: HALOG References: XXXXX - No target cooldown today (Thursday) Good Keywords

Good Summary The issue with the Hall A cryotarget has been found and a fix is in progress. Unfortunately, investigation and correction of the problem required letting up the vacuum in the scattering chamber. By the time the vacuum would be good enough to try and cool down, it would be too late in the day on Friday. The good news is that the scattering chamber vacuum should be good enough for us to begin to receive beam Friday evening. We will run solid targets until early next week, when we can hopefully try another cooldown. Please note that even though we will not be running with cryogenic targets this weekend, we will still need someone on shift who is able to operate the target motion mechanism. After consulting with J-P, he said that this function could be handled by anyone who has sat through the classroom target training. So those collaborators who took the classroom target training today, but have not had the practical, should feel free to sign up for "target" shifts over the weekend.

Good Summary at the Top HCO Complete to BSY Dump Lognumber: Submitted by: Last updated on: Logbooks: ELOG Entry Makers: Summary HCO to BSY Dump (1 Pass) Complete HCO to BSY Dump Complete :1 "Checked" Item pending run completion - LAM3C should be upgraded to "Ready" when run

completed. Document ID: Group: HCO Committee Subsystem: Acceptance Author: Submitted By: Revision Number: 2 Revision Date: Revision Comment: complete checklist 1. Verify there are no checklists missing from HCO (See Group Responsibility Report) A B C

D Etc., etc., etc. Much more to this entry Entries With Variable Changes Entries that state Changed Y to Y+ yield very little useful information. You know what was done but not why. Example: Changed MBD0L07V from Y to Y+. A better more informative entry would be: Observed orbit offset at IPM0L08 IPM0L10 of about -1.5mm.

Adjusting MBD0L07V from Y to Y+ removed the offset. Screen grabs of before and after could also be helpful. Not as Good as it Could Be QuickPic - RM05 Neutron dropped NL & INJ to Power Permit Log number: Submitted by: No text. Potentially lots of info Last updated on: to dig through to get the beam conditions.

Logbooks: ELOG Downtime (DT) Entries DT entries can lack key elements making troubleshooting difficult. DT entries generally benefit from one or more of the following: Screen captures showing the faults or error messages References to other entries Timeline of what was tried What other operations were taking place at the time Who was called or is actively working the problem Additional data (files, etc.)

DT Entry to Diagnose a Problem Figure 1 Shows that the RF for the Injector and North LINAC turned off. Figure 2 shows the SCN Cold Box. Figure 3 Shows a drop in flow and a rise in pressure (signals) for the NL. Repairs Associated With a DT Entry Its just as important to correctly document what was done to fix a problem. DT entries typically document a symptom. Addressing or closing a DT is the time to state the actual problem. Put enough information so that others can determine

exactly what the repair was. Consider including the troubleshooting process, if value added. DT entries typically document to the chassis or board level but could benefit from detail as to what components were replaced. Doing so stores valuable information for possible future use. Conclusions There is no single example of a good entry for all situations. Consider the reader when making an entry. Document in the correct log book(s) and use Keywords that describe the body of the log. Both are very important to the reader. Long entries benefit from having a summary at the top.

When changing variables, state why and include the before and after conditions. Screen grabs are often critical for DT entries. Details of the repair should be included in the entry as well. Not discussed BUT be mindful of what you write as outsiders may take you 100% seriously and come to incorrect conclusions. Questions? Other Log Considerations

Running entries Plan for the day entries Keyword tips Naming conventions Running Entries Running entries are a good way of displaying and tracking a timeline as events unfold during a problem. They do have a problem in that they are only viewable (Check on this) once the entry is

logged. Not sure how to fix this. Perhaps making entries every 30 minutes and link the entries. Good Plan Entry Run plan for today and tomorrow Lognumber: Submitted by: Last updated on: Logbooks: HDLOG Tags: ShiftSummary Entry Makers: Run plan for today and tomorrow:

1) x-collimator scan with the 2*10^-5 radiator and 50 nA of e- beam current. (30 min). Hovanes. Done 2) x-y beam scan with the 2*10^-5 radiator and 50 nA of e- beam current. (1:30h min). Shift Crew. Ongoing (it isn now 1pm) 3) x-y beam scan with the 10^-4 radiator and 50 nA of e- beam current. (1h30 min). Shift Crew. 4) x-collimator scan with the 10^-4 radiator and 50 nA of e- beam current. (30 min). Hovanes. In parallel to the above: a)DAQ crash studies (40min) Sergey b)TDC fix (2h) Benni 5) Pair Spec. commissioning, including runs without PS magnetic field (2h) Sacha 6) Trigger calibration (2h) Sacha 7a) Controlled access to install the triangle target, pointing UP (2h) 7b) x-scan with the collimator with 3 mm collimator hole and 5mm collimator hole. Once the target center is found, do a pair spec. harp scan (1h) Hovanes 7c) Controlled access to rotate the triangle target, now pointing DOWN (2h)

7d) x-scan with the collimator with 3 mm collimator hole and 5mm collimator hole. Once the target center is found, do a pair spec. harp scan (1h) Hovanes Keyword Tips Using specific keywords when performing specific types of work makes searching much easier. HCO PM Checklist Location; SL, NL, Inj., Hall A, Hall B, etc. System; ESR, CHL, CTF, etc. Status update Phone call

Tour Etc. Improper Use of Naming Conventions Striptool showing MBL0R03 hysteresis cycle Lognumber: Last updated on: Logbooks: ELOG Entry Makers: References: Strip tool shows both MBL0r03 and MBL0R04 chicane dipoles. MBL0R04 cycled normally but MBL0R03 did not.

Good Entry Logbooks: HDLOG HDTARGET References: XXXXXX - 10mm Target installed The target was installed with the holding tube at its nominal 0 angle. Although the target is a symmetric cylinder, this matters because the survey determined that the target is not perfectly centered on the beam line axis, see entry 3304514. The attached photo (11/11/14, 11am) shows the orientation and zvalue for the target.

Recently Viewed Presentations

  • Chapter 18 Endocrine - apcscience.com

    Chapter 18 Endocrine - apcscience.com

    - where a hormone stimulates the gland to release its hormone. tropic. hormone - a hormone that stimulates a gland to release another hormone-tropin. a suffix often used on tropic hormones. 2. Humoral - where the gland monitors the conditions...


    Formula based / automatic pricing adjustments - Prices are published (but not the formulas in some countries) e.g. RSA publish both prices and the formula. Liberalised pricing system - the market set the prices (depoliticised) but there is a formula...
  • Canadian History 11 Aboriginal groups like in groups

    Canadian History 11 Aboriginal groups like in groups

    Algonquian tribes had great hunting skills Gathered wild food like: rice and berries Had to move around live in wigwams Maritime Provinces Algonquian Nomadic (according to the seasons) Spring, summer and fall: Lived by the seashore (salmon, eel, lobster, clams,...
  • Grade Pre-Assessment for Quarter 2 Reading Informational Text

    Grade Pre-Assessment for Quarter 2 Reading Informational Text

    Fire Cakes! Fire cakes are a horrible tasting blob of burnt wheat. The soldiers first mixed flour with water until it was a thick, damp dough. They then formed it into a cake. ... The longer the water has been...
  • Advanced Placement Human Geography

    Advanced Placement Human Geography

    Age —young people more likely to migrate (ages 18 and 30) Life changes affect decision to migrate. Examples: attend school. marriage . take a job. ... Chain migration -A stream of people leave an area after first movers communicate with...
  • Introduction to SEPs - Reuven Ramaty High Energy Solar ...

    Introduction to SEPs - Reuven Ramaty High Energy Solar ...

    Introduction to SEPs Christina Cohen Caltech Outline What are SEPs? And why do we care? How are the measured? on the ground in space What is the SEP history? pre-1997 post 1997 What is new and exciting about SEPs? in...
  • Differentiated Instruction in the L2 Classroom

    Differentiated Instruction in the L2 Classroom

    (Page 11, 2004 French as a second language, Nine-Year program of studies (Grade 4 to 12) OAG: function in the language and culture General Outcomes Culture Students will use their knowledge of different Francophone cultures and their own culture to...
  • Control - Statistical Process Control SPC

    Control - Statistical Process Control SPC

    Statistical Process Control * Please read the slide. * Please read the slide. * Remembering many of the tests are based on the 1st and 2nd Standard Deviations from the Center Line some Belts prefer to have some additional lines...