ISA Interchange

Welcome to the official blog of the International Society of Automation (ISA).

This blog covers numerous topics on industrial automation such as operations & management, continuous & batch processing, connectivity, manufacturing & machine control, and Industry 4.0.

The material and information contained on this website is for general information purposes only. ISA blog posts may be authored by ISA staff and guest authors from the automation community. Views and opinions expressed by a guest author are solely their own, and do not necessarily represent those of ISA. Posts made by guest authors have been subject to peer review.

All Posts

What Is the Best Way to Document a Control System?

 

The following technical discussion is part of an occasional series showcasing the ISA Mentor Program, authored by Greg McMillan, industry consultant, author of numerous process control books, 2010 ISA Life Achievement Award recipient and retired Senior Fellow from Solutia Inc. (now Eastman Chemical). Greg will be posting questions and responses from the ISA Mentor Program, with contributions from program participants.

 

In the ISA Mentor Program, I am providing guidance for extremely talented individuals from countries such as Argentina, Brazil, Malaysia, Mexico, Saudi Arabia, and the USA. This question comes from Hector Torres.

 

Hector Torres is a senior process and control engineer for Eastman Chemical Company in Tlaxcala, Mexico, with more than 20 years of experience.

 

Hector Torres’ question

What is the best way to convey information to design, build, run, and maintain a process control system in a common format that can easily be created, modified, and understood by all disciplines involved?

 

Hunter Vegas is an excellent resource for these and other project questions. I did a three-part series of Control Talk columns: Successful Retrofit and Automation Projects.    

Hunter Vegas' Answer

Wow….if I had the answer to that I would likely be a rich man. I will say that I have gradually created a reasonably workable system over my 30 years of doing automation systems. I’ve held positions in production, engineering, and consulting so I’ve seen some pretty good (and stunningly bad) examples of what works and what does not. The key point to understand is that the documentation needs of each group – from design, through construction, and on into production/maintenance all vary considerably so there is no one method that will make everyone happy. However it IS possible to create a documentation format that works for design and construction and then can be gradually “morphed” into a format that meets the needs of production. The specific formats will vary somewhat with industry but I’ll address as broad a group as I can.

Taglist

This is probably the most useful document an instrument engineer can have and it is always my starting point for any major automation project. Basically it is a list of every single instrument in the plant and is usually used as a means of giving out new instrument tag numbers to avoid duplication. The taglist as a minimum should contain every instrument in the control system but many include EVERY instrument with a tag including local thermometers, pressure gauges, relief valves, etc. It is critical that each instrument be given a tag number that can be referenced in all of the other documents.

NOTE: The assigning of tag numbers is a whole other topic of conversation that I won’t delve into now. However it IS vitally important that the numbers be assigned in a simple and meaningful way. Many plants have been seriously burned by tag numbers that have been doled out in an unwise or haphazard fashion. Practically every other piece of documentation will key to the tag list in some manner so it needs to be done right. Some people use Access databases but I find a standard Excel spreadsheet to be much easier to use and simpler to manipulate.

The basic taglist will have the following columns as a minimum:

1. ISA Prefix (LT, LV, FV, etc.) Use the standard ISA methodology

2. ISA Tag number 100, 101, 1000, etc.

3. ISA Tag Suffix (A, -11B, etc) (Note that if I split the prefix, tag, and suffix into separate columns, this gives me a lot better means of sorting. If I have multiple plants with duplicate tag numbers, then I’ll often add an “AREA” or “PLANT” number or letter column in front. In that way, if one plant is Area 10 and the other is Area 07 then I can tell the difference between LT-10A in area 10 from LT-10A in Area 07.)

4. Description - This is usually a LOOP description, not a device description. We’ll usually use this as the description on the loop sheet as well as the description of the control module in the control system.

5. Device Description (Magmeter, Control Valve, Open Limit Switch) - This column isn’t necessary but helps the user quickly figure out what a device is.

6. DCS Location - This is usually a couple of columns that include: CONTROLLER, RACK, SLOT, CHANNEL, etc. The specific columns will vary depending upon the architecture of the system. NODE will usually be necessary if the device is a bus type device (ASi, Fieldbus, Devicenet, etc.)

7. Range Lo, Range Hi, Range Units - Some people combine these into one column, like 0-100 PSI, but over the years I have found it better to have individual columns for each number.

8. Loop Sheet Drawing Number Beyond that list, there can literally be hundreds of more columns and this is where the “morphing” comes in. On a large project (especially a retrofit project), I will build up a large chunk of the configuration data in a large spreadsheet and the engineers can use this spreadsheet to auto generate a great deal of the new control system code. So a partial list might include: Module name, Graphic name, Alarm Lo, Alarm Hi, Alarm Units, Direct/Reverse Acting, Square root input, SP Hi limits, SP Lo Limits, scan time, filtering, output hi, output lo, output units, output hi limit, output lo limit, historian resolution … you get the idea. In addition, I will usually add columns that are used only for the configuration process. These might include details on simple module types (Standard PID, On/Off Valve, Indicating AI, etc.), as well as details on simple interlocking. (Trip motor on LSLL-231, Force PID to 0% with no override if TI-214>500F, etc.) During the configuration we add still MORE columns indicating what modules have been configured (and by whom) and which have been tested. With a bit of simple manipulation, I can automatically generate a percent complete by just checking these columns. During the installation we add columns indicating which points have been checked (and by whom) so we have a means to track our loop check progress. Eventually the plant starts up and we take the taglist and strip out a lot of the columns leaving only the ones that the plant will need for maintenance. We’ll also normally add rows for each spare DCS point as this makes future I/O assignments much easier. At that point the much reduced taglist is used to assign new points and new tag numbers and is an easy way to find instrument ranges and loop sheet documentation.

Ways to document control details

There are several ways to document more advanced logic but some are decidedly more easy to use than others. Some people love ISA-5.1 standard diagrams and they are very common in the power industry but the fact is that very few instrument engineers can read them and most production and operations folks have no idea what they mean. We have tried many different options but have settled on the following:

P&IDs

While the PFD offers more process control information than the more cluttered P&IDs, which show many more piping/equipment details most plants are lucky to keep ONE document up to date and I have seen very few (if any) plants that were able to keep a set of PFDs and a set of P&IDs accurate and up to date. (Invariably you end up with two sets of documents each of which has things the other does not have and neither has everything.) That said most plants usually opt for the P&ID (because OSHA says they have to have it). Since you are most likely stuck with a P&ID then make the most of it. Do NOT try to put every single bubble on the drawing. (IE: An automated on/off valve does NOT need to show the solenoid, the ZSO, the ZSC, and the valve itself. Most people show a single valve (XV-2001), a fail position (FC), and if you want to indicate limit switches, they might show 2DI, 1DO in small print beside it to indicate this. Most add symbology to indicate which devices are associated with the DCS versus field controlled. What IS important is that you show interlocks – both hard wired and major software interlocks – in a format that is easy to read and understand. I have seen plants show a box with an interlock number (like “I-1”) beside the valve and then on the side of the drawing explain what “I-1” does. (“I-1: (SIS) On hihi level LSHH-234, trip XV-2001 closed”). Notes like this are invaluable for Hazops, etc.

 

ISA Mentor Program

The ISA Mentor Program enables young professionals to access the wisdom and expertise of seasoned ISA members, and offers veteran ISA professionals the chance to share their wisdom and make a difference in someone’s career. Click this link to learn more about the ISA Mentor Program.

 

Flow charts

Flow charts are an excellent way to show how some of the more complicated sequences, batch phases, and recipes work. For batch installations we create recipe level flow charts that show each major phase as a block and showing the phase parameters that are passed down to the phase. Then we create a flow chart for each phase showing the running, holding, stopping/aborting logic details. We also create flow charts for the major non-batch sequences that might run on the system (start up sequences, etc.) Obviously these documents are key to design, configuration, and FAT testing but most plants keep them up and use them for Hazops during the life of the system.

Loop sheets

Some engineering firms will try to convince clients that loop sheets are unnecessary and that the entire installation can be accomplished using interconnection diagrams and junction box drawings. This is true…the INSTALLATION can be accomplished using those diagrams but loop sheets are critical to the maintenance of the plant. They are particularly useful if the loop sheet name is easily derived from the tag itself. If this is done the maintenance tech can easily find the correct drawing by only knowing the loop tag number he is working on. Resist the urge to put TOO much information on the loop sheet – especially if that same information is located elsewhere. Normally the tech needs to know the routing of the wire, the location of any fuses and power sources, and possibly the calibrated range. Adding much more than that makes them very difficult to maintain.

Field wiring diagrams

These diagrams may include the wiring of field junction boxes, fieldbus networks, and possibly the wiring of marshalling panel terminations and card edge wiring. All of these are critical for construction and can be useful for maintenance as a means of locating and assigning spare cable pairs. Fieldbus network diagrams are particularly critical for plant operation and maintenance troubleshooting. As you can see there are a lot of options but I’ve tried to provide the ones I feel are most critical to a project’s success and long-term viability.

Greg McMillan's Answer

There are ISA standards and resources for documentation listed on the ISA Standards web site. The ISA book Control System Documentation: Applying Symbols and Identification provides a comprehensive view. Just ignore the pneumatic signals and valves without positioners.

Opening up our minds to the future

What if the operator graphics were automatically updated from the P&ID or vice versa? What if there was a PFD graphic that was automatically updated when the operator graphics was updated? What if this PFD had details useful for understanding and improving the automation system such as sensor location and split range and override connections? What if the engineer can click on a measurement or valve and bring up the smart diagnostics and health and calibration results? What if the PFD had updated stream info based on existing measurements to become Live Process Flow Diagrams? (See Flexible Manufacturing and Exceptional Opportunities in Process Control - Live Process Flow Diagrams) What if the next generation of user graphics has smart trajectory trends with optimized process variable and time scaling and XY plots (e.g., batch endpoint worm, compressor surge curve, and titration curve plots)? If you could demonstrate this ahead of the next generation of graphics, you would be famous.  

 

Additional Mentor Program Resources

See the ISA book 101 Tips for a Successful Automation Career that grew out of this Mentor Program to gain concise and practical advice. See the InTech magazine feature article Enabling new automation engineers for candid comments from some of the original program participants. See the Control Talk column How to effectively get engineering knowledge with the ISA Mentor Program protégée Keneisha Williams on the challenges faced by young engineers today, and the column How to succeed at career and project migration with protégé Bill Thomas on how to make the most out of yourself and your project. Providing discussion and answers besides Greg McMillan and co-founder of the program Hunter Vegas (project engineering manager at Wunderlich-Malec) are resources Mark Darby (principal consultant at CMiD Solutions), Brian Hrankowsky (consultant engineer at a major pharmaceutical company), Michel Ruel (executive director, engineering practice at BBA Inc.), Leah Ruder (director of global project engineering at the Midwest Engineering Center of Emerson Automation Solutions), Nick Sands (ISA Fellow and Manufacturing Technology Fellow at DuPont), Bart Propst (process control leader for the Ascend Performance Materials Chocolate Bayou plant), Angela Valdes (automation manager of the Toronto office for SNC-Lavalin), and Daniel Warren (senior instrumentation/electrical specialist at D.M.W. Instrumentation Consulting Services, Ltd.).

 

About the Author
Gregory K. McMillan, CAP, is a retired Senior Fellow from Solutia/Monsanto where he worked in engineering technology on process control improvement. Greg was also an affiliate professor for Washington University in Saint Louis. Greg is an ISA Fellow and received the ISA Kermit Fischer Environmental Award for pH control in 1991, the Control magazine Engineer of the Year award for the process industry in 1994, was inducted into the Control magazine Process Automation Hall of Fame in 2001, was honored by InTech magazine in 2003 as one of the most influential innovators in automation, and received the ISA Life Achievement Award in 2010. Greg is the author of numerous books on process control, including Advances in Reactor Measurement and Control and Essentials of Modern Measurements and Final Elements in the Process Industry. Greg has been the monthly "Control Talk" columnist for Control magazine since 2002. Presently, Greg is a part time modeling and control consultant in Technology for Process Simulation for Emerson Automation Solutions specializing in the use of the virtual plant for exploring new opportunities. He spends most of his time writing, teaching and leading the ISA Mentor Program he founded in 2011.

 

Connect with Greg:

LinkedIn

 

Greg McMillan
Greg McMillan
Greg McMillan has more than 50 years of experience in industrial process automation, with an emphasis on the synergy of dynamic modeling and process control. He retired as a Senior Fellow from Solutia and a senior principal software engineer from Emerson Process Systems and Solutions. He was also an adjunct professor in the Washington University Saint Louis Chemical Engineering department from 2001 to 2004. Greg is the author of numerous ISA books and columns on process control, and he has been the monthly Control Talk columnist for Control magazine since 2002. He is the leader of the monthly ISA “Ask the Automation Pros” Q&A posts that began as a series of Mentor Program Q&A posts in 2014. He started and guided the ISA Standards and Practices committee on ISA-TR5.9-2023, PID Algorithms and Performance Technical Report, and he wrote “Annex A - Valve Response and Control Loop Performance, Sources, Consequences, Fixes, and Specifications” in ISA-TR75.25.02-2000 (R2023), Control Valve Response Measurement from Step Inputs. Greg’s achievements include the ISA Kermit Fischer Environmental Award for pH control in 1991, appointment to ISA Fellow in 1991, the Control magazine Engineer of the Year Award for the Process Industry in 1994, induction into the Control magazine Process Automation Hall of Fame in 2001, selection as one of InTech magazine’s 50 Most Influential Innovators in 2003, several ISA Raymond D. Molloy awards for bestselling books of the year, the ISA Life Achievement Award in 2010, the ISA Mentoring Excellence award in 2020, and the ISA Standards Achievement Award in 2023. He has a BS in engineering physics from Kansas University and an MS in control theory from Missouri University of Science and Technology, both with emphasis on industrial processes.

Books:

Advances in Reactor Measurement and Control
Good Tuning: A Pocket Guide, Fourth Edition
New Directions in Bioprocess Modeling and Control: Maximizing Process Analytical Technology Benefits, Second Edition
Essentials of Modern Measurements and Final Elements in the Process Industry: A Guide to Design, Configuration, Installation, and Maintenance
101 Tips for a Successful Automation Career
Advanced pH Measurement and Control: Digital Twin Synergy and Advances in Technology, Fourth Edition
The Funnier Side of Retirement for Engineers and People of the Technical Persuasion
The Life and Times of an Automation Professional - An Illustrated Guide
Advanced Temperature Measurement and Control, Second Edition
Models Unleashed: Virtual Plant and Model Predictive Control Applications

Related Posts

Ask the Automation Pros: Achieving the Best Cascade Control

The following discussion is part of an occasional series, "Ask the Automation Pros," authored by Greg McM...
Greg McMillan Dec 6, 2024 7:00:00 AM

ISA's Position Papers from 2024: Collect Them All

The International Society of Automation (ISA) frequently releases positions on global issues affecting th...
Kara Phelps Dec 3, 2024 7:00:00 AM

Integrated Control System (ICS) for H2 Gas Generation

Abstract "H2 gas" refers to hydrogen gas (H2), which can be used as a clean energy carrier, meaning it ca...
Ankeet Anil Kaji Nov 26, 2024 7:00:00 AM