_meta.kind=Quintiq Template Property File
_meta.specification=liboptbt
_meta.template=liboptbt
_meta.type=quill library
_meta.version.config=1.1
_meta.version.quintiq=6.3.1

#default values for optional fields:
#<property>.hidevalue=false
#<property>.persistent=false
#<property>.changevalueallowed=true
#<property>.repositorytyperestriction=all
#<property>.mandatory=false
#<property>.multiline=false
#<property>.constraint=""

liboptbt.autoexportresult.argtype=boolean
liboptbt.autoexportresult.defaultvalue=false
liboptbt.autoexportresult.description=If true, LibOpt_BT will export result automatically to path listed in "resultexportpath" once test is completed
liboptbt.autoexportresult.mandatory=true

liboptbt.backuprundatasets.argtype=boolean
liboptbt.backuprundatasets.defaultvalue=false
liboptbt.backuprundatasets.description="If true, LibOpt_BT will backup the datasets in which the benchmark has been run.\nIf false, LibOpt_BT will not backup the datasets in which the benchmark has been run."

liboptbt.backuprundatasetspath.argtype=string
liboptbt.backuprundatasetspath.defaultvalue="../benchmark-backups/"
liboptbt.backuprundatasetspath.description="Directory where LibOpt_BT will export the dataset after a benchmark run has completed. This allows you to check the dataset at a later time.\nThis is only done if \"backuprundatasets\" is set to true.\n\nWe highly advise you to store your runs outside of the model path, so you cannot accidentally add it to version control. The default adds a new directory called \"benchmark-backups\" in your Quintiq installation directory.\n(default=../benchmark-backups/)"

liboptbt.numberofiterations.argtype=number
liboptbt.numberofiterations.constraint=[1,1000000]
liboptbt.numberofiterations.defaultvalue=1
liboptbt.numberofiterations.description="Number of benchmark iterations.\n(default=1)"
liboptbt.numberofiterations.mandatory=true

liboptbt.queuetemplate.argtype=string
liboptbt.queuetemplate.defaultvalue=""
liboptbt.queuetemplate.description="Name of the QueueTemplate that specifies which benchmarks should be executed.\nIf the QueueTemplate does not exist, all tables will be executed once."

liboptbt.resultexportcharacterencoding.argtype=string
liboptbt.resultexportcharacterencoding.defaultvalue=UTF-8
liboptbt.resultexportcharacterencoding.description=Indicate which character encoding to use for the output file

liboptbt.resultexportformat.argtype=string
liboptbt.resultexportformat.constraint=(JSON)
liboptbt.resultexportformat.defaultvalue=JSON
liboptbt.resultexportformat.description=Indicate the export format (currently only JSON)

liboptbt.resultexportpath.argtype=string
liboptbt.resultexportpath.defaultvalue="~log/libopt_bt"
liboptbt.resultexportpath.description="Directory where LibOpt_BT will export test results when the benchmarks are completed. Default: ~log/libopt_bt\n\nExport of benchmarks results only happens if \"autoexportresult\" is set to true."

liboptbt.runonstartup.argtype=boolean
liboptbt.runonstartup.defaultvalue=false
liboptbt.runonstartup.description="If true, LibOpt_BT dataset, upon creation/loading, will run the benchmarks.\n(default=false)"
liboptbt.runonstartup.mandatory=true

liboptbt.showprogress.argtype=boolean
liboptbt.showprogress.defaultvalue=false
liboptbt.showprogress.description="If true, LibOpt_BT will write benchmark progress in server log.\nBy default it is set to false.\n\nSample benchmarking progress:\nExecuting benchmarks...\nExecuting benchmark 1 (<Cell1>)\nExecuting benchmark 2 (<Cell2>)"
liboptbt.showprogress.mandatory=true

liboptbt.shutdownaftercompletion.argtype=boolean
liboptbt.shutdownaftercompletion.defaultvalue=false
liboptbt.shutdownaftercompletion.description="If true, LibOpt_BT will shutdown the server after all benchmarks were auto-run on server startup.\nAuto shutdown of the server is only done when \"runonstartup\" is set to true.\n(default=false)"