https://oxpedia.org/wiki/api.php?action=feedcontributions&user=Vitali.sjablow&feedformat=atom
Open-Xchange - User contributions [en]
2024-03-29T12:00:33Z
User contributions
MediaWiki 1.31.0
https://oxpedia.org/wiki/index.php?title=AppSuite:Configuring_portal_plugins&diff=23830
AppSuite:Configuring portal plugins
2018-02-09T12:33:40Z
<p>Vitali.sjablow: </p>
<hr />
<div><!-- !!! --><br />
<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation --> <br />
<!-- !!! --><br />
<br />
{{Stability-stable}}<br />
{{VersionFrom|7.4.0}}<br />
<br />
= Configuring portal plugins =<br />
<br />
''Synopsis:'' This article covers how to configure which plugins ("tiles") are shown, whether they are mandatory or just suggested to the user.<br />
<br />
__TOC__<br />
<br />
== Configuring the portal ==<br />
<br />
When running OX AppSuite you may want to specify a starting configuration for which tiles the portal shows and whether certain tiles are mandatory or not. This is especially useful when you are introducing your own tile implementations. To make this possible, the portal consists of three types of tiles: User tiles, eager tiles and protected tiles. User tiles are tiles that the user added herself to the portal page, eager tiles are those suggested by the installation which can be removed and protected tiles are set by the backend. <br />
<br />
In order to specify a tile, you will have to know about the configuration data to enter. You can use an appsuite installation to do that. If you want to configure a tile as eager or protected, navigate to the settings area of the portal page, add the tile you want and, in the JS console, enter:<br />
<br />
require("settings!io.ox/portal").get("widgets/user")<br />
<br />
and in the list find the tile you want to suggest to or force on your users. As an example, we'll use the birthday widget:<br />
<br />
birthdays_0: Object<br />
color: "lightgreen"<br />
enabled: true<br />
id: "birthdays_0"<br />
index: 6<br />
inverse: false<br />
plugin: "plugins/portal/birthdays/register"<br />
props: Object<br />
type: "birthdays"<br />
<br />
In order to configure widgets on the backend we have to turn the above into a valid YAML structure:<br />
<br />
birthdays_0:<br />
color: "lightgreen" # one of black, red, orange, lightgreen, <br />
# green, lightblue, blue, purple, pink, gray<br />
enabled: true # Has to be true <br />
index: "first" # Where the widget is supposed to show up. <br />
# Possible values are numbers, "first" or <br />
# "last" <br />
inverse: false # If true, the color is applied to the body <br />
# of the tile and not the title. Can highlight <br />
# particular tiles<br />
plugin: "plugins/portal/birthdays/register" # The source file that contains the tile code<br />
type: "birthdays" # The id of the widget type. Not the id above <br />
# has to have the form [type]_[someNumber]<br />
<br />
Now we can use this snippet to configure the birthday widget in a variety of ways<br />
<br />
== I want to suggest a widget, but the user can remove it, if they don't like it ==<br />
<br />
For this, you can use the "eager" configuration method. Not that if you specify an eager or protected widget, all default widgets from Open-Xchange will not be configured as defaults anymore, so you might want to configure them as eager tiles as well. But let's stick to the birthday widget for now. <br />
<br />
* Add a file /opt/open-xchange/etc/settings/portal.yml<br />
<br />
io.ox/portal//widgets/eager/gen_0:<br />
birthdays_0:<br />
color: "lightgreen"<br />
enabled: true<br />
index: "first"<br />
inverse: false<br />
plugin: "plugins/portal/birthdays/register"<br />
type: "birthdays"<br />
<br />
This means the widget will be enabled for users, but users can still disable it. If you want to, at a later time and since you've made significant improvements to the tile, want to show it to the user again, you have to increase the "generation" of the widget configuration and offer it again:<br />
<br />
io.ox/portal/:<br />
generation: 1<br />
<br />
io.ox/portal//widgets/eager/gen_0:<br />
birthdays_0:<br />
color: "lightgreen"<br />
enabled: true<br />
index: "first"<br />
inverse: false<br />
plugin: "plugins/portal/birthdays/register"<br />
type: "birthdays"<br />
<br />
io.ox/portal//widgets/eager/gen_1:<br />
birthdays_0:<br />
color: "lightgreen"<br />
enabled: true<br />
index: "first"<br />
inverse: false<br />
plugin: "plugins/portal/birthdays/register"<br />
type: "birthdays"<br />
<br />
All the "gen_[number]" entries up the tie io.ox/portal//generation will be used for this configuration. If a tile is deleted it is deleted only in that generation so can be reintroduced in a later portal configuration generation. If you want to keep the default tiles as used as a fallback for App Suite, you need this configuration to start out with:<br />
<br />
io.ox/portal//widgets/eager/gen_0:<br />
mail_0: <br />
plugin: 'plugins/portal/mail/register'<br />
color: 'blue'<br />
enabled: true<br />
index: 1<br />
calendar_0: <br />
plugin: 'plugins/portal/calendar/register'<br />
color: 'red'<br />
enabled: true<br />
index: 2<br />
tasks_0: <br />
plugin: 'plugins/portal/tasks/register'<br />
color: 'green'<br />
enabled: true<br />
index: 3<br />
birthdays_0:<br />
plugin: 'plugins/portal/birthdays/register'<br />
color: 'lightgreen'<br />
enabled: true<br />
index: 4<br />
twitter_0:<br />
plugin: 'plugins/portal/twitter/register'<br />
color: 'pink'<br />
enabled: true<br />
index: 5<br />
linkedin_0:<br />
plugin: 'plugins/portal/linkedin/register'<br />
color: 'lightblue'<br />
enabled: true<br />
index: 6<br />
<br />
And then modify this as wanted for your deployment. Note, that LikedIn support was removed with version 7.10.<br />
<br />
== Forcing a tile == <br />
<br />
Similarly to the eager tiles, tiles can be "protected", i.e. they can not be moved, removed and disabled. The configuration for this looks like that:<br />
<br />
io.ox/portal//widgets/protected:<br />
birthdays_0:<br />
color: "lightgreen"<br />
enabled: true<br />
index: "first"<br />
inverse: false<br />
plugin: "plugins/portal/birthdays/register"<br />
type: "birthdays"<br />
<br />
If you want to allow movement of the widget, you can enable this in the following way:<br />
<br />
io.ox/portal//widgets/protected:<br />
birthdays_0:<br />
color: "lightgreen"<br />
enabled: true<br />
index: "first"<br />
inverse: false<br />
plugin: "plugins/portal/birthdays/register"<br />
type: "birthdays"<br />
changeable:<br />
index: true<br />
<br />
In which case, users will be allowed to move the tile. <br />
<br />
One caveat in all this: After changing any of the above configuration, you will have to reload the UI *twice*, since App Suite uses read-through caching for the settings data.<br />
<br />
== Disabling a tile completely ==<br />
The combination of making a tile both protected and disabling it makes it impossible for the user to enable it. From 7.6.0 on, this means it is not shown in the settings either. Before that, it was greyed out but still present.<br />
<br />
io.ox/portal/:<br />
widgets:<br />
protected:<br />
quota_0:<br />
color: "red"<br />
id: "quota_0"<br />
enabled: false<br />
index: 1<br />
inverse: false<br />
plugin: "plugins/portal/quota/register"<br />
type: "quota"<br />
<br />
[[Category:Backend]][[Category:AppSuite]]<br />
<br />
[[Category:Portal]]<br />
<br />
[[Category:Administrator]][[Category:Developer]]</div>
Vitali.sjablow
https://oxpedia.org/wiki/index.php?title=AppSuite:User_management&diff=22783
AppSuite:User management
2016-12-15T10:47:08Z
<p>Vitali.sjablow: /* Extended options */</p>
<hr />
<div><br />
== createuser ==<br />
<br />
'''<code>createuser</code>''' is the tool to create new users in a given context. The displayname must be unique in one context.<br />
<br />
<br />
=== Parameters ===<br />
<br />
{| border="1"<br />
|-<br />
| -h,--help<br />
|Prints a help text<br />
|-<br />
| --environment<br />
|Show infoabout commandline environment<br />
|-<br />
| --nonl<br />
|Remove all newlines (\n) from output<br />
|-<br />
| --responsetimeout &lt;integer&gt;<br />
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''<br />
|-<br />
| --extendedoptions <br />
|Set this if you want to see all options, use this instead of help option<br />
|-<br />
|csv-import &lt;CSV file&gt; <br />
| Full path to CSV file with user data to import. This option makes mandatory options obsolete, except credential options (if needed). <br />
|-<br />
| -c,--contextid &lt;integer&gt;<br />
|The id of the context<br />
|-<br />
| -u,--username &lt;string&gt;<br />
|Username of the user<br />
|-<br />
| -d,--displayname &lt;string&gt;<br />
|Display name of the user<br />
|-<br />
| -g,--givenname &lt;string&gt;<br />
|Given name for the user<br />
|-<br />
| -s,--surname &lt;string&gt;<br />
|Surname of the user<br />
|-<br />
| -p,--password &lt;string&gt;<br />
|Password for the user <br />
|-<br />
| -e,--email &lt;string&gt;<br />
|Primary mail address <br />
|-<br />
| -l,--language &lt;lang&gt;<br />
|Language for the user (de_DE,en_US,fr_FR)<br />
|-<br />
| -t,--timezone &lt;timezone&gt;<br />
|Timezone of the user (Europe/Berlin)<br />
|-<br />
| -x,--department &lt;string&gt;<br />
|Department of the user <br />
|-<br />
| -z,--company &lt;string&gt;<br />
|Company of the user <br />
|-<br />
| -a,--aliases &lt;string&gt;<br />
|E-Mail aliases of the user, separated by ","<br />
|-<br />
| --access-combination-name &lt;access-combination-name&gt;<br />
|Access combination name<br />
|-<br />
| --addguipreferences &lt;addguipreferences&gt;<br />
|Add a GUI setting (key=value)<br />
|}<br />
For the GUI preferences please also see [http://oxpedia.org/wiki/index.php?title=Gui_path]<br />
<br />
<br />
==== --csv-import <CSV file> ====<br />
<br />
Full path to CSV file with user data to<br />
import. This option makes mandatory command line options obsolete, except credential options (if needed). But they have to be set in the CSV file.<br />
<br />
<br />
With this option you can specify a csv file<br />
(a full pathname must be given) with the data which should be imported. The columnnames in the CSV file must be the same as the long-options of the command line tools, without the prefix<br />
"--".<br />
<br />
<br />
This option will normally be used to fill new large installations with the new data. So instead of calling the command line tools in a shell script every time, just a csv file needs to<br />
be created, containing the whole data.<br />
<br />
<br />
Note that the credentials of the masteradmin in the createcontext call must be given on the command line with the -A and -P options nevertheless - if<br />
authentication is enabled. If the createuser command line tool is used, the credentials are part of the csv file, and cannot be set as options on the command line itself. The reason for this<br />
different behavior is that different contexts have different credentials for the admin user, so they must be set in every line of the csv file. Opposed to this the credentials of the masteradmin<br />
are always the same.<br />
<br />
=== Extended options ===<br />
<br />
{| border="1"<br />
|-<br />
| --email1 &lt;string&gt;<br />
|Email1<br />
|-<br />
| --birthday &lt;datevalue&gt;<br />
|Birthday<br />
|-<br />
| --anniversary &lt;datevalue&gt;<br />
|Anniversary<br />
|-<br />
| --branches &lt;string&gt;<br />
|Branches<br />
|-<br />
| --business_category &lt;string&gt;<br />
|Business_category<br />
|-<br />
| --postal_code_business &lt;string&gt;<br />
|Postal_code_business<br />
|-<br />
| --state_business &lt;string&gt;<br />
|State_business<br />
|-<br />
| --street_business &lt;string&gt;<br />
|Street_business<br />
|-<br />
| --telephone_callback &lt;string&gt;<br />
|Telephone_callback<br />
|-<br />
| --city_home &lt;string&gt;<br />
|City_home<br />
|-<br />
| --commercial_register &lt;string&gt;<br />
|Commercial_register<br />
|-<br />
| --country_home &lt;string&gt;<br />
|Country_home<br />
|-<br />
| --email2 &lt;string&gt;<br />
|Email2<br />
|-<br />
| --email3 &lt;string&gt;<br />
|Email3<br />
|-<br />
| --employeetype &lt;string&gt;<br />
|EmployeeType<br />
|-<br />
| --fax_business &lt;string&gt;<br />
|Fax_business<br />
|-<br />
| --fax_home &lt;string&gt;<br />
|Fax_home<br />
|-<br />
| --fax_other &lt;string&gt;<br />
|Fax_other<br />
|-<br />
| --imapserver &lt;string&gt;<br />
|ImapServer<br />
|-<br />
| --imaplogin &lt;string&gt;<br />
|ImapLogin<br />
|-<br />
| --smtpserver &lt;string&gt;<br />
|SmtpServer<br />
|-<br />
| --instant_messenger1 &lt;string&gt;<br />
|Instant_messenger1<br />
|-<br />
| --instant_messenger2 &lt;string&gt;<br />
|Instant_messenger2<br />
|-<br />
| --telephone_ip &lt;string&gt;<br />
|Telephone_ip<br />
|-<br />
| --telephone_isdn &lt;string&gt;<br />
|Telephone_isdn<br />
|-<br />
| --mail_folder_drafts_name &lt;string&gt;<br />
|Mail_folder_drafts_name<br />
|-<br />
| --mail_folder_sent_name &lt;string&gt;<br />
|Mail_folder_sent_name<br />
|-<br />
| --mail_folder_spam_name &lt;string&gt;<br />
|Mail_folder_spam_name<br />
|-<br />
| --mail_folder_trash_name &lt;string&gt;<br />
|Mail_folder_trash_name<br />
|-<br />
| --mail_folder_archive_full_name &lt;string&gt;<br />
|Mail_folder_archive_full_name<br />
|-<br />
| --manager_name &lt;string&gt;<br />
|Manager_name<br />
|-<br />
| --marital_status &lt;string&gt;<br />
|Marital_status<br />
|-<br />
| --cellular_telephone1 &lt;string&gt;<br />
|Cellular_telephone1<br />
|-<br />
| --cellular_telephone2 &lt;string&gt;<br />
|Cellular_telephone2<br />
|-<br />
| --info &lt;string&gt;<br />
|Info<br />
|-<br />
| --nickname &lt;string&gt;<br />
|Nickname<br />
|-<br />
| --number_of_children &lt;string&gt;<br />
|Number_of_children<br />
|-<br />
| --note &lt;string&gt;<br />
|Note<br />
|-<br />
| --number_of_employee &lt;string&gt;<br />
|Number_of_employee<br />
|-<br />
| --telephone_pager &lt;string&gt;<br />
|Telephone_pager<br />
|-<br />
| --password_expired &lt;booleanvalue&gt;<br />
|Password_expired<br />
|-<br />
| --telephone_assistant &lt;string&gt;<br />
|Telephone_assistant<br />
|-<br />
| --telephone_business1 &lt;string&gt;<br />
|Telephone_business1<br />
|-<br />
| --telephone_business2 &lt;string&gt;<br />
|Telephone_business2<br />
|-<br />
| --telephone_car &lt;string&gt;<br />
|Telephone_car<br />
|-<br />
| --telephone_company &lt;string&gt;<br />
|Telephone_company<br />
|-<br />
| --telephone_home1 &lt;string&gt;<br />
|Telephone_home1<br />
|-<br />
| --telephone_home2 &lt;string&gt;<br />
|Telephone_home2<br />
|-<br />
| --telephone_other &lt;string&gt;<br />
|Telephone_other<br />
|-<br />
| --postal_code_home &lt;string&gt;<br />
|Postal_code_home<br />
|-<br />
| --profession &lt;string&gt;<br />
|Profession<br />
|-<br />
| --telephone_radio &lt;string&gt;<br />
|Telephone_radio<br />
|-<br />
| --room_number &lt;string&gt;<br />
|Room_number<br />
|-<br />
| --sales_volume &lt;string&gt;<br />
|Sales_volume<br />
|-<br />
| --city_other &lt;string&gt;<br />
|City_other<br />
|-<br />
| --country_other &lt;string&gt;<br />
|Country_other<br />
|-<br />
| --middle_name &lt;string&gt;<br />
|Middle_name<br />
|-<br />
| --postal_code_other &lt;string&gt;<br />
|Postal_code_other<br />
|-<br />
| --state_other &lt;string&gt;<br />
|State_other<br />
|-<br />
| --street_other &lt;string&gt;<br />
|Street_other<br />
|-<br />
| --spouse_name &lt;string&gt;<br />
|Spouse_name<br />
|-<br />
| --state_home &lt;string&gt;<br />
|State_home<br />
|-<br />
| --street_home &lt;string&gt;<br />
|Street_home<br />
|-<br />
| --suffix &lt;string&gt;<br />
|Suffix<br />
|-<br />
| --tax_id &lt;string&gt;<br />
|Tax_id<br />
|-<br />
| --telephone_telex &lt;string&gt;<br />
|Telephone_telex<br />
|-<br />
| --telephone_ttytdd &lt;string&gt;<br />
|Telephone_ttytdd<br />
|-<br />
| --uploadFileSizeLimitPerFile &lt;string&gt;<br />
|uploadFileSizeLimitPerFile<br />
|-<br />
| --uploadFileSizeLimit &lt;string&gt;<br />
|uploadFileSizeLimit<br />
|-<br />
| --url &lt;string&gt;<br />
|Url<br />
|-<br />
| --userfield01 &lt;string&gt;<br />
|Userfield01<br />
|-<br />
| --userfield02 &lt;string&gt;<br />
|Userfield02<br />
|-<br />
| --userfield03 &lt;string&gt;<br />
|Userfield03<br />
|-<br />
| --userfield04 &lt;string&gt;<br />
|Userfield04<br />
|-<br />
| --userfield05 &lt;string&gt;<br />
|Userfield05<br />
|-<br />
| --userfield06 &lt;string&gt;<br />
|Userfield06<br />
|-<br />
| --userfield07 &lt;string&gt;<br />
|Userfield07<br />
|-<br />
| --userfield08 &lt;string&gt;<br />
|Userfield08<br />
|-<br />
| --userfield09 &lt;string&gt;<br />
|Userfield09<br />
|-<br />
| --userfield10 &lt;string&gt;<br />
|Userfield10<br />
|-<br />
| --userfield11 &lt;string&gt;<br />
|Userfield11<br />
|-<br />
| --userfield12 &lt;string&gt;<br />
|Userfield12<br />
|-<br />
| --userfield13 &lt;string&gt;<br />
|Userfield13<br />
|-<br />
| --userfield14 &lt;string&gt;<br />
|Userfield14<br />
|-<br />
| --userfield15 &lt;string&gt;<br />
|Userfield15<br />
|-<br />
| --userfield16 &lt;string&gt;<br />
|Userfield16<br />
|-<br />
| --userfield17 &lt;string&gt;<br />
|Userfield17<br />
|-<br />
| --userfield18 &lt;string&gt;<br />
|Userfield18<br />
|-<br />
| --userfield19 &lt;string&gt;<br />
|Userfield19<br />
|-<br />
| --userfield20 &lt;string&gt;<br />
|Userfield20<br />
|-<br />
| --city_business &lt;string&gt;<br />
|City_business<br />
|-<br />
| --country_business &lt;string&gt;<br />
|Country_business<br />
|-<br />
| --assistant_name &lt;string&gt;<br />
|Assistant_name<br />
|-<br />
| --telephone_primary &lt;string&gt;<br />
|Telephone_primary<br />
|-<br />
| --categories &lt;string&gt;<br />
|Categories<br />
|-<br />
| --mail_folder_confirmed_ham_name &lt;string&gt;<br />
|Mail_folder_confirmed_ham_name<br />
|-<br />
| --mail_folder_confirmed_spam_name &lt;string&gt;<br />
|Mail_folder_confirmed_spam_name<br />
|-<br />
| --gui_spam_filter_capabilities_enabled &lt;booleanvalue&gt;<br />
|GUI_spam_filter_capabilities_enabled<br />
|-<br />
| --mailenabled &lt;true/false&gt;<br />
|Mailenabled<br />
|-<br />
| --defaultsenderaddress &lt;stringvalue&gt;<br />
|DefaultSenderAddress<br />
|-<br />
| --title &lt;string&gt;<br />
|Title<br />
|-<br />
| --position &lt;string&gt;<br />
|Position<br />
|-<br />
| --access-calendar &lt;on/off&gt;<br />
|Calendar module (Default is off)<br />
|-<br />
| --access-contacts &lt;on/off&gt;<br />
|Contact module access (Default is on)<br />
|-<br />
| --access-delegate-tasks &lt;on/off&gt;<br />
|Delegate tasks access (Default is off)<br />
|-<br />
| --access-edit-public-folder &lt;on/off&gt;<br />
|Edit public folder access (Default is off)<br />
|-<br />
| --access-ical &lt;on/off&gt;<br />
|Ical module access (Default is off)<br />
|-<br />
| --access-infostore &lt;on/off&gt;<br />
|Infostore module access (Default is off)<br />
|-<br />
| --access-read-create-shared-Folders &lt;on/off&gt;<br />
|Read create shared folder access (Default is off)<br />
|-<br />
| --access-syncml &lt;on/off&gt;<br />
|Syncml access (Default is off)<br />
|-<br />
| --access-active-sync &lt;on/off&gt;<br />
|Exchange Active Sync access (Default is off)<br />
|-<br />
| --access-usm &lt;on/off&gt;<br />
|Universal Sync Module access (Default is off)<br />
|-<br />
| --access-tasks &lt;on/off&gt;<br />
|Tasks access (Default is off)<br />
|-<br />
| --access-vcard &lt;on/off&gt;<br />
|Vcard access (Default is off)<br />
|-<br />
| --access-webdav &lt;on/off&gt;<br />
|Webdav access (Default is off)<br />
|-<br />
| --access-webdav-xml &lt;on/off&gt;<br />
|Webdav-Xml access (Default is off)<br />
|-<br />
|<br />
--access-webmail &lt;on/off&gt;<br />
|Webmail access (Default is on)<br />
|-<br />
| --access-publication &lt;on/off&gt;<br />
|Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium<br />
|-<br />
| --access-subscription &lt;on/off&gt;<br />
|Subscription permission (Default is on)<br />
|-<br />
| --access-edit-group &lt;on/off&gt;<br />
|Edit group access (Default is off)<br />
|-<br />
| --access-edit-resource &lt;on/off&gt;<br />
|Edit resource access (Default is off)<br />
|-<br />
| --access-edit-password &lt;on/off&gt;<br />
|Edit password access (Default is off)<br />
|-<br />
| --access-collect-email-addresses &lt;on/off&gt;<br />
|Edit collect email addresses (Default is off)<br />
|-<br />
| --access-multiple-mail-accounts &lt;on/off&gt;<br />
|Use multiple mail account feature (Default is off)<br />
|-<br />
| --access-global-address-book-disabled &lt;on/off&gt;<br />
|Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder. <br />
|-<br />
| --access--voipnow &lt;on/off&gt;<br />
|Access to VoiceOverIP feature.<br />
|-<br />
| --access-public-folder-editable &lt;on/off&gt;<br />
|Access to public folders. Allows or denies to see public folders. <br />
|-<br />
| --foldertree &lt;0/1&gt;<br />
|0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree.<br />
|-<br />
| --access-olox20 &lt;on/off&gt;<br />
| Access to Olox2.0<br />
|-<br />
| --default-folder-mode<br />
| The mode how the default folders should be created. 'default', 'default-deletable', 'no-default-folders'. If not selected, 'default' is applied.<br />
|}<br />
<br />
=== Open-Xchange module access ===<br />
<br />
With Open-Xchange it is<br />
possible to limit the access to the available modules per context i. e., all users in one context per default get the same access rights. The rights though can be changed per user. Currently,<br />
following modules are implemented: access-calendar, access-contacts, access-delegate-tasks, access-edit-public-folder, access-ical, access-infostore, access-read-create-shared-Folders,<br />
access-tasks, access-vcard, access-webdav, access-webdav-xml, access-syncml and access-webmail. There are several combinations possible and four are supported (not mentioned modules need to be<br />
disabled). This limitation is needed because some modules depend on access to others. There are different Open-Xchange packages available for the customer: Webmail+, PIM+, Groupware+, Premium.<br />
These packages have to be configured per context i. e., all users in a context need to use the same package. Each package consists of a combination of modules that has to be set up appropriately.<br />
The following sections quickly introduce the packages and their module configuration. Open-Xchange also provides the possibility to use "access combination names" when creating and changing<br />
contexts/users. If you want to change the package acess rights for a context, you can simply add the "access-combination-name" switch to the appropriate tool<br />
(createcontext,createuser,changecontext etc.).<br />
<br />
<br />
==== Webmail+ ====<br />
<br />
If there are no access rights specified when creating a new user Webmail+ is used as default. Webmail+ is a base package that allows access to the<br />
webmail interface and a personal address book. To grant access to this package, the following modules have to be set to "on" for all users in a context:<br />
<br />
<br />
{| border="1"<br />
|-<br />
|access-contacts<br />
|Access combination name: webmail_plus<br />
|-<br />
|access-webmail<br />
|Access combinationname: webmail_plus<br />
|}<br />
<br />
==== PIM+ ====<br />
<br />
PIM+<br />
is another base package that gives access to the webmailer, personal address book, calendar and tasks. Group appointments and delegating tasks are not supported. To grant access to this package,<br />
the following modules have to be set to "on" for all users in a context:<br />
<br />
<br />
{| border="1"<br />
|-<br />
|access-contacts<br />
|Access combination name: pim_plus<br />
|-<br />
|access-webmail<br />
|Access combination name: pim_plus<br />
|-<br />
|access-calendar<br />
|Access combination name: pim_plus<br />
|-<br />
|access-delegate-tasks<br />
|Access combination name: pim_plus<br />
|-<br />
|access-tasks<br />
|Access combination name: pim_plus<br />
|}<br />
<br />
==== Groupware+ ====<br />
<br />
Groupware+ is an upsell package that provides full groupware functionality: private, shared and public folders, conflict handling for appointments, team view. Furthermore, the InfoStore is<br />
available. To grant access to this package, the following modules have to be set to "on" for all users in a context:<br />
<br />
<br />
{| border="1"<br />
|-<br />
|access-contacts<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-webmail<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-calendar<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-delegate-tasks<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-tasks<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-edit-public-folder<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-infostore<br />
|Access combination name: groupware_plus<br />
|-<br />
|access-read-create-shared-Folders<br />
|Access combination name: groupware_plus<br />
|}<br />
<br />
==== Premium ====<br />
<br />
Premium is a desktop integration package. It provides the functionality of the "Groupware+" package and comes with interfaces to integrate with other software: The OXtender for MS Outlook and the<br />
WebDAV interface to integrate the InfoStore with desktops. To grant access to this package, the following modules have to be set to "on" for all users in a context:<br />
<br />
<br />
{| border="1"<br />
|-<br />
|access-contacts<br />
|Access combination name: premium<br />
|-<br />
|access-webmail<br />
|Access combination name: premium<br />
|-<br />
|access-calendar<br />
|Access combination name: premium<br />
|-<br />
|access-delegate-tasks<br />
|Access combination name: premium<br />
|-<br />
|access-tasks<br />
|Access combination name: premium<br />
|-<br />
|access-edit-public-folder<br />
|Access combination name: premium<br />
|-<br />
|access-infostore<br />
|Access combination name: premium<br />
|-<br />
|access-read-create-shared-Folders<br />
|Access combination name: premium<br />
|-<br />
|access-ical<br />
|Access combination name: premium<br />
|-<br />
|access-vcard<br />
|Access combination name: premium<br />
|-<br />
|access-webdav<br />
|Access combination name: premium<br />
|-<br />
|access-webdavxml<br />
|Access combination name: premium<br />
|}<br />
<br />
==== All ====<br />
The setting <code>all</code> is equivalent to <code>premium</code> for ordinary users. For context administrators, it adds the right <code>publicfoldereditable</code>, which allows the admin to change the access rights to public folders for groups.<br />
<br />
==== Package access configuration ====<br />
<br />
This section provides a quick overview about the different packages that can be configured per context and the<br />
required access configuration:<br />
<br />
<br />
{| border="1"<br />
|-<br />
|Module<br />
|Webmail+<br />
|PIM+<br />
|Groupware+<br />
|Premium<br />
|-<br />
| -access-calendar<br />
|off<br />
|on<br />
|on<br />
|on<br />
|-<br />
| -access-contacts<br />
|on<br />
|on<br />
|on<br />
|on<br />
|-<br />
| -access-delegate-tasks<br />
|off<br />
|on<br />
|on<br />
|on<br />
|-<br />
| -access-edit-public-folder<br />
|off<br />
|off<br />
|on<br />
|on<br />
|-<br />
| -access-ical<br />
|off<br />
|off<br />
|off<br />
|on<br />
|-<br />
| -access-infostore<br />
|off<br />
|off<br />
|on<br />
|on<br />
|-<br />
| -access-read-create-shared-Folders<br />
|off<br />
|off<br />
|on<br />
|on<br />
|-<br />
| -access-syncml<br />
|off<br />
|off<br />
|off<br />
|off<br />
|-<br />
|–access-tasks<br />
|off<br />
|on<br />
|on<br />
|on<br />
|-<br />
| -access-vcard<br />
|off<br />
|off<br />
|off<br />
|on<br />
|-<br />
| -access-webdav<br />
|off<br />
|off<br />
|off<br />
|on<br />
|-<br />
| -access-webdav-xml<br />
|off<br />
|off<br />
|off<br />
|on<br />
|-<br />
| -access-webmail<br />
|on<br />
|on<br />
|on<br />
|on<br />
|}<br />
<br />
=== Extra parameters when authentication is enabled ===<br />
<br />
{| border="1"<br />
|-<br />
| -A,--adminuser &lt;string&gt;<br />
|Context admin user name<br />
|-<br />
| -P,--adminpass &lt;string&gt;<br />
|Context admin password<br />
|}<br />
<br />
=== Return value ===<br />
<br />
<code>0</code> on success<br />
<br />
<code>&gt;0</code> on failure<br />
<br />
<br />
=== Mandatory parameters ===<br />
<br />
<code>contextid {adminuser adminpass} username displayname givenname surname password email</code><br />
<br />
=== Command output ===<br />
<br />
On success:<br />
<br />
<code>user &lt;userid&gt; in context &lt;contextid&gt; created</code><br />
<br />
On failure:<br />
<br />
<code>user in context &lt;contextid&gt; could not be created: &lt;reason from server&gt;</code><br />
<br />
<br />
=== Example ===<br />
<br />
<code>root@oxhe~# </code>'''<code>/opt/open-xchange/sbin/createuser -c 123 -u jd -d "john doe"<br />
-g John -s Doe -p userpw -e jd@example.com</code>'''<br />
<br />
<br />
<code>user 3 in context 123 created</code><br />
<br />
<br />
== deleteuser ==<br />
<br />
'''<code>deleteuser</code>''' is the tool to delete a user in a given context. If you delete a user the public folder entries of this user are<br />
transferred to the admin user. All other data are deleted.<br />
<br />
<br />
=== Parameters ===<br />
<br />
{| border="1"<br />
|-<br />
| -h,--help<br />
|Prints a help text<br />
|-<br />
| --environment<br />
|Show info about commandline environment<br />
|-<br />
| --nonl<br />
|Remove all newlines (\n) from output<br />
|-<br />
| --responsetimeout &lt;integer&gt;<br />
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''<br />
|-<br />
| -c,--contextid &lt;integer&gt;<br />
|The id of them context<br />
|-<br />
| -i,--userid &lt;integer&gt;<br />
|Id of the user<br />
|-<br />
| -u,--username &lt;string&gt;<br />
|Username ofthe user<br />
|}<br />
<br />
=== Extra parameters when authentication is enabled ===<br />
<br />
{| border="1"<br />
|-<br />
| -A,--adminuser &lt;string&gt;<br />
|Context Admin user name<br />
|-<br />
| -P,--adminpass &lt;string&gt;<br />
|Context Admin password<br />
|}<br />
<br />
=== Return value ===<br />
<br />
<code>0</code> on success<br />
<br />
<code>&gt;0</code> on failure<br />
<br />
<br />
=== Mandatory parameters ===<br />
<code>contextid {adminuser adminpass} (userid or username)</code><br />
<br />
=== Command output ===<br />
<br />
On success:<br />
<br />
<code>user &lt;userid&gt; in context &lt;contextid&gt; deleted</code><br />
<br />
<br />
On failure:<br />
<br />
<code>user &lt;userid&gt; in context &lt;contextid&gt; could not be deleted: &lt;reason from<br />
server&gt;</code><br />
<br />
<br />
=== Example ===<br />
<br />
<code>root@oxhe~# </code>'''<code> /opt/open-xchange/deleteuser -c 123 -i 3</code>'''<br />
<br />
<code>user 3 in context 123 deleted</code><br />
<br />
<br />
== listuser ==<br />
<br />
'''<code>listuser</code>''' is the tool to list and search for users.<br />
<br />
<br />
=== Parameters ===<br />
<br />
{| border="1"<br />
|-<br />
| -h,--help<br />
|Prints a help text<br />
|-<br />
| --environment<br />
|Show info about commandline environment<br />
|-<br />
| --nonl<br />
|Remove all newlines (\n) from output<br />
|-<br />
| --responsetimeout &lt;integer&gt;<br />
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''<br />
|-<br />
| -c,--contextid &lt;integer&gt;<br />
|The id of the context<br />
|-<br />
| -s,--searchpattern &lt;string&gt;<br />
|Search/List pattern, default “*”<br />
|-<br />
| --csv<br />
|Command output as csv<br />
|-<br />
| -i,--ignorecase <br />
|Do a case-insensitive search with the given search pattern<br />
|-<br />
| --includeguests<br />
|Add guest users to listing '''Available with v7.8.0'''<br />
|-<br />
| --excludeusers<br />
|Exclude usual users from listing '''Available with v7.8.0'''<br />
|}<br />
<br />
=== Extra parameters when authentication is enabled ===<br />
<br />
{| border="1"<br />
|-<br />
| -A,--adminuser &lt;string&gt;<br />
|Context Admin user name<br />
|-<br />
| -P,--adminpass &lt;string&gt;<br />
|Context Admin password<br />
|}<br />
<br />
=== Return value ===<br />
<br />
<code>0</code> on success<br />
<br />
<code>&gt;0</code> on failure<br />
<br />
=== Mandatory parameters ===<br />
<code>contextid adminuser adminpass</code><br />
<br />
=== Command output ===<br />
<br />
Standard output (only a subset of available attributes are printed also only disabled<br />
modules):<br />
<br />
<br />
{| border="1"<br />
|-<br />
|id<br />
|enabled<br />
|imapServer<br />
|smtpserver<br />
|language<br />
|Webdav<br />
|WebdavXml<br />
|-<br />
|3<br />
|true<br />
|localhost<br />
|localhost<br />
|en_US<br />
|false<br />
|false<br />
|}<br />
<br />
csv output: <br />
Name,Language,Id,Display_name,PrimaryEmail,MaxQuota,UsedQuota,Email1,Mailenabled,Password,Sur_name,Given_name,<br />
FilestoreId,FilestoreOwner,Filestore_name,Birthday,Anniversary,Branches,Business_category,Postal_code_business,<br />
State_business,Street_business,Telephone_callback,City_home,Commercial_register,Country_home,Company,Department,<br />
Email2,Email3,EmployeeType,Fax_business,Fax_home,Fax_other,ImapServer,ImapLogin,SmtpServer,Instant_messenger1,<br />
Instant_messenger2,Telephone_ip,Telephone_isdn,Mail_folder_drafts_name,Mail_folder_sent_name,<br />
Mail_folder_spam_name,Mail_folder_trash_name,Mail_folder_archive_full_name,Manager_name,Marital_status,Cellular_telephone1,Cellular_telephone2,<br />
Info,Nickname,Number_of_children,Note,Number_of_employee,Telephone_pager,Password_expired,Telephone_assistant,<br />
Telephone_business1,Telephone_business2,Telephone_car,Telephone_company,Telephone_home1,Telephone_home2,<br />
Telephone_other,Position,Postal_code_home,Profession,Telephone_radio,Room_number,Sales_volume,City_other,<br />
Country_other,Middle_name,Postal_code_other,State_other,Street_other,Spouse_name,State_home,Street_home,Suffix,<br />
Tax_id,Telephone_telex,Timezone,Title,Telephone_ttytdd,UploadFileSizeLimit,UploadFileSizeLimitPerFile,Url,<br />
Userfield01,Userfield02,Userfield03,Userfield04,Userfield05,Userfield06,Userfield07,Userfield08,Userfield09,<br />
Userfield10,Userfield11,Userfield12,Userfield13,Userfield14,Userfield15,Userfield16,Userfield17,Userfield18,<br />
Userfield19,Userfield20,Aliases,City_business,Country_business,Assistant_name,Telephone_primary,Categories,<br />
PasswordMech,Mail_folder_confirmed_ham_name,Mail_folder_confirmed_spam_name,GUI_Spam_filter_capabilities_enabled,<br />
DefaultSenderAddress,FolderTree,UserAttributes,GuiPreferences,access-calendar,access-contacts,<br />
access-delegate-tasks,access-edit-public-folder,access-ical,access-infostore,<br />
access-read-create-shared-Folders,access-syncml,access-tasks,access-vcard,access-webdav,access-webdav-xml,<br />
access-webmail,access-edit-group,access-edit-resource,access-edit-password,access-collect-email-addresses,<br />
access-multiple-mail-accounts,access-subscription,access-publication,access-active-sync,access-usm,<br />
access-olox20,access-denied-portal,access-global-address-book-disabled,access-public-folder-editable<br />
<br />
=== Example ===<br />
<br />
<pre> root@oxhe:~# /opt/open-xchange/sbin/listuser -c 6 Id Name Displayname Email 2 admin admin admin@example.com 3 holger Holger<br />
holger@example.com <br />
</pre><br />
<br />
<br />
== getusercapabilities ==<br />
<br />
'''<code>getusercapabilities</code>''' is the tool to list available capabilities for a certain user.<br />
<br />
<br />
=== Parameters ===<br />
<br />
{| border="1"<br />
|-<br />
| -h,--help<br />
|Prints a help text<br />
|-<br />
| --environment<br />
|Show info about commandline environment<br />
|-<br />
| --nonl<br />
|Remove all newlines (\n) from output<br />
|-<br />
| --responsetimeout &lt;integer&gt;<br />
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''<br />
|-<br />
| -c,--contextid &lt;integer&gt;<br />
|The id of the context<br />
|-<br />
| -i,--userid &lt;userid&gt;<br />
|Id of the user<br />
|-<br />
| -u,--username &lt;username&gt;<br />
|Username of the user<br />
|}<br />
<br />
=== Extra parameters when authentication is enabled ===<br />
<br />
{| border="1"<br />
|-<br />
| -A,--adminuser &lt;string&gt;<br />
|Context Admin user name<br />
|-<br />
| -P,--adminpass &lt;string&gt;<br />
|Context Admin password<br />
|}<br />
<br />
=== Return value ===<br />
<br />
<code>0</code> on success<br />
<br />
<code>&gt;0</code> on failure<br />
<br />
=== Mandatory parameters ===<br />
<code>contextid userid adminuser adminpass</code><br />
<br />
=== Command output ===<br />
<br />
Either "There are no capabilities set for user &lt;user-id&gt; in context &lt;context-id&gt;"<br />
or a line-wise listing of identifiers for available capabilities<br />
<br />
=== Example ===<br />
<br />
<pre> root@oxhe:~# /opt/open-xchange/sbin/getusercapabilities -c 6 -i 345<br />
</pre><br />
<br />
== changeuser ==<br />
<br />
The '''<code>changeuser</code>''' tool allows to modify attributes of an existing user in a given context. The displayname must be unique in<br />
one context.<br />
<br />
<br />
=== Parameters ===<br />
<br />
{| border="1"<br />
|-<br />
| -h,--help<br />
|Prints a help text<br />
|-<br />
| --environment<br />
|Show info about commandline environment<br />
|-<br />
| --nonl<br />
|Remove all newlines (\n) from output<br />
|-<br />
| --responsetimeout &lt;integer&gt;<br />
|response timeout in seconds for reading response from the backend (default 0s; infinite) '''Available with v7.8.0'''<br />
|-<br />
| --extendedoptions <br />
|Set this if you want to see all options, use this instead of help option<br />
|-<br />
| -c,--contextid &lt;integer&gt;<br />
|The id of the context<br />
|-<br />
| -i,--userid &lt;integer&gt;<br />
|Id of the user<br />
|-<br />
| -u,--username &lt;string&gt;<br />
|Username of the user <br />
|-<br />
| -d,--displayname &lt;string&gt;<br />
|Display name of the user <br />
|-<br />
| -g,--givenname &lt;string&gt;<br />
|Given name for the user <br />
|-<br />
| -s,--surname &lt;string&gt;<br />
|Surname of the user<br />
|-<br />
| -p,--password &lt;string&gt;<br />
|Password for the user <br />
|-<br />
| -e,--email &lt;string&gt;<br />
|Primary mail address <br />
|-<br />
| -l,--language &lt;lang&gt;<br />
|Language for the user (de_DE,en_US, fr_FR)<br />
|-<br />
| -t,--timezone &lt;timezone&gt;<br />
|Timezone of the user (Europe/Berlin)<br />
|-<br />
| -x,--department &lt;string&gt;<br />
|Department of the user<br />
|-<br />
| -z,--company &lt;string&gt;<br />
|Company of the user <br />
|-<br />
| -a,--aliases &lt;string&gt;<br />
|E-Mail aliases of the user, separated by ","<br />
|-<br />
| --access-combination-name &lt;access-combination-name&gt;<br />
|Access combination name <br />
|-<br />
| --addguipreferences &lt;addguipreferences&gt;<br />
|Add a GUI setting (key=value)<br />
|-<br />
| --removeguipreferences &lt;removeguipreferences&gt;<br />
|Remove a GUI setting <br />
|-<br />
| --access-denied-portal &lt;on/off&gt;<br />
|Denies portal access (Default is off)<br />
|-<br />
| --capabilities-to-add &lt;capabilities-to-add&gt;<br />
| The capabilities to add as a comma-separated string (from 7.2.0 on)<br />
|-<br />
| --capabilities-to-remove &lt;capabilities-to-remove&gt;<br />
|The capabilities to remove as a comma-separated string (from 7.2.0 on)<br />
|-<br />
| --capabilities-to-drop &lt;capabilities-to-drop&gt;<br />
|The capabilities to drop; e.g. cleanse from storage; as a comma-separated string (from 7.6.0 on)<br />
|}<br />
For the GUI preferences please also see http://www.open-xchange.com/wiki/index.php?title=Gui_path<br />
<br />
=== Extended options ===<br />
<br />
{| border="1"<br />
|-<br />
| --email1 &lt;string&gt;<br />
|Email1<br />
|-<br />
| --mailenabled &lt;booleanvalue &gt;<br />
|Mailenabled<br />
|-<br />
| --birthday &lt;datevalue&gt;<br />
|Birthday<br />
|-<br />
| --anniversary &lt;datevalue&gt;<br />
|Anniversary<br />
|-<br />
| --branches &lt;string&gt;<br />
|Branches<br />
|-<br />
| --business_category &lt;string&gt;<br />
|Business_category<br />
|-<br />
| --postal_code_business &lt;string&gt;<br />
|Postal_code_business<br />
|-<br />
| --state_business &lt;string&gt;<br />
|State_business<br />
|-<br />
| --street_business &lt;string&gt;<br />
|Street_business<br />
|-<br />
| --telephone_callback &lt;string&gt;<br />
|Telephone_callback<br />
|-<br />
| --city_home &lt;string&gt;<br />
|City_home<br />
|-<br />
| --commercial_register &lt;string&gt;<br />
|Commercial_register<br />
|-<br />
| --country_home &lt;string&gt;<br />
|Country_home<br />
|-<br />
| --email2 &lt;string&gt;<br />
|Email2<br />
|-<br />
| --email3 &lt;string&gt;<br />
|Email3<br />
|-<br />
| --employeetype &lt;string&gt;<br />
|EmployeeType<br />
|-<br />
| --fax_business &lt;string&gt;<br />
|Fax_business<br />
|-<br />
| --fax_home &lt;string&gt;<br />
|Fax_home<br />
|-<br />
| --fax_other &lt;string&gt;<br />
|Fax_other<br />
|-<br />
| --imapserver &lt;string&gt;<br />
|ImapServer<br />
|-<br />
| --imaplogin &lt;string&gt;<br />
|ImapLogin<br />
|-<br />
| --smtpserver &lt;string&gt;<br />
|SmtpServer<br />
|-<br />
| --instant_messenger1 &lt;string&gt;<br />
|Instant_messenger1<br />
|-<br />
| --instant_messenger2 &lt;string&gt;<br />
|Instant_messenger2<br />
|-<br />
| --telephone_ip &lt;string&gt;<br />
|Telephone_ip<br />
|-<br />
| --telephone_isdn &lt;string&gt;<br />
|Telephone_isdn<br />
|-<br />
| --mail_folder_drafts_name &lt;string&gt;<br />
|Mail_folder_drafts_name<br />
|-<br />
| --mail_folder_sent_name &lt;string&gt;<br />
|Mail_folder_sent_name<br />
|-<br />
| --mail_folder_spam_name &lt;string&gt;<br />
|Mail_folder_spam_name<br />
|-<br />
| --mail_folder_trash_name &lt;string&gt;<br />
|Mail_folder_trash_name<br />
|-<br />
| --mail_folder_archive_full_name &lt;string&gt;<br />
|Mail_folder_archive_full_name<br />
|-<br />
| --manager_name &lt;string&gt;<br />
|Manager_name<br />
|-<br />
| --marital_status &lt;string&gt;<br />
|Marital_status<br />
|-<br />
| --cellular_telephone1 &lt;string&gt;<br />
|Cellular_telephone1<br />
|-<br />
| --cellular_telephone2 &lt;string&gt;<br />
|Cellular_telephone2<br />
|-<br />
| --info &lt;string&gt;<br />
|Info<br />
|-<br />
| --nickname &lt;string&gt;<br />
|Nickname<br />
|-<br />
| --number_of_children &lt;string&gt;<br />
|Number_of_children<br />
|-<br />
| --note &lt;string&gt;<br />
|Note<br />
|-<br />
| --number_of_employee &lt;string&gt;<br />
|Number_of_employee<br />
|-<br />
| --telephone_pager &lt;string&gt;<br />
|Telephone_pager<br />
|-<br />
| --password_expired &lt;booleanvalue&gt;<br />
|Password_expired<br />
|-<br />
| --telephone_assistant &lt;string&gt;<br />
|Telephone_assistant<br />
|-<br />
| --telephone_business1 &lt;string&gt;<br />
|Telephone_business1<br />
|-<br />
| --telephone_business2 &lt;string&gt;<br />
|Telephone_business2<br />
|-<br />
| --telephone_car &lt;string&gt;<br />
|Telephone_car<br />
|-<br />
| --telephone_company &lt;string&gt;<br />
|Telephone_company<br />
|-<br />
| --telephone_home1 &lt;string&gt;<br />
|Telephone_home1<br />
|-<br />
| --telephone_home2 &lt;string&gt;<br />
|Telephone_home2<br />
|-<br />
| --telephone_other &lt;string&gt;<br />
|Telephone_other<br />
|-<br />
| --postal_code_home &lt;string&gt;<br />
|Postal_code_home<br />
|-<br />
| --profession &lt;string&gt;<br />
|Profession<br />
|-<br />
| --telephone_radio &lt;string&gt;<br />
|Telephone_radio<br />
|-<br />
| --room_number &lt;string&gt;<br />
|Room_number<br />
|-<br />
| --sales_volume &lt;string&gt;<br />
|Sales_volume<br />
|-<br />
| --city_other &lt;string&gt;<br />
|City_other<br />
|-<br />
| --country_other &lt;string&gt;<br />
|Country_other<br />
|-<br />
| --middle_name &lt;string&gt;<br />
|Middle_name<br />
|-<br />
| --postal_code_other &lt;string&gt;<br />
|Postal_code_other<br />
|-<br />
| --state_other &lt;string&gt;<br />
|State_other<br />
|-<br />
| --street_other &lt;string&gt;<br />
|Street_other<br />
|-<br />
| --spouse_name &lt;string&gt;<br />
|Spouse_name<br />
|-<br />
| --state_home &lt;string&gt;<br />
|State_home<br />
|-<br />
| --street_home &lt;string&gt;<br />
|Street_home<br />
|-<br />
| --suffix &lt;string&gt;<br />
|Suffix<br />
|-<br />
| --tax_id &lt;string&gt;<br />
|Tax_id<br />
|-<br />
| --telephone_telex &lt;string&gt;<br />
|Telephone_telex<br />
|-<br />
| --telephone_ttytdd &lt;string&gt;<br />
|Telephone_ttytdd<br />
|-<br />
| --url &lt;string&gt;<br />
|Url<br />
|-<br />
| --userfield01 &lt;string&gt;<br />
|Userfield01<br />
|-<br />
| --userfield02 &lt;string&gt;<br />
|Userfield02<br />
|-<br />
| --userfield03 &lt;string&gt;<br />
|Userfield03<br />
|-<br />
| --userfield04 &lt;string&gt;<br />
|Userfield04<br />
|-<br />
| --userfield05 &lt;string&gt;<br />
|Userfield05<br />
|-<br />
| --userfield06 &lt;string&gt;<br />
|Userfield06<br />
|-<br />
| --userfield07 &lt;string&gt;<br />
|Userfield07<br />
|-<br />
| --userfield08 &lt;string&gt;<br />
|Userfield08<br />
|-<br />
| --userfield09 &lt;string&gt;<br />
|Userfield09<br />
|-<br />
| --userfield10 &lt;string&gt;<br />
|Userfield10<br />
|-<br />
| --userfield11 &lt;string&gt;<br />
|Userfield11<br />
|-<br />
| --userfield12 &lt;string&gt;<br />
|Userfield12<br />
|-<br />
| --userfield13 &lt;string&gt;<br />
|Userfield13<br />
|-<br />
| --userfield14 &lt;string&gt;<br />
|Userfield14<br />
|-<br />
| --userfield15 &lt;string&gt;<br />
|Userfield15<br />
|-<br />
| --userfield16 &lt;string&gt;<br />
|Userfield16<br />
|-<br />
| --userfield17 &lt;string&gt;<br />
|Userfield17<br />
|-<br />
| --userfield18 &lt;string&gt;<br />
|Userfield18<br />
|-<br />
| --userfield19 &lt;string&gt;<br />
|Userfield19<br />
|-<br />
| --userfield20 &lt;string&gt;<br />
|Userfield20<br />
|-<br />
| --city_business &lt;string&gt;<br />
|City_business<br />
|-<br />
| --country_business &lt;string&gt;<br />
|Country_business<br />
|-<br />
| --assistant_name &lt;string&gt;<br />
|Assistant_name<br />
|-<br />
| --telephone_primary &lt;string&gt;<br />
|Telephone_primary<br />
|-<br />
| --categories &lt;string&gt;<br />
|Categories<br />
|-<br />
| --mail_folder_confirmed_ham_name &lt;string&gt;<br />
|Mail_folder_confirmed_ham_name<br />
|-<br />
| --mail_folder_confirmed_spam_name &lt;string&gt;<br />
|Mail_folder_confirmed_spam_name<br />
|-<br />
| --gui_spam_filter_capabilities_enabled &lt;booleanvalue&gt;<br />
|GUI_Spam_filter_capabilities_enabled<br />
|-<br />
| --defaultsenderaddress&lt;string&gt;<br />
|DefaultSenderAddress<br />
|-<br />
| --title &lt;string&gt;<br />
|Title<br />
|-<br />
| --position &lt;string&gt;<br />
|Position<br />
|-<br />
| --access-calendar<br />
&lt;on/off&gt;<br />
|Calendar module (Default is off)<br />
|-<br />
| --access-contacts &lt;on/off&gt;<br />
|Contact module access (Default is on)<br />
|-<br />
| --access-delegate-tasks &lt;on/off&gt;<br />
|Delegate tasks access (Default is off)<br />
|-<br />
| --access-edit-public-folder &lt;on/off&gt;<br />
|Edit public folder access (Default is off)<br />
|-<br />
| --access-ical &lt;on/off&gt;<br />
|Ical module access (Default is off)<br />
|-<br />
| --access-infostore &lt;on/off&gt;<br />
|Infostore module access (Default is off)<br />
|-<br />
| --access-read-create-shared-Folders &lt;on/off&gt;<br />
|Read create shared folder access (Default is off)<br />
|-<br />
| --access-syncml &lt;on/off&gt;<br />
|Syncml access (Default is off)<br />
|-<br />
| --access-active-sync &lt;on/off&gt;<br />
|Exchange Active Sync access (Default is off)<br />
|-<br />
| --access-usm &lt;on/off&gt;<br />
|Universal Sync Module access (Default is off)<br />
|-<br />
| --access-tasks &lt;on/off&gt;<br />
|Tasks access (Default is off)<br />
|-<br />
| --access-vcard &lt;on/off&gt;<br />
|Vcard access (Default is off)<br />
|-<br />
| --access-webdav &lt;on/off&gt;<br />
|Webdav access (Default is off)<br />
|-<br />
| --access-webdav-xml &lt;on/off&gt;<br />
|Webdav-Xml access (Default is off)<br />
|-<br />
| --access-webmail &lt;on/off&gt;<br />
|Webmail access (Default is on)<br />
|-<br />
| --access-publication &lt;on/off&gt;<br />
|Publication permission (Default is on). Note: access-publication needs access-infostore and is optional for Groupware+ and premium<br />
|-<br />
| --access-subscription &lt;on/off&gt;<br />
|Subscription permission (Default is on)<br />
|-<br />
| --access-edit-group &lt;on/off&gt;<br />
|Edit group access (Default is off)<br />
|-<br />
| --access-edit-resource &lt;on/off&gt;<br />
|Edit resource access (Default is off)<br />
|-<br />
| --access-edit-password &lt;on/off&gt;<br />
|Edit password access (Default is off)<br />
|-<br />
| --access-collect-email-addresses &lt;on/off&gt;<br />
|Edit collect email addresses (Default is off)<br />
|-<br />
| --access-multiple-mail-accounts &lt;on/off&gt;<br />
|Use multiple mail account feature (Default is off)<br />
|-<br />
| --access-global-address-book-disabled &lt;on/off&gt;<br />
|Access to global address book (Default is off). Note: Setting this option to true is only allowed in combination with PIM and Webmail rights. Note: There is a 'restoregaddefaults' script to restore the default permissions of the global address book folder. <br />
|-<br />
| --access--voipnow &lt;on/off&gt;<br />
|Access to VoiceOverIP feature.<br />
|-<br />
| --access-public-folder-editable &lt;on/off&gt;<br />
|Access to public folders. Allows or denies to see public folders. <br />
|-<br />
| --foldertree &lt;0/1&gt;<br />
|0 sets the OX standard folder tree and 1 sets the Outlook-like folder tree. <br />
|-<br />
| --access-olox20 &lt;on/off&gt;<br />
| Access to Olox2.0<br />
|}<br />
<br />
=== Access changes for existing users ===<br />
<br />
Changes to module access must be done for all users in a given context. On downgrade i. e., to revoke former given access, the data for objects will still be present in the database and on the filestore but is not visible to the customer any more. Please note that only the specified modules are changed. That is why it is required to explicitly turn modules off. A list of packages and the required module configuration is provided in [[the section called “Package access configuration”]].<br />
<br />
<br />
=== Extra parameters when authentication is enabled ===<br />
<br />
{| border="1"<br />
|-<br />
|-A,--adminuser &lt;string&gt;<br />
|Context Admin user name<br />
|-<br />
|-P,--adminpass &lt;string&gt;<br />
|Context Admin password<br />
|}<br />
<br />
=== Return value ===<br />
<br />
<code>0</code> on success<br />
<br />
<br />
<code>&gt;0</code> on failure<br />
<br />
<br />
=== Mandatory parameters ===<br />
<br />
'''<code>contextid {adminuser adminpass} (userid or username) and at minimum one attribute to change</code>'''<br />
<br />
primaryMail, Email1 and defaultSenderAddress must be present in set of aliases i. e., whenever you want to change one of<br />
* --email<br />
* --email1<br />
* --defaultsenderaddress<br />
you MUST take care, that the address you want to set is already contained in the aliases of the user.<br />
<br />
<br />
So when user has aliases: foo, bar and you want to change email to anotheraddr, you<br />
must add anotheraddr to the aliases, first.<br />
<br />
<br />
If needed, this can be done with one commandline call, e.g.:<br />
<br />
<br />
'''<code>/changeuser -A oxadmin -P secret -c 666 -i 4 -e<br />
anotheraddr -a foo,bar,anotheraddr</code>'''<br />
<br />
=== Command output ===<br />
<br />
On success:<br />
<br />
<br />
<code>user &lt;userid&gt; in &lt;contextid&gt; changed</code><br />
<br />
<br />
On failure:<br />
<br />
<br />
<code>user<br />
&lt;userid&gt; in &lt;contextid&gt; could not be changed: &lt;reason from server&gt;</code><br />
<br />
<br />
=== Example ===<br />
<br />
<code>root@oxhe~#</code>'''<code> changeuser -c 123 -i 3 -p newpwd</code>'''<br />
<br />
<br />
<code>user 3 in context 123 changed</code><br />
<br />
<br />
<br />
<br />
[[Category: Administrator]]<br />
<br />
[[Category: AppSuite]]<br />
[[Category: AdminGuide]]<br />
[[Category: CommandLineTools]]</div>
Vitali.sjablow