Menu
Index

ChronoScan Personalization

Need v1.0.0.61 or higher (licensed versions)
 
It is possible to customize ChronoScan's user interface through the use of a custom XML file. This feature allows you to simplify the user interface for end users.
 
To run ChronoScan using the custom initialization file you can specify this parameter on the command line:
 
-custom:"your path to custom xml.xml"
 
Or you can create a new shortcut to C:\Program Files (x86)\ChronoScan\Bin\ChronoScan.exe and add -custom:"your path to custom xml.xml"  to the Target field.
 
Your path can be a local file or a http source to simplify customization of a network operation.
 
The following are the currently available options (refer to the sample file at the bottom of this page):
 
Key
Description
general/apptitle
Allows to change the application title
 
general/showlogin
values: true | false
Allows to avoid the login screen
 
general/loginuser
optional
ChronoScan user
 
general/loginpassword
optional
ChronoScan password
 
general/usermode
values: true | false
Run ChronoScan in user mode (true) or administrator mode  (false)
 
general/input_module_active
empty or INPUTMODULES_FILES or INPUTMODULES_FILES_PDF or INPUTMODULES_DEMOIMGS or INPUTMODULES_TWAIN
optional
Specify the default input module
 
general/input_module_showonly
empty or INPUTMODULES_FILES or INPUTMODULES_FILES_PDF or INPUTMODULES_DEMOIMGS or INPUTMODULES_TWAIN
optional
Allows only to select the specified module
 
general/batch_panel_mode
values: 0 | 1
Force the batches panel mode report or tree view mode
0=report mode (default)
1=tree mode
 
splash/showlogo
optional
Path to a logo to show on the splash screen.
 
uservariables/uservariable
optional
Allows to add/modify user variables, this variables can be used for default field value, batch name, build paths in export configurations, etc.
parameters:
name="variable name"
 
actions/openbatch
optional
parameters:
job="JOBNAME"
batch="BATCHNAME"
empty_batch="true|false"
single_doc_mode="true|false"
 
Allows to open a batch directly
 
empty_batch to true, Empty the batch after loading it.
single_doc_mode to true, Set ChronoScan to work in single document mode.
 
actions/onmainframeclose
optional
forceexport="true", Force to export before close the program.
 
actions/mainframe
optional
parameters:
maximize="true|false"
help_page="http://yourwebhelppage", allows you to customize help button to redirect to your own help page.
Maximize ChronoScan window on startup.
 
actions/onexport
optional
parameters
close="true|false", Closes ChronoScan when export finish
silent="true|false", Execute export in silent mode
 
 
 
tabs/scan_tab
parameters: show="true"|"false"
optional
Show or hide the scan tab
 
tabs/index_tab
parameters: show="true"|"false"
optional
Show or hide the index tab
 
tabs/admin_tab
parameters: show="true"|"false"
optional
Show or hide the administration tab
 
ribbon
parameters: show_ids="true"|"false"
optional
When true run ChronoScan in a special mode that show button id's on his label/tooltip
 
 
The button Id is on the left, if the button is already hidden, the hidden tag is added. Use the button id on the hide_control nodes to hide buttons.
 
