Skip to content

Commit 36cc9d2

Browse files
andrijapanicsbPaul Angus
andcommitted
Hiding columns and keyboard labeling doc update (apache#58)
* hiding columns and keyboard labeling doc update * Update source/adminguide/ui.rst Co-Authored-By: Paul Angus <paul.angus@shapeblue.com>
1 parent 6cb9af4 commit 36cc9d2

5 files changed

Lines changed: 88 additions & 0 deletions

File tree

13.8 KB
Loading
42 KB
Loading
35 KB
Loading
34.1 KB
Loading

source/adminguide/ui.rst

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,5 +169,93 @@ new, unique value.
169169
#. Type the new password, and click OK.
170170

171171

172+
Modifying the UI
173+
----------------
174+
175+
Root Administrators can modify some aspect of the UI, like:
176+
177+
- Changing the keyboard names/labels (in the "Add Instance" wizard only)
178+
- Changing the text and the title in the "About" dialog box
179+
- Changing the Help link
180+
- Changing the application title on the browser tab
181+
- Hiding some columns in the Instance Metrics and Volume Metrics tables/views
182+
183+
This can be done by editing the file "/usr/share/cloudstack-management/webapp/config.js" on your management server(s).
184+
After the file change, you do need to clear your browser cache. Hiding columns in Instance Metrics and Volume Metrics tables/views is only applicable to end users - i.e. those are always visible to Root Administrators.
185+
186+
This is the default config.js content (comments ommitted for brevity):
187+
188+
.. code:: javascript
189+
190+
cloudStackOptions = {
191+
aboutText: "label.app.name", // This is the text shown in the 'About' box
192+
aboutTitle: "label.about.app", // This is the Application 'Title' shown in the 'About' box
193+
docTitle: "label.app.name", // This is the Application 'Title' shown on browser tab.
194+
helpURL: "http://docs.cloudstack.apache.org/", // This is the URL that opens when users click Help
195+
keyboardOptions: {
196+
"us": "label.standard.us.keyboard",
197+
"uk": "label.uk.keyboard",
198+
"fr": "label.french.azerty.keyboard",
199+
"jp": "label.japanese.keyboard",
200+
"sc": "label.simplified.chinese.keyboard"
201+
},
202+
hiddenFields: { // Fields to be hidden only for users in the tables below
203+
"metrics.instances": [], // Options - "name", "state", "ipaddress", "zonename", "cpuused", "memused", "network", "disk"
204+
"metrics.volumes": [] // Options - "name", "state", "vmname", "sizegb", "physicalsize", "utilization", "storagetype", "storage"
205+
}
206+
};
207+
208+
Example of a changed config.js file is given bellow, as well as the apropriate screenshots which reflect (most of) those changes. Make sure that you are logged in as end user account.
209+
210+
.. code:: javascript
211+
212+
cloudStackOptions = {
213+
aboutText: "Custom About text!", // This is the text shown in the 'About' box
214+
aboutTitle: "Custom About Title!", // This is the Application 'Title' shown in the 'About' box
215+
docTitle: "MyCloud", // This is the Application 'Title' shown on browser tab.
216+
helpURL: "http://help.mycloud.com/", // This is the URL that opens when users click Help
217+
keyboardOptions: {
218+
"us": "US",
219+
"uk": "UK",
220+
"fr": "FR",
221+
"jp": "JP",
222+
"sc": "CN"
223+
},
224+
hiddenFields: { // Fields to be hidden only for users in the tables below
225+
"metrics.instances": ["zonename"], // Options - "name", "state", "ipaddress", "zonename", "cpuused", "memused", "network", "disk"
226+
"metrics.volumes": ["utilization"] // Options - "name", "state", "vmname", "sizegb", "physicalsize", "utilization", "storagetype", "storage"
227+
}
228+
};
229+
230+
|about-cloudstack-customized.JPG|
231+
232+
Notice custom title and text
233+
234+
235+
|add-instance-keyboards-customized.JPG|
236+
237+
Notice short keyboard names (based on country code)
238+
239+
240+
|instance-metrics-customized-view.JPG|
241+
242+
Notice "Zone" column is hidden
243+
244+
245+
|volume-metrics-customized-view.JPG|
246+
247+
Notice "Utilisation" column is hidden
248+
249+
250+
251+
172252
.. |change-password.png| image:: /_static/images/change-password.png
173253
:alt: button to change a user's password
254+
.. |volume-metrics-customized-view.JPG| image:: /_static/images/volume-metrics-customized-view.JPG
255+
:alt: Notice missing "Utilisation" column
256+
.. |instance-metrics-customized-view.JPG| image:: /_static/images/instance-metrics-customized-view.JPG
257+
:alt: Notice missing "Zone" column
258+
.. |about-cloudstack-customized.JPG| image:: /_static/images/about-cloudstack-customized.JPG
259+
:alt: Notice custom title and text
260+
.. |add-instance-keyboards-customized.JPG| image:: /_static/images/add-instance-keyboards-customized.JPG
261+
:alt: Notice short keyboard names (based on country code)

0 commit comments

Comments
 (0)