OX6:Gui path

2009-12-24T13:59:55Z

Jamesbruk: /* Settings for the infostore module */

==== GUI settings ====
This table shows the possible gui settings stored in /gui. The settings are stored in a javascript object notation (JSON) which is directly computed by the GUI. Information about JSON can be found in the [[HTTP_API]]. Per default, this object is not existent upon user creation and is stored by the GUI after the first logout. This object then can be manipulated through the RMI interface (as well as on the command line). It is not necessary to define all settings (inner objects), missing ones will be added by the GUI automatically. When settings should be changed after a user has logged in, remember that there might be user defined settings which should not be touched and kept. This also means if the GUI settings of a user should be reset, this can be done by deleting the whole object.

{| id="gui_path" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''Gui settings'''
|-
! name !! type !! value !! comment
|-
| infostore || Object || [[#infostore object|infostore object]] || infostore settings
|-
| mail || Object || [[#mail object|mail object]] || mail settings
|-
| portal || Object || [[#portal object|portal object]] || portal layout and content
|-
| global || Object || [[#global object|global object]] || timestamp settings and global settings
|-
| menu || Object || [[#menue object|menue object]] || menu iteration
|-
| theme || Object || [[#theme object|theme object]] || default theme and path
|-
| effects || Object || [[#effects object|effects object]] || hover and global effects
|-
| tasks || Object || [[#tasks objects|tasks objects]] || tasks settings
|-
| FolderTreeState || Object || [[#foldertree object|foldertree object]] || holds the folder tree state
|-
| contacts || Object || [[#contacts object|contacts object]] || contacts settings
|-
| calendar || Object || [[#calendar object|calendar object]] || calendar settings
|-
|}

====Settings for the infostore module====
This table containsv [http://www.poker-rooms-review.org online hold'em] the settings for the GUI's infostore
{| id="infostore object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''infostore object'''
|-
! name !! type !! values !! comment
|-
| view || value || infostore/(list,split) || infostore view
|}

