El tag XSQL-Script webapp.wic_jrep_object.getDoc permite obtener la documentación de un objeto/tabla, esta documentación es la misma que se obtiene a través del incono Ayuda del objeto. Se obtiene la siguiente información:

  • Documentación del objeto.
  • Documentación de la tabla principal del objeto.
  • Pestañas o tabs del objeto.
  • Layout del objeto.
  • Buttons del objeto.
  • Javascript events.
  • Atributos físicos de la tabla.
  • Columnas (nombre, Label, Descripción, tipos, tamaño, etc).
  • Indices de la tabla principal.
  • Clave primaria de la tabla principal.
  • Imported key de la tabla principal.
  • Exported keys de la tabla principal.
  • Triggers de la tabla principal.
  • Transaction manager del objeto.

1 webapp.wic_jrep_object.getDoc

<webapp.wic_jrep_object.getDoc
    code='code'
    lang='lang'
    xml='xml'
/>

Exceptions

UndefinedJRepObject: SQL object xxx is not defined.

El Objeto SQL no existe.

Example

Obetener la documentación de la tabla capuntes.

Copy 
<xsql-script name='sample_documentacion'>
    <body>
        <println>
            <webapp.wic_jrep_object.getDoc
                code='capuntes'
                lang='es'
                xml='false'
            />
        </println>
    </body>
</xsql-script>
Example

Se muestra un ejemplo de como obtener la documentación de todos los objetos (de forma másica) de una wic.

Copy 
<xsql-script name='getDocForDictionary'>
   <body>
       <!-- connected to a dictionary proces each sql object -->
       <foreach>
           <select prefix='m_'>
               <columns>
                   rep_code
               </columns>
               <from table='wic_jrep_object' />
           </select>
           <do>
               <debug.log batch='true'>Generating doclet for <m_rep_code /></debug.log>
               <!-- connect to a target database and generate doclet for object -->
               <connection name='demo_sports1'>
                   <set name='objname'><m_rep_code /></set>
                   <file.write>
                       <file name='#objname.html' type='absolute' />
                       <webapp.wic_jrep_object.getDoc
                           code='#objname'
                           lang='es'
                           xml='false'
                       />
                   </file.write>
               </connection>
           </do>
       </foreach>
   </body>

</xsql-script>

El xsql-script se debe ejecutar sobre una wic (de la base de datos de explotación) y dentro del xsql-script se debería cambiar el name de la connection por el name de la aplicación de explotación.