Common Functions - ประวัติรุ่นแก้ไข

Tenko: /* Database Read Functions */

2024-10-24T03:52:14Z

Database Read Functions

@@ บรรทัดที่ 49: / บรรทัดที่ 49: @@
 * '''main_entry counter''' ''([int, int])'': The first integer represents the order of the current document (starting from 1); the second integer is the number of documents present in the databse.
 * '''flash''' ''(list)'': A list of flash message to appear on the client-side along with the requested document. Usually the messages sent this way are the First/Last entry notifications.
 |}

Tenko: /* Import & Mass Delete Functions */

2024-07-26T07:26:55Z

Import & Mass Delete Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 14:26, 26 กรกฎาคม 2567
บรรทัดที่ 404:		บรรทัดที่ 404:
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Parameters''' \|\|		\| '''Parameters''' \|\|
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''file_path''' ''(str)'':
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''dbtype''' ''(str: {{code\|lang=python\|'table'}}, {{code\|lang=python\|'data'}}, or {{code\|lang=python\|'report'}})'': The data type (location) of the database file.
			* '''dbname''' ''(str)'': The database name.
			* '''models''' ''([CuneiModel,])'': The list of the database models.
			* '''specs''' ''(dict)'':
			* '''month''' ''(date, or datetime)'': The data month (effective for {{code\|lang=python\|1= datatype='data'}}). If the argument is a string, it must be formatted either as {{code\|YYYYMM}} or {{code\|YYYYMMDD}}.
			* '''verify_cmd''' ''(function)'':
			* '''post_cmd''' ''(function)'':
			* '''addi_args''' ''(list)'':
			* '''autorun_specs''' ''(list)'':
			* '''job_token''' ''(str)'': Job token of the task (usually a randomly generated string).
			* '''custom_datasets''' ''([[[list,],],] or {{code\|lang=python\|None}})'':
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Returns''' \|\|		\| '''Returns''' \|\| A Boolean indicating whether the import process invokes any error.
	* '''xxx''' ''(xxx)'':
	* '''xxx''' ''(xxx)'':
	~~\|- style="vertical-align:top;"~~
	~~\| '''Notes''' \|\| XXXXXX~~
	\|}		\|}

Tenko: /* Printing Functions */

2024-07-26T07:23:28Z

Printing Functions

@@ บรรทัดที่ 359: / บรรทัดที่ 359: @@
 * The final concatenated PDF is always named {{code|lang=python|'<username>_out.pdf'}} and located in the company's {{code|temp}} directory.
 * The arguments '''doc_objs, modcode, pseudo_mapper, template_name, svg_name,''' and '''stat_cols''' can be layered one level deeper into lists, as demonstrated in Example #2. ''(Note that, in the example '''modcode''' is not layered; the function can assume that the same '''modcode''' should apply to all iterations.)''
 |}

Tenko: /* Printing Functions */

2024-07-26T07:23:14Z

Printing Functions

@@ บรรทัดที่ 200: / บรรทัดที่ 200: @@
 * '''message''' ''(str)'': The message to communicate the success/failure to the client. Developers are expected to pack this message into a response afterward.
 * '''timediff''' ''(int)'': The difference between the session time and the server time ({{code|lang=python|session_time - server_time}}) in milliseconds.
 |}

Tenko: /* Spreadsheet Export Functions */

2024-07-26T07:11:23Z

Spreadsheet Export Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 14:11, 26 กรกฎาคม 2567
บรรทัดที่ 398:		บรรทัดที่ 398:
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Parameters''' \|\|		\| '''Parameters''' \|\|
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''specs''' ''(dict)'':
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''round_all''' ''(int or {{code\|lang=python\|None}})'':
			* '''col_desc''' ''(dict)'':
			* '''col_size''' ''(dict)'':
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Returns''' \|\|		\| '''Returns''' \|\| The path to the exported spreadsheet (XLSX) file.
	* '''xxx''' ''(~~xxx~~)~~'':~~
	* '''xxx''' ''(xxx)'':
	~~\|- style="vertical-align:top;"~~
	~~\| '''Notes''' \|\| XXXXXX~~
	\|}		\|}

Tenko: /* Thread Functions */

2024-07-26T06:55:57Z

Thread Functions

แสดงการเปลี่ยนแปลง

Tenko: /* Printing Functions */

2024-07-26T06:40:33Z