====Settings for the E-Mail module====
This tables contains the settings for the E-Mail module.
{| id="mail object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''mail object'''
|-
! name !! type !! values !! comment
|-
| auto_save_drafts || Number || 0,1,3,5,10,15,30|| time in minutes, 0 for disabled
|-
| htmlmessage || Boolean|| true,false || show email as html or plain text
|-
| signatures || Array || [[#signature objects|signature objects]] || array of signature objects
|-
| view || String || mail/(list,hsplit,vsplit)/unthreaded || mail view
|-
| view spam || String || mail/(list,hsplit,vsplit)/unthreaded || mail view for spam folder
|-
| autocomplete || Boolean || true,false || autocomplete functions
|-
| fullmailheader || Boolean || true,false || show complete mail header
|-
| notifyacknoledge ||Boolean || true,false || notify on read acknowledgment
|-
| newmail_options || Object || [[#newmail_options objects|newmail_options objects]] || object for the new email window settings
|-
| formatmessage || String || ALTERNATIVE,TEXT/HTML,TEXT/PLAIN || email format
|}

{| id="newmail_options objects" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''newmail_options objects'''
! name !! type !! values !! comment
|-
| cc || Boolean || true,false || show cc input field
|-
| bcc || Boolean || true,false || show bcc input field
|-
| from || Boolean || true,false || show from input field
|-
| options || Boolean || true,false || show options field
|-
|}

{| id="signature objects" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''signature objects'''
! name !! type !! values !! comment
|-
| signature_name || String || name || signature name
|-
| position || String || below,above || where to show the signature in the mail text
|-
| signature_text || String || text || signature text
|-
| signature_default || Boolean || true,false || true only for the default signature
|-
|}

====Start page settings====
This table contains the possible settings for the start page.
{| id="portal object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''portal object'''
! name !! type !! values !! comment
|-
| externalcontents || Array || [[#externalcontents objects|externalcontents objects]] || array of external content objects (UWA widgeds)
|-
| minicalendar ||Boolean || true,false|| show minicalendar
|-
| internalcontents || Array || [[#internalcontens objects|internalcontents objects]] || array of internal content objects (groupware modules)
|-
| infobox || Boolean || true,false|| show infobox
|-
| tooltip ||Boolean ||true,false || show tooltip
|-
|}

{| id="externalcontents objects" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''externalcontents objects'''
! name !! type !! values !! comment
|-
| autorefresh || Boolean || true,false || enable autorefresh for the widget
|-
| title || String || name || widget title
|-
| standalone || Boolean || true,false || widget is standalone
|-
| visible || Boolean || true,false || widget is visible on the portal page
|-
| adj || Object || [[#adj object|adj object]] || position setting of the widget
|-
| url || String || url || widget url
|-
| parameter || Object || parameter object || widget parameters in an object
|-
| id || String || unique id || unique id for the widget
|-
|}

{| id="internalcontens objects" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''internalcontens objects'''
! name !! type !! values !! comment
|-
| params || Object || [[#params object|params object]] || widget parameter
|-
| header || Sting || E-Mail,Calendar,InfoStore,Tasks || header name
|-
| visible || Boolean || true,false || show module on the portal
|-
| adj || Object || [[#adj object|adj object]] || position setting of the widget
|-
| external || Boolean || false || only false is implemented
|-
| module || String || mail,calendar,infostore,tasks || internal module name
|-
|}

{| id="adj object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''adj object'''
! name !! type !! values !! comment
|-
| hw || Number || 0... || widget height relative to others, 0 for auto
|-
| ww || Number || 0... || widget width relative to others, 0 for auto
|-columns
| y || Number || 0... || vertical position on the start page in rows, 0 for auto
|-
| x || Number || 0... || horizontal position on the start page in columns, 0 for auto
|-
|}

{| id="params object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''params object'''
! name !! type !! values !! comment
|-
| limit || Number || 5,10,15,20 || number of shown items in the module
|-
|}

====global settings====
This table contains the global settings options
{| id="global object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''global object'''
|-
! name !! type !! values !! comment
|-
| confirmtimestamp ||Number || Timestamp || timestamp for the last confirmed/declined appointment
|-
| confirmpopup || Boolean || true,false|| confirmation pop-up for new appointments
|-
| save || Number || 0,1,2 || save layout on logout: 0 no, 1 yes, 2 ask
|-
| autorefresh || Number || 0,5,10,15,30 || time in minutes for GUI autorefresh, 0 for never
|-
| region || Object || [[#region object|region object]] || region settings for time and date formats
|-
| private_categories || String || tag,tag,.. || comma separated list of user defined tags
|}

{| id="region object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''region object'''
|-
! name !! type !! values !! Comment
|-
| time || Object || [[#time object|time object]] || object for time defaults
|-
| date || Object || [[#date object|date object]] || object for date defaults
|-
|}

{| id="time object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''time object'''
|-
! name !! type !! values !! Comment
|-
| predefined || Number || 0,1 || 0 user defined, 1 language depending
|-
| format || String || HH:mm,"hh:mm a" || a stands for suffix which needs to be true then, too. m is 0-59, mm is 00-59, H is 1-24, HH is 01-24, h is 1-12, hh is 01-12, a is AM/PM.
|-
| format_hour || String || "hh a",HH || a stands for suffix which needs to be true then, too. H is 1-24, HH is 01-24, h is 1-12, hh is 01-12, a is AM/PM.
|-
| format_suffix || Boolean || true,false || add suffix
|-
|}

{| id="date object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''date object'''
|-
! name !! type !! values !! Comment
|-
| format_selected_index || Number || id from [[#index|index]] || preselection for the user time format drop down
|-
| separator || String || /,.,- || date separator
|-
| predifined || Number || 0,1 || 0 user defined, 1 language depending
|-
| format || String || value from [[#index|index]] || date format
|-
|}

{| id="index" style="width:50%" cellspacing="0" border="1" align="bottom"
|+'''date index'''
|-
! id !! value
|-
| 0 || M/d/yyyy
|-
| 1 || M/d/yy
|-
| 2 || MM/dd/yy
|-
| 3 || MM/dd/yyyy
|-
| 4 || yy/MM/dd
|-
| 5 || dd/MM/yyyy
|-
| 6 || dd/MM/yy
|-
| 7 || dd.MM.yyyy
|-
| 8 || dd.MM.yy
|-
| 9 || d.MM.yy
|-
| 10 || d.M.yy
|-
| 11 || d.M.yyyy
|-
| 12 || yyyy-MM-dd
|-
| 13 || dd-MMM-yy
|-
|}

===menuiteration===
This object holds the setting of the pannel
{| id="menue object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''menue object'''
|-
! name !! type !! values !! Comment
|-
| menuiteration || Number || 1,2,3,4,5,6 || highs of the GUI pannel in rows
|-
|}

===theme settings===
This table shows the setting for the default theme
{| id="theme object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''theme object'''
|-
! name !! type !! values !! Comment
|-
| name || String || <theme name> || name of the default theme
|-
| path ||String || <theme path> || path to the default theme
|-
|}

===effects object===
the effects object holds the settings for GUI effects like hovers and fading.
{| id="effects object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''effects object'''
|-
! name !! type !! values !! Comment
|-
| global || Boolean || true,false || enable effects
|-
| hover || Object || [[#hover object|hover object]] || includes hover settings for the modules
|-
| fading|| Boolean || true,false || fading
|-
|}

{| id="hover object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''hover object'''
|-
! name !! type !! values !! Comment
|-
| speed || Number || 1,2,3 || hover delay, 1 short, 2 normal, 3 long
|-
| calendar || Boolean || true,false || hover for calendar
|-
| contacts || Boolean || true,false || hover for contacts
|-
| portal || Boolean || true,false || hovers on the portal page
|-
| infostore || Boolean || true,false || hover for infostore
|-
| mail || Boolean || true,false || hover for mail
|-
| tasks || Boolean || true,false || hover for tasks
|-
|}

===setting for tasks===
This objects holds the settings for tasks
{| id="tasks objects" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''tasks objects'''
! name !! type !! values !! Comment
|-
| interval || Number || 5,10,15,20,30,60 || interval for reminder
|-
| gridsort || String || asc || how tasks get sorted
|-
| view || String || tasks/(split,list) || task view
|-
|}

===foldertree object===
this is an internal gui object to store the folder tree on logout. This
object should not be modified.
{| id="foldertree object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''foldertree object'''
! name !! type !! values !! Comment
|-
| FolderTreeState || Object || foldertree object || folder tree state on GUI logout, you should not touch
|-
|}

===Settings for contacts===
the contacts object holds the settings for the contacts.
{| id="contacts object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''contacts object'''
! name !! type !! values !! Comment
|-
| gridsort ||String || asc || Sorting of contacts
|-
| cardsToViewPerColumn || String || auto,4,5,6,7|| displayed cards per column
|-
| view || String || contacts/(cards,phonelist) || card view
|-
|}

===settings for the calendar===
The calendar object stores the settings for the calendar.
{| id="calendar object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''calendar object'''
! name !! type !! values !! Comment
|-
| workweek ||Object || [[#workweek object|workweek object]] || settings for the workweek
|-
| endtime || Number || 0..23 || calendar display end time in hours
|-
| teams || Array || [[#teams object|teams object]] || Array of teams
|-
| allfolders ||Boolean || true,false || activate "Show all my appointments from all calendars"
|-
| starttime || Number || 0..23 || calendar display end time in hours
|-
| interval || Number || 5,10,15,20,30,60 || calendar resolution
|-
| day || Object || [[#day object|day object]] || settings for day view
|-
| view || String || calendar/(calendar,team,list)/(day,workweek,month,week,custom,) || calendar view, for team, only day and workweek possible and groupware functionality must be available, list view has no custom view
|-
| custom || Object || [[#custom object|custom object]] || setting for the custom view
|-
|}

{| id="workweek object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''workweek object'''
! name !! type !! values !! Comment
|-
| countdays || Number || 1,2,3,4,5,6,7 || Number of days in work week
|-
| numberofappointments || Number || 1,2,3,4,5,6,7,8 || Number of concurrent appointments shown in workweek view
|-
| startday || Number || 0,1,2,3,4,5,6 || 0 Sunday,...,6 Saturday
|-
|}

{| id="day object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''day object'''
! name !! type !! values !! Comment
|-
| numberofappointments || Number || 1,2,3,4,5,6,7,8 || Number of concurrent appointments shown in day view
|-
|}

{| id="custom object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''custom object'''
! name !! type !! values !! Comment
|-
| numberofappointments || Number || 1,2,3,4,5,6,7,8 || Number of concurrent appointments shown in day view
|-
| countdays || Number || 1,2,3,4,5,6,7 || Number of days in work week
|-
|}

{| id="teams object" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''teams object'''
! name !! type !! values !! Comment
|-
| team_default || Boolean || true,false || true for the default team
|-
| name || string || name || name for the team
|-
| children || Array || [[#children objects|children objects]] || Array of children objects, childrens are users that belong to the team
|-
|}

{| id="children objects" style="width:100%" cellspacing="0" border="1" align="bottom"
|+'''children object'''
! name !! type !! values !! Comment
|-
| id || Number || userid || user id of the team member
|-
| display _name || String || display name || display name of the team member
|-
| type || Number || 1 || only 1 implemented
|-
|}

===example /path, saved from a fresh user directly after the first login/logout===
/path={"calendar":{"view":"calendar/calendar/day","day":{"numberofappointments":4},"workweek":{"countdays":5,"startday":1,"numberofappointments":2},"starttime":8,"allfolders":true,"custom":{"countdays":3,"numberofappointments":3},"endtime":18,"interval":30},"FolderTreeState":{"folder_tree$1":{"folder_tree$default":{"folder_tree$default.INBOX":{}},"folder_tree$25":{}},"folder_tree$9":{"folder_tree$10":{"folder_tree$28":{}}}},"contacts":{"view":"contacts/cards","cardsToViewPerColumn":"auto","gridsort":"asc"},"theme":{"path":"default","name":"Default"},"portal":{"infobox":true,"internalcontents":[{"params":{"limit":5},"header":"E-Mail","visible":true,"adj":{"hw":1,"ww":1,"y":0,"x":1},"external":false,"module":"mail"},{"params":{"limit":5},"header":"Calendar","visible":true,"adj":{"hw":1,"ww":1,"y":0,"x":0},"external":false,"module":"calendar"},{"params":{"limit":5},"header":"InfoStore","visible":true,"adj":{"hw":1,"ww":1,"y":1,"x":0},"external":false,"module":"infostore"},{"params":{"limit":5},"header":"Tasks","visible":true,"adj":{"hw":1,"ww":1,"y":1,"x":1},"external":false,"module":"tasks"}],"tooltip":false,"externalcontents":[],"minicalendar":true},"infostore":{"view":"infostore/split"},"effects":{"hover":{"calendar":true,"speed":2,"contacts":true,"portal":true,"infostore":true,"mail":true,"tasks":true},"global":false,"fading":false},"mail":{"newmail_options":{"cc":true,"bcc":false,"from":true,"options":false},"view":"mail/hsplit/unthreaded","formatmessage":"ALTERNATIVE","notifyacknoledge":true,"autocomplete":true,"auto_save_drafts":3,"signatures":[],"fullmailheader":true,"htmlmessage":true},"tasks":{"view":"tasks/split","gridsort":"asc","interval":30},"menu":{"menuiteration":4},"private_categories":"","global":{"autorefresh":10,"save":1,"confirmtimestamp":1216928454103,"confirmpopup":true}}

for example, here is how it would work on the command line:
/opt/open-xchangen/sbin/changeuser -c 71 -i 5 --addguipreferences\
'/gui={"calendar":{"view":"calendar/calendar/day","day":{"numberofappointments":4},\
"workweek":{"countdays":5,"startday":1,"numberofappointments":2},"starttime":8,"allfolders":true,\
"custom":{"countdays":3,"numberofappointments":3},"endtime":18,"interval":30},\
"FolderTreeState":{"folder_tree$1":{"folder_tree$default":{"folder_tree$default.INBOX":{}},\
"folder_tree$25":{}},"folder_tree$9":{"folder_tree$10":{"folder_tree$28":{}}}},\
"contacts":{"view":"contacts/cards","cardsToViewPerColumn":"auto","gridsort":"asc"},\
"theme":{"path":"default","name":"Default"},\ "portal":{"infobox":true,\
"internalcontents":[{"params":{"limit":5},"header":"E-Mail","visible":true,\
"adj":{"hw":1,"ww":1,"y":0,"x":1},"external":false,"module":"mail"},\
{"params":{"limit":5},"header":"Calendar","visible":true,\
"adj":{"hw":1,"ww":1,"y":0,"x":0},\ "external":false,"module":"calendar"},\
{"params":{"limit":5},"header":"InfoStore","visible":true,\
"adj":{"hw":1,"ww":1,"y":1,"x":0},"external":false,"module":"infostore"},\
{"params":{"limit":5},"header":"Tasks","visible":true,\
"adj":{"hw":1,"ww":1,"y":1,"x":1},"external":false,"module":"tasks"}],\
"tooltip":false,"externalcontents":[],"minicalendar":true},\
"infostore":{"view":"infostore/split"},\
"effects":{"hover":{"calendar":true,"speed":2,"contacts":true,\
"portal":true,"infostore":true,"mail":true,"tasks":true},\
"global":false,"fading":false},\
"mail":{"newmail_options":{"cc":true,"bcc":false,"from":true,"options":false},\
"view":"mail/hsplit/unthreaded","formatmessage":"ALTERNATIVE",\
"notifyacknoledge":true,"autocomplete":true,"auto_save_drafts":3,\
"signatures":[],"fullmailheader":true,"htmlmessage":true},\
"tasks":{"view":"tasks/split","gridsort":"asc","interval":30},\
"menu":{"menuiteration":4},"private_categories":"",\
"global":{"autorefresh":10,"save":1,"confirmtimestamp":1216928454103,\
"confirmpopup":true}}'

[[Category: OX6]]

Open-Xchange - User contributions [en]

OX6:Gui path