Table of Contents | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Configuration via custom.js
The configuration file custom.js for the operationsGui is stored in the ./operations_gui directory beside the ./config directory.
For releases < 1.3.9 you find the custom.js in the ./config/html directory.
In the custom.js are some variables which are defaults when the site is loaded but can be overwritten via cookies.
The custom.js of version 1.3.9 contains the following variables:
Cookie Behaviour
Possible values are true
and false
.
If false
then almost all following variables are stored in cookies, so that these settings are only default values and will be overwritten via the cookies.
If true
then only filters are read from cookies whereat the defined correspondent filters in this file have priority.
Code Block |
---|
_disable_cookie_settings = false; |
Language
Set the interface language.
A language file scheduler_lang_sos_lang.js_ (i.e. scheduler_lang_ru.js for russian) must exist.
The language files are stored in the ./operations_gui directory beside the ./bin directory.
For releases < 1.3.9 you find the language files in the ./config/html directory.
If this value is empty then no language file is tried to include and english is used.
At this time 'de'
(german), 'fr'
(french) and 'ru'
(russian) is supported.
Code Block |
---|
_sos_lang = ''; |
If you want a user-defined language setting then look to the sample below.
Automatically Refresh
Possible values are true
and false
.
If true
then the periodically update is on.
Code Block |
---|
_update_periodically = false; |
Interval between the periodically updates in seconds.
Code Block |
---|
_update_seconds = 5; |
Views
You can switch between the tabs 'jobs'
, 'job_chains'
, 'process_classes'
and 'last_activities'
as the beginning view.
Code Block |
---|
_show_card = 'jobs'; |
For some tabs you can set the default view mode (list
or tree
).
Code Block |
---|
_view.jobs = 'list'; _view.job_chains = 'list'; |
Checkboxes, Radios And Selectboxes
You can specify which checkboxes are on (true
) or off (false
).
Code Block |
---|
_checkbox_states.show_tasks_checkbox = true; _checkbox_states.show_job_chain_orders_checkbox = true; _checkbox_states.show_job_chain_jobs_checkbox = false; _checkbox_states.show_order_history_checkbox = false; _checkbox_states.show_task_error_checkbox = false; _checkbox_states.show_error_checkbox = false; |
You can specify the value of some radios.
The possible values for last_activities_radios are 'all'
, 'orders'
and 'tasks'
.
Code Block |
---|
_radio_states.last_activities_radios = 'all'; |
You can specify the value of some selectboxes.
The possible values for show_jobs_select are 'all'
, 'standalone'
and 'order'
.
The possible values for jobs_state_select are 'all'
, 'running'
, 'stopped'
, 'running_or_stopped'
and 'other'
.
Code Block |
---|
_select_states.show_jobs_select = 'all'; _select_states.jobs_state_select = 'all'; |
Number Of Displayed Orders Or Tasks Resp.
You can set how much orders are shown in the job chains if the checkbox show orders is checked.
Code Block |
---|
_max_orders = 10; |
You can set how much orders and tasks are shown in the last activities tab.
Code Block |
---|
_max_last_activities = 30; |
Number Of History Entries
Per default the last 50 entries are shown from the orders history and last 10 from the tasks history respectively.
Code Block |
---|
_max_order_history = 50; _max_task_history = 10; |
Timeout For Terminate
In the top menu you find a terminte with timeout. Here you set the timeout in seconds.
Code Block |
---|
_terminate_timeout = 60; |
Default For 'Start at'
In start task/order at dialogs are set the start time equals now per default. You can omit this.
Code Block |
---|
_start_at_default_is_now = true; |
Start Task Unforced Now
Enables the additional job menu item Start task unforced now.
Code Block |
---|
_start_next_period_enabled = false; |
Debug Level
Possible values are 0-9.
A new window will be open to write the debug information. A popup blocker should allow this.
Code Block |
---|
_debug_level = 0; |
Additional URLs In 'Extras' Menu
You can add arbitrary URLs to the popup menu of the extras button on the top in the form:
Code Block |
---|
_extra_urls[ 'display name' ] = 'url'; |
Aliase
You can set an URL mapping for the remote schedulers if i.e. an Apache proxy configuration is used.
For more information about proxy configuration see 'Running the Operations GUI behind an Apache Proxy'.
Set an alias in the form:
Code Block |
---|
_url_aliase[ 'remote_host:remote_port' ] = 'url'; |
Filters
For more information see 'How can I store filters persistent which are not disappear after cleanup cookies?'.
You can set filters for jobs, job chains and order in the form
Code Block |
---|
_job_filter[ 'filter name' ] = 'regular expression'; _job_chain_filter[ 'filter name' ] = 'regular expression'; _order_filter[ 'filter name' ] = 'regular expression'; |
or use
Code Block |
---|
_project_filter[ 'filter name' ] = 'regular expression'; |
which is effective for jobs, job chains and orders simultaneously.
A selectbox will be displayed with the filter names.
To set which selectbox option is selected you can use
Code Block |
---|
_active_job_filter = 'name of the filter'; _active_job_chain_filter = 'name of the filter'; _active_order_filter = 'name of the filter'; |
or
Code Block |
---|
_active_project_filter = 'name of the filter'; |
User-defined Configuration via my_custom.js
While the configuration file custom.js (see above) for the operationsGui is always read,
you can create an additional own configuration file i.e. my_custom.js to overwrite the settings in custom.js.
The file my_custom.js is read when you type the URL
Code Block |
---|
http://[scheduler_host]:[scheduler_port]/index.html#my_custom |
The user-defined configuration file my_custom.js must be stored in the same directory like custom.js.
- Sample
<p style="border-left:2px solid SteelBlue;padding-left:8px;">
Code Block |
---|
The language of the operationsGui is english, but some users want the operationsGui in russian. <br/>Create the file 'ru.js' with the content <br/><tt>_sos_lang = 'ru';</tt> <br/>and type <br/><tt>http://[scheduler_host]:[scheduler_port]/index.html#ru</tt> |
</p>
FAQs
See JobScheduler_FAQ