Common Functions

Main Functions

grab_id(bookcode, sch_kw, models, isgl=False, datatype="data", month=None, sch_col="docno")

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

grab_whole_doc(bookcode, identifiers, master_model, detail_models, isgl=False,
               datatype="data", month=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

gen_dbcommit_resp(dbtype, tbname, model, form, perm_bit=None, allowed_action=None,
                  suppress_success_msg=False, lock_on_add=True, head_id_col="id",
                  get_dict=None, skip_validation=False, month=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

prefetch_all_docs(bookcode, master_spec, detail_specs, isgl=False, datatype="data",
                  month=None, headid=None, id_col="id", return_instance=False, crossers=[])

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

prep_copy(cp_form, bookcode, head_model, detail_models=[], isgl=False)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

create_doc_copy(cp_form, copy_params, bookcode, orig_doc, head_model, detail_models={},
                isgl=False, omit_cols=[])

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

check_modact_stat(modid=None, modcode=None, mode="activate", response="return")

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

process_doc_file(dbtype, tbname, model, at_form, isgl=False, month=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

gen_random_token(length=10, lower=True, upper=True, number=True)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

User Authentication Functions

process_beacon_args(internal_args, request)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

process_doclock(beacon_args, module_name, perm_name, headmodel=None, paired_gl=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

change_datetime(form, reset=False, date_obj=None, time_obj=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

Thread Functions

init_task_db(job_token, overall_load, new_stat="", activity_str="",
             suppress_request=True, further_action="")

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

update_task_db(job_token, finished_load=0, overall_load=None,
               new_stat=None, activity_str=None, further_action=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

read_task_db(job_token)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

read_resus_import_file(job_token, will_abort=False)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

Printing Functions

print_in_thread(job_token, doc_objs, pseudo_mapper, modcode, template_name,
                svg_name=None, stat_cols=[], skip_company_template=False,
                make_pdfa3=False)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

gen_qr(num, qr_type="out", info=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

replace_printsvg(tbfm_mapper, modcode, bookname=None, svg_name=None, suffix=None,
                 job_data=None, clear_printed=True, skip_company_template=False,
                 make_pdfa3=False)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

Spreadsheet Export Functions

gen_spreadsheet(specs, round_all=None, col_desc=None, col_size={})

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

Import & Mass Delete Functions

docimport_to_db(file_path, dbtype, dbname, models, specs, month=None,
                verify_cmd=None, post_cmd=None, addi_args=[], autorun_specs=None,
                job_token=None, custom_datasets=None)

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX

doc_mass_delete(dbtype, dbname, models, doc_objs=[], month=None, post_cmd=None,
                job_token=None, addi_args=[], docno_to_skip=[])

Description	XXXXXX
Parameters	xxx (xxx): xxx (xxx):
Returns	xxx (xxx): xxx (xxx):
Notes	XXXXXX