ribbon/hide_control
parameters: id="1560"
Hide the specified control id (see prev section to find button id's)
 
panels/resettodefault
Reset panel configuration to defaults every type the application is run.
 
panels/mainform
fontsize="24" Set the default font size for the main form
hidetoolbar="true|false" Hides the main form.
 
panels/maingrid
fontsize="24" Set the default font size for the main grid
hidetoolbar="true|false" Hides the main grid.
 
panels/thumbview
thumbsize="256", Set the thumbnail size in pixels
viewtitles="true|false" Set the show titles mode
 
 
 
Input Module Keys
 
imput_module/Chrono_basictwain/
config_button
Twain module
parameters: show="true"|"false"
Show or hide the config button
 
imput_module/Chrono_basictwain/
other_options_button
Twain module
parameters: show="true"|"false"
Show or hide the "other options" button
 
imput_module/Chrono_basictwain/
scan_button
Twain module
parameters: text="Scan" description="Start scan" icon="c:\scan.ico"
Change button text, description and icon to the scan button
 
 
To see the ids for all buttons on the interface you can set <ribbon show_ids="true">
 
Sample customization file:
 
 
<?xml version="1.0" encoding="utf-8"?>
 
<chrono_custom version="1">
  <general>
    <apptitle>Your app title</apptitle>
    <showlogin>false</showlogin>
    <loginuser>ChronoScan user</loginuser>
    <loginpassword>user passord</loginpassword>
    <usermode>false</usermode>
    <!-- input_module_active = empty or INPUTMODULES_FILES or INPUTMODULES_FILES_PDF or INPUTMODULES_DEMOIMGS or INPUTMODULES_TWAIN -->
    <input_module_active>INPUTMODULES_TWAIN</input_module_active>
    <!-- input_module_showonly = empty or INPUTMODULES_FILES or INPUTMODULES_FILES_PDF or INPUTMODULES_DEMOIMGS or INPUTMODULES_TWAIN -->
    <input_module_showonly>INPUTMODULES_TWAIN</input_module_showonly>
  </general>
  <splash>
    <showlogo>path_to_custom_logo.png</showlogo>
  </splash>
  <actions>
    <openbatch job="Your job name" batch="Your batch name"/>
  </actions>
  <uservariables>
    <uservariable name="variable1">variable 1</uservariable>
    <uservariable name="variable2">variable 1</uservariable>
    <uservariable name="variable3">variable 1</uservariable>
  </uservariables>
 
  <tabs>
    <scan_tab  show="true"/>
    <index_tab show="true"/>
    <admin_tab show="false"/>
  </tabs>
  <ribbon show_ids="false">
    <!--show_ids=Show the ids of the buttons for customization mode-->
    <!--hide_control=hide/disable the control id-->
 
    <!--desc is only for information in this xml-->
    <!-- "_" before id number, ignore this id-->
    <hide_control id="1674" desc="Scan/Imput - BATCHES Panel"/>
    <hide_control id="1151" desc="Scan/Imput - New Batch"/>
    <hide_control id="1125" desc="Scan/Imput - Open Batch"/>
    <hide_control id="_1608" desc="Scan/Imput - Export Batch"/>
    <hide_control id="1127" desc="Scan/Imput - Delete Batch"/>
    <hide_control id="1158" desc="Scan/Imput - Close Batch"/>
    <hide_control id="1531" desc="Scan/Imput - Document Split"/>
    <hide_control id="_1489" desc="Scan/Imput - Process selection"/>
    <hide_control id="1550" desc="Scan/Imput - Barcode read"/>
    <hide_control id="1563" desc="Scan/Imput - OCR Read"/>
    <hide_control id="1437" desc="Scan/Imput - Document types"/>
    <hide_control id="1147" desc="Scan/Imput - Search"/>
    <hide_control id="_1170" desc="Scan/Imput - View Doc. titles"/>
    <hide_control id="_1192" desc="Scan/Imput - Actions"/>
    <hide_control id="1316" desc="Scan/Imput - Options"/>
    <hide_control id="1638" desc="Scan/Imput - Task and Process"/>
    <hide_control id="57643" desc="Scan/Imput - Undo"/>
    <hide_control id="1625" desc="Scan/Imput - Change user"/>
    <hide_control id="_1452" desc="Scan/Imput - Search help"/>
    <hide_control id="1560" desc="Scan/Imput - License manager"/>
  </ribbon>
  <panels>
    <resettodefault>true</resettodefault>
  </panels>
  <imput_module>
    <Chrono_basictwain>
      <!-- hide config button in twain scan dialog-->
      <config_button show="false"/>
      <!-- hide other options button in twain scan dialog-->
      <other_options_button show="false"/>
      <!-- scan button options-->
      <scan_button text="Scan" description="Start scan" icon="c:\scan.ico"/>
    </Chrono_basictwain>
  </imput_module>
 
</chrono_custom>
 
comments powered by Disqus