Difference between revisions of "ART maintenance manual"

(ART server prefix)
(ART Server Settings)
Line 29: Line 29:
  
 
== ART Server Settings ==
 
== ART Server Settings ==
[[File:art-settings-menu.png|right|150px|300px]] The ART-DECOR has a number of settings. The exact features that you as dba member may or may not want to adjust will continue to expand as ART-DECOR evolves. The settings are saved in art-data/server-info.xml in the database, but ART sports a complete UI to control them through Application > Server settings. If you do not see that menu item: you are not a DBA.
+
[[File:art-settings-menu.png|right|150px|300px]] The ART-DECOR has a number of settings. The exact features that you as dba member may or may not want to adjust will continue to expand as ART-DECOR evolves. ART sports a complete UI to control them through the menu item ''Application > Server settings''. If you do not see that menu item: you are not a DBA. The settings you can control are as follows.  
  
The settings you can control are as follows. '''All changes are saved immediately!'''
+
'''All changes are saved immediately in art-data/server-info.xml in the database, which means they are instantly effective!'''
  
 
=== ART server language ===
 
=== ART server language ===

Revision as of 21:00, 28 March 2014

Tools.svg This article or section is in the middle of an expansion or major restructuring and is not yet ready for use. You are welcome to assist in its construction by editing it as well.

ART user roles

This section describes the user roles that are used in ART, with the corresponding groups the user should have permission for.

The roles in ART and corresponding group permissions:

  • Project editor - Groups: decor, editor, issues. Besides these groups the user should also be listed as author in the project section in the decor file.
  • Project author - Groups: decor-admin (the rest is the same as 'Project editor'). This role enables extra tabs in the project tab: Ids, Status, Compilations and MyCommunity.
  • Issue editor - Groups: decor, issues. Besides these groups the user should also be listed as author in the project section in the decor file.
  • Refset editor - Groups: terminology, editor. Besides these groups the user should also be listed as author in the project section in the refset file.
  • Testing/SOAP interaction tester - Groups: decor, xis. Besides these groups the user should also be listed in a testaccount.
  • Read-only view - No groups necessary.
  • Database admin - dba.

In order to give permissions you must be logged in as database admin, and choose the menu 'Application' -> tab 'Users'.

The following groups are available for users:

  • dba - Creating users, DECOR projects, etc.
  • debug - Show the Orbeon forms debug information. Do not use, except for ART-developers.
  • decor - General permission to write to DECOR projects.
  • editor - Creating, editing, deleting of DECOR objects (dataset, scenario's, valuesets).
  • guest - Read-only access to data in a DECOR project.
  • issues - Creating and editing of issues in DECOR projects.
  • tools - Creating and editing in the OID-registry.
  • xis - Access to the tab 'testing' and the underlying functionality such as uploading message instances.

How to add a user to a DECOR project: Open the DECOR project, choose the tab 'Project' -> 'Authors'. In order to perform this action you must be either in the groups: decor and editor and be named as an author in the DECOR project or have database admin permissions.

ART Server Settings

Art-settings-menu.png

The ART-DECOR has a number of settings. The exact features that you as dba member may or may not want to adjust will continue to expand as ART-DECOR evolves. ART sports a complete UI to control them through the menu item Application > Server settings. If you do not see that menu item: you are not a DBA. The settings you can control are as follows.

All changes are saved immediately in art-data/server-info.xml in the database, which means they are instantly effective!

ART server language

Art-settings-language.png

The language that the server will present itself in, if there is no user setting available. Default is en-US (US English). Note: user settings can be set by administrators through the user management, or by the user from the home page.

<defaultLanguage>en-US</defaultLanguage>

ART server prefix

Art-settings-serverprefix.png

When certain routines need to know what the server is, this is the setting they'll consult. In publications for example, this setting is used to build links back to project issues. Must end in art-decor/

<url-art-decor-deeplinkprefix>http://art-decor.org/art-decor/</url-art-decor-deeplinkprefix>

ART services prefix

Art-settings-servicesprefix.png

When certain routines need to know where to find the services for this server, this is the setting they'll consult. Must end in services/

<url-art-decor-services>http://art-decor.org/decor/services/</url-art-decor-services>

ART server stylesheet

Art-settings-serverxsl.png

All ART UI has some kind of menu structure, and logo at the top of the page. This is governed by an XSL file. A few different skins come predefined to make ART appear like a special purpose server. The XSL must live in art/resources/stylesheets. All xsls in this database location are presented in the drop down list. TODO: create more info on skinning ART

<xformStylesheet>apply-rules.xsl</xformStylesheet>

External repository server

Art-settings-repositoryserver.png

Your server may host one or more DECOR building block repositories (BBR), but you may also want to use externally hosted BBRs. To retrieve these you need the services URL for that server as an External repository server. This services url is like the ART services prefix setting for your own server. The services url for art-decor.org comes predefined, but you change it or add more. When you click the Select button you get a dialog that allows you to select the repositories that this server hosts and add them as External building block repository (see below).

<buildingBlockServer url="http://art-decor.org/decor/services/">

External building block repositories

Art-settings-externalrepository.png

If you want to offer projects the option to add external building block repositories (BBR) to their project, you need to have one or more preconfigured here. You can delete them here, but they will remain active in any project that already uses them, so deleting only affects what project can select from from that point on. If you want you can override the name supplied for the repository by the external server.

<buildingBlockRepository url="http://art-decor.org/decor/services/" ident="ad1bbr-">
   <name language="en-US">CDA Release 2</name>
   <name language="nl-NL">CDA Release 2</name>
   <name language="de-DE">CDA Release 2</name>
</buildingBlockRepository>