Menu

#798 Documentation update

2.0.2
closed
nobody
None
fixed
Documentation
major
2.0.1
task
2013-12-11
2013-10-21
Denis
No

This ticket lists the changes to be made to the iTop documentation for the 2.0.2 release:

XML documentation
This section contains the changes to the documentation of the XML data model:

  • New <filter></filter> tag on AttributeLinkedSet tags.
  • New <edit_mode>add_remove</edit_mode> for AttributeLinkedSet.
  • New <tracking_level>none|all</tracking_level> tag for all types of attributes
  • New <always_load_in_tables>true|false</always_load_in_tables> tag for all types of attributes
  • New <indexes> into the class properties:

    <indexes>
       <index id="n">
          <attributes>
             <attribute id="xxx">
             </attribute>
          </attribute>
       </index>
    </indexes>
    
  • New top level customization <branding>

    <branding>
       <main_logo>png file relative path or fileref</main_logo>
       <login_logo>png file relative path or fileref</login_logo>
       <portal_logo>png file relative path or fileref</portal_logo>
    </branding>
    
  • Allow to restrict access to "TemplateMenuNode"

    <menu id="xxx" xsi:type="TemplateMenuNode">
    ...
       <enable_class>Organization</enable_class>
       <enable_action>UR_ACTION_MODIFY</enable_action>
       <enable_permission>UR_ALLOWED_YES</enable_permission>
       <enable_stimulus/>
    </menu>
    
  • New top level customization: constants

      <constants>
        <constant id="FOO" xsi:type="string" _delta="define"><![CDATA[blah blah here]]></constant>
        <constant id="FOO" xsi:type="integer" _delta="define">-123</constant>
      </constants>
    

Configuration
This section contains the changes to the configuration parameters:

  • forgot_password = true|false to switch on/off the forgot password feature (default: true)
  • max_linkset_output = Maximum number of items shown when getting a list of related items in an email, using the form $this->some_list$. 0 means no limit. Defaults to 100.
  • portal_tickets = CSV of classes (Defaults to 'UserRequest'). Purpose: set to 'UserRequest,Incident' to manage both User Request and Incidents in the portal

REST/JSON API
This section contains the changes to the REST/JSON API:

  • New version: 1.1 (1.0 still supported, same behavior)
  • Fixed issue on external keys (core/create and core/update: it was not possible to set an external key to 0)
  • Fixed issue on search criteria (changed from "loose" to "strict")
  • Added the object key in each returned object description

End-User documentation
This section contains the changes to the end-user documentation and screenshots:

  • Managing relations: new way to manage 1:n linksets (add_remove)
  • New Shortcut : new option for auto refresh
  • Dashboard edition : new option for auto refresh
  • Preview of attachments in Object modification
  • Search form: select all options at once (refresh the very first screen shot)

Other

  • Document the IIS limit of 300s for the execution of CGI processes
  • Support of IE8 ???
  • Forgot password (iif the user has a contact with a valid email, and if sending emails is correctly setup). Can be disabled (see config changes). Draft version in Forgot password, to be plugged into Managing user accounts
  • Data sync : Refresh the screen shot of the synchro attributes (display also the attribute code)
  • New placeholder in notifications: $this->xxxxx_list$
  • Preview of the query in the query phrasebook
  • VLAN added somewhere in the data model

Discussion

  • Denis

    Denis - 2013-10-21
    • description modified (diff)
    • summary changed from XML documentation update to Documentation update
     
  • Denis

    Denis - 2013-10-21
    • description modified (diff)
     
  • Denis

    Denis - 2013-10-21
    • description modified (diff)
     
  • Romain Quetiez

    Romain Quetiez - 2013-10-23
    • type changed from enhancement to task
    • description modified (diff)
     
  • Romain Quetiez

    Romain Quetiez - 2013-10-24
    • description modified (diff)
     
  • Romain Quetiez

    Romain Quetiez - 2013-10-25
    • description modified (diff)
     
  • Romain Quetiez

    Romain Quetiez - 2013-10-29
    • description modified (diff)
     
  • Romain Quetiez

    Romain Quetiez - 2013-11-07
    • description modified (diff)
     
  • Romain Quetiez

    Romain Quetiez - 2013-12-11
    • status changed from new to closed
    • resolution set to fixed

    Done in https://wiki.openitop.org

     

Log in to post a comment.

MongoDB Logo MongoDB