Printing Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 13:40, 26 กรกฎาคม 2567
บรรทัดที่ 305:		บรรทัดที่ 305:
	\| '''Returns''' \|\| The path to the output PDF file ''(str)'' or {{code\|lang=python\|None}} if the templates cannot be found.		\| '''Returns''' \|\| The path to the output PDF file ''(str)'' or {{code\|lang=python\|None}} if the templates cannot be found.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Notes''' \|\| The final ~~concatenated~~ PDF is always located in the company's {{code\|temp}} directory and named either {{code\|lang=python\|'<username>_out.pdf'}} or {{code\|lang=python\|'<username>_out_<suffix>.pdf'}}.		\| '''Notes''' \|\| The final PDF is always located in the company's {{code\|temp}} directory and named either {{code\|lang=python\|'<username>_out.pdf'}} or {{code\|lang=python\|'<username>_out_<suffix>.pdf'}}.
	\|}		\|}

บรรทัดที่ 351:		บรรทัดที่ 351:
	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| style="width:120px;" \| '''Description''' \|\| ~~XXXXXX~~		\| style="width:120px;" \| '''Description''' \|\| Generate QR code for making or receiving payment. The QR code expects '''Thailand's Tax ID Promptpay''' format.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Parameters''' \|\|		\| '''Parameters''' \|\|
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''num''' ''(float)'': The numerical value to embed in the QR code (in THB).
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''qr_type''' ''({{code\|lang=python\|'in'}} or {{code\|lang=python\|'out'}})'': Whether the QR code is for paying or receiving money.
			* '''info''' ''([str:company_name, str:company_taxID] or {{code\|lang=python\|None}})'': If the argument is {{code\|lang=python\|None}}, the function assumes the company name and tax ID of the current company.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Returns''' \|\|		\| '''Returns''' \|\| The path to the output PNG file ''(str)'' or a 404-abortion the image cannot be created.
	* '''xxx''' ''(~~xxx~~)'':
	* '''xxx''' ''(xxx)'':
	~~\|- style="vertical~~-~~align:top;"~~
	~~\| '''Notes''' \|\| XXXXXX~~
	\|}		\|}

Tenko: /* Printing Functions */

2024-07-26T05:15:49Z

Printing Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 12:15, 26 กรกฎาคม 2567
บรรทัดที่ 281:		บรรทัดที่ 281:
	make_pdfa3=False)		make_pdfa3=False)

	# Example adapted from accounting journal ~~mass-~~printing.		# Example adapted from accounting journal printing.
	tbfm_dict = {"f1":thisdoc, "t1":thisdoc.detail, "t2":thisdoc.vat_detail, "t3":thisdoc.wht_detail}		tbfm_dict = {"f1":thisdoc, "t1":thisdoc.detail, "t2":thisdoc.vat_detail, "t3":thisdoc.wht_detail}
	pdf_path = replace_printsvg(tbfm_dict, "cunei_gl", bookname="GL_BOOK",		pdf_path = replace_printsvg(tbfm_dict, "cunei_gl", bookname="GL_BOOK",

Tenko: /* Printing Functions */

2024-07-26T05:15:20Z

Printing Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 12:15, 26 กรกฎาคม 2567
บรรทัดที่ 280:		บรรทัดที่ 280:
	job_data=None, clear_printed=True, skip_company_template=False,		job_data=None, clear_printed=True, skip_company_template=False,
	make_pdfa3=False)		make_pdfa3=False)

			# Example adapted from accounting journal mass-printing.
			tbfm_dict = {"f1":thisdoc, "t1":thisdoc.detail, "t2":thisdoc.vat_detail, "t3":thisdoc.wht_detail}
			pdf_path = replace_printsvg(tbfm_dict, "cunei_gl", bookname="GL_BOOK",
			svg_name="GL_{}".format(thisdoc.docno[:3]))
	</syntaxhighlight>'''		</syntaxhighlight>'''
	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"
