RR-53 Notes

Temporary notes relating to ticket

Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.

Current Functions

Location	Function Name	Input	Output	If Error	Notes
rr_rrtf/convert.py	RRTF_Cracked_To_XML	File Object containing Cracked TXT	String containing XML	Write files to CWD and raise exception.
rr_rrtf/convert.py	RRTF_XML_To_Cracked	File Object containing XML	String containing Cracked TXT	No special behaviour
rr_rrtf/convert.py	VA_XML_To_Dict	File Object containing XML File Object containing XML Schema	A dictionary with the structure Dictionary['Vascular Access'](Headers, Row, Row, Row, Row)	No special behaviour	This was an attempt to produce a partial Vascular Access spreadsheet return from a Quarterly File. It is not currently in use.
rr_rrtf/convert.py	RRTF_XML_To_Dict	File Object containing XML File Object containing XML Schema	A dictionary with the structure Dictionary['XXX'](Headers, Row, Row, Row, Row) where XXX is each block in the schema.	No special behaviour	This is used by the "TXT to XLS" function.
rr_rrtf/convert.py	RRTF_Cracked_To_XLS	File Object containing XML File Object containing XML Schema Path to save XLS to (Optional) XSL to use for Counts (Optional) Only Write "Interesting" (those rows with errors) (Optional) Vascular Access (use VA_XML_To_Dict rather than RRTF_XML_To_Dict)	No return values. XLS file is saved to supplied path.	Produces a message containing information to aid debugging and displays to easygui.textbox. Tries to quit program using sys.exit(0).
rr_rrtf/convert.py	RRTF_Schema_To_XLS	File Object containing XLS Schema Path to save XLS to	No return values. XLS file is saved to supplied path.	No special behaviour	This is used to turn the UKRR XLS schema into a spreadsheet for documentation purposes. I don't think it's been used recently.
rr_rrtf/convert.py	Convert_XLS_To_Cracked	CNT00 Value (Centre) CNT02 Value (Quarter) Path to Input XLS Path to Output TXT	No return values. TXT file is saved to supplied path.	No special behaviour
rr_rrtf/convert.py	Convert_Schema_To_XLS	No input parameters	No return values.	No special behaviour	Were this in active use it should be moved to rr_validation as has happened with the other GUI functions.
rr_rrtf/transform.py	check_tags	LXML Tree	True/False depending on whether errors were found.	Uses return values.	Checks that data tags are in the form AAA00 and that they have a parent element with the same prefix.
rr_rrtf/transform.py	build_xml	String containing Cracked TXT	LXML Tree	Uses logger / exceptions in certain cases.	There's a bit about QBL07 / QBL08 which I don't think should be in here.
rr_rrtf/transform.py	make_xml	Path to Cracked TXT		No special behaviour
rr_rrtf/transform.py	deconstruct	LXML Tree	String with Cracked TXT	No special behaviour	This could be re-written to use the XSL.
rr_rrtf/transform.py	dump_xml	Path for Cracked TXT LXML Tree	No return values.	No special behaviour
rr_rrtf/transform.py	crack	Path with RR TXT Path to save Cracked TXT	No return values	No special behaviour
rr_rrtf/transform.py	tempxml	Path to Cracked TXT	No return Values	If there is an exception in converting back to TXT it logs an error and tries to exit the application with sys.exit(2)	I find this a bit odd. It converts the Cracked TXT to XML which it returns, but then tries to convert it back to TXT as an apparent safety guard against something having broken.