บรรทัดที่ 286:		บรรทัดที่ 291:
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Parameters''' \|\|		\| '''Parameters''' \|\|
	* '''tbfm_mapper''' ''(dict)'':		* '''tbfm_mapper''' ''(dict)'': The dict matching the form/table references (as used in SVG templates) to the objects holding the values.
	* '''modcode''' ''(str)'': ''(Obsolete)''		** A reference to a '''form''' take the format {{code\|lang=python\|'f1'}}, {{code\|lang=python\|'f2'}}, {{code\|lang=python\|'f3'}}, .... The corresponding value is an {{code\|lang=python\|Object}} (preferably a CuneiModel instance).
	* '''bookname''' ''(str)'':		** A reference to a '''table''' take the format {{code\|lang=python\|'t1'}}, {{code\|lang=python\|'t2'}}, {{code\|lang=python\|'t3'}}, .... The corresponding value is an iterable (e.g. a list) of {{code\|lang=python\|Object}}s (preferably a CuneiModel instances).
	* '''svg_name''' ''(str)'':		* '''modcode''' ''(str)'': ''(Obsolete)'' The code of the module from which the printing is invoked.
	* '''suffix''' ''(int)'':		* '''bookname''' ''(str)'': The name of the fallback template to be used in case the template '''svg_name''' is not found. Usually this coincides with the database file name, hence the argument name.
	* '''job_data''' ''(list)'':		* '''svg_name''' ''(str)'': The name of the print template.
	* '''clear_printed''' ''(bool)'':		* '''suffix''' ''(int)'': The suffix to append to the PDF file name. This argument is only used internally via {{code\|print_in_thread}} where multiple documents are printed as separated PDF files to be concatenated together in the final step.
	* '''skip_company_template''' ''(bool)'':		* '''job_data''' ''(list or {{code\|lang=python\|None}})'': The task information. This argument is only applicable when printing in a long-job (usually via {{code\|print_in_thread}}).
	* '''make_pdfa3''' ''(bool)'':		* '''clear_printed''' ''(bool)'': Whether to clear other residual PDFs that might be left in the company's {{code\|temp}} directory. This argument is exclusively set to {{code\|lang=python\|True}} via {{code\|print_in_thread}} where multiple PDFs are to be concatenated. ''(Only affects temporary PDFs created by the same user.)''
			* '''skip_company_template''' ''(bool)'': Whether to skip looking for print templates in the company-specific folder and only look for CuneiFox official templates.
			* '''make_pdfa3''' ''(bool)'': Whether to convert the final PDF to PDF/A-3b.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Returns''' \|\| The path to the output PDF file ''(str)''.		\| '''Returns''' \|\| The path to the output PDF file ''(str)'' or {{code\|lang=python\|None}} if the templates cannot be found.
			\|- style="vertical-align:top;"
			\| '''Notes''' \|\| The final concatenated PDF is always located in the company's {{code\|temp}} directory and named either {{code\|lang=python\|'<username>_out.pdf'}} or {{code\|lang=python\|'<username>_out_<suffix>.pdf'}}.
	\|}		\|}

บรรทัดที่ 303:		บรรทัดที่ 312:
	svg_name=None, stat_cols=[], skip_company_template=False,		svg_name=None, stat_cols=[], skip_company_template=False,
	make_pdfa3=False)		make_pdfa3=False)

			# Example adapted from accounting journal mass-printing.
			print_in_thread(job_token, doc_objs, modcode="cunei_gl",
			pseudo_mapper={"f1":"self", "t1":"detail", "t2":"vat_detail", "t3":"wht_detail"},
			template_name="GL_BOOK", svg_name=chosen_template,
			stat_cols=["docno"], make_pdfa3=make_pdfa3)
	</syntaxhighlight>'''		</syntaxhighlight>'''
	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| style="width:120px;" \| '''Description''' \|\| ~~XXXXXX~~		\| style="width:120px;" \| '''Description''' \|\| The custom printing function that enables using custom templates, printing multiple documents at once, and the PDF/A-3b option. Because it allows multiple-document printing and the process can potentially take a long time, this means of printing is done in as a long-job in a Thread.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Parameters''' \|\|		\| '''Parameters''' \|\|
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''job_token''' ''(str)'': Job token of the task (usually a randomly generated string).
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''doc_objs''' ''([CuneiModels_instance,])'': The list (iterable) containing the prefetched Cuneifox instances for the documents to be printed.
			* '''pseudo_mapper''' ''(dict)'': The dict matching the form/table references (as used in SVG templates) to the objects holding the values. However, this argument can be one-level more abstracted than '''tbfm_mapper''' of {{code\|replace_printsvg}} to facilitate multiple-document printing.
			** A reference to a '''form''' take the format {{code\|lang=python\|'f1'}}, {{code\|lang=python\|'f2'}}, {{code\|lang=python\|'f3'}}, .... The corresponding value can be either:
			*** An {{code\|lang=python\|Object}} (preferably a CuneiModel instance) '''OR'''
			*** The string {{code\|lang=python\|'self'}} to indicate that the master entry itself is being referenced '''OR'''
			*** A back-reference of the ForeignKeyField linking the entry of interest to the master entry ''(str)''.
			** A reference to a '''table''' take the format {{code\|lang=python\|'t1'}}, {{code\|lang=python\|'t2'}}, {{code\|lang=python\|'t3'}}, .... The corresponding value can be either:
			*** An iterable (e.g. a list) of {{code\|lang=python\|Object}}s (preferably a CuneiModel instances) '''OR'''
			*** A back-reference of the ForeignKeyField linking the sub-entries to the master entry ''(str)''.
			* '''modcode''' ''(str)'': ''(Obsolete)'' The code of the module from which the printing is invoked.
			* '''template_name''' ''(str)'': The name of the fallback template to be used in case the template '''svg_name''' is not found.
			* '''svg_name''' ''(str)'': The name of the print template.
			* '''stat_cols''' ''(str)'': The column of the master entries to use as the process indicator ''(e.g. 'Currently printing document <???>...')''.
			* '''skip_company_template''' ''(bool)'': Whether to skip looking for print templates in the company-specific folder and only look for CuneiFox official templates.
			* '''make_pdfa3''' ''(bool)'': Whether to convert the final PDF to PDF/A-3b.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Returns''' \|\|		\| '''Returns''' \|\| {{code\|lang=python\|None}}
	* '''xxx''' ''(xxx)'':
	* '''xxx''' ''(xxx)'':
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Notes''' \|\| ~~XXXXXX~~		\| '''Notes''' \|\| The final concatenated PDF is always named {{code\|lang=python\|'<username>_out.pdf'}} and located in the company's {{code\|temp}} directory.
	\|}		\|}

Tenko: /* Printing Functions */

2024-07-25T06:01:34Z

Printing Functions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 13:01, 25 กรกฎาคม 2567
บรรทัดที่ 276:		บรรทัดที่ 276:

	== Printing Functions ==		== Printing Functions ==
	'''<syntaxhighlight lang="python" id="~~print_in_thread~~">		'''<syntaxhighlight lang="python" id="replace_printsvg">
	~~print_in_thread~~(~~job_token~~, ~~doc_objs~~, ~~pseudo_mapper~~, ~~modcode~~, ~~template_name~~,		replace_printsvg(tbfm_mapper, modcode, bookname=None, svg_name=None, suffix=None,
	~~svg_name~~=None, ~~stat_cols~~=[], skip_company_template=False,		job_data=None, clear_printed=True, skip_company_template=False,
	make_pdfa3=False)		make_pdfa3=False)
	</syntaxhighlight>'''		</syntaxhighlight>'''
	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| style="width:120px;" \| '''Description''' \|\| ~~XXXXXX~~		\| style="width:120px;" \| '''Description''' \|\| The main function for printing. Replace [[CuneiTongue]] tags in SVG templates with appropriate values.
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''Parameters''' \|\|		\| '''Parameters''' \|\|
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''tbfm_mapper''' ''(dict)'':
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''modcode''' ''(str)'': ''(Obsolete)''
	~~\|- style="vertical-align~~:~~top;"~~		* '''bookname''' ''(str)'':
	\| '''~~Returns~~''' \|\|		* '''svg_name''' ''(str)'':
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''suffix''' ''(int)'':
	* '''~~xxx~~''' ''(~~xxx~~)'':		* '''job_data''' ''(list)'':
			* '''clear_printed''' ''(bool)'':
			* '''skip_company_template''' ''(bool)'':
			* '''make_pdfa3''' ''(bool)'':
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\| '''~~Notes~~''' \|\| ~~XXXXXX~~		\| '''Returns''' \|\| The path to the output PDF file ''(str)''.
	\|}		\|}

	'''<syntaxhighlight lang="python" id="~~gen_qr~~">		'''<syntaxhighlight lang="python" id="print_in_thread">
	~~gen_qr~~(~~num~~, ~~qr_type~~=~~"out"~~, ~~info~~=~~None~~)		print_in_thread(job_token, doc_objs, pseudo_mapper, modcode, template_name,
			svg_name=None, stat_cols=[], skip_company_template=False,
			make_pdfa3=False)
	</syntaxhighlight>'''		</syntaxhighlight>'''
	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"
บรรทัดที่ 314:		บรรทัดที่ 319:
	\|}		\|}

	'''<syntaxhighlight lang="python" id="~~replace_printsvg~~">		'''<syntaxhighlight lang="python" id="gen_qr">
	~~replace_printsvg~~(~~tbfm_mapper~~, ~~modcode, bookname~~=~~None, svg_name=None, suffix=None~~,		gen_qr(num, qr_type="out", info=None)
	~~job_data~~=None~~, clear_printed=True, skip_company_template=False,~~
	~~make_pdfa3=False~~)
	</syntaxhighlight>'''		</syntaxhighlight>'''
	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"