0LAUtilUpdateDocument < Main

Tags: view all tags
---+ .UTIL UPDATE DOCUMENT

_This subroutine is called to update documentation via ILF._

<br />%TOC%
---++ Usage:
<pre>      PASS         &lt;app_id&gt;                   FIELD            SHARE? N
      PASS         &lt;version&gt;                  FIELD            SHARE? N
      PASS         &lt;item_type&gt;                FIELD            SHARE? N
      PASS         &lt;process_type&gt;             FIELD            SHARE? N
      PASS         &lt;name&gt;                     FIELD            SHARE? N
      PASS         &lt;doc_type&gt;                 FIELD            SHARE? N
      PASS         &lt;documentation&gt;            FIELD            SHARE? N
      GOSUB    --- .UTIL UPDATE DOCUMENT
      *        Check for errors
      IF       --- .UTIL UPDATE DOCUMENT      NE

</pre>
---++ Description:

This subroutine is called to update documentation via ILF. All parameters except for &lt;documentation&gt; are required. If any required parameters are missing, the subroutine will CANCEL.

&lt;app_id&gt; is the application whose documentation you want to update (Required).

&lt;version&gt; is the version of application whose documentation you want to update (Required).

&lt;item_type&gt; is the type of documentation you want to update (Required). Must be one of Application, Domain, Record, Field and Process.

&lt;process_type&gt; is the process type whose documentation you want to update (Required). Must be a valid Appx process type (Input, Output, etc) if &lt;item_type&gt; is Process. This is ignored for the other &lt;item_types&gt;, but must still be passed.

&lt;name&gt; is the name of the item whose documentation you want to update (Required). For &lt;item_type&gt; Domain, it must be a Domain name. For &lt;item_type&gt; Record, it must be a File name. For &lt;item_type&gt; Field, it must be a field name. For &lt;item_type&gt; Process, it must be a process name. This is ignored for &lt;item_type&gt; Application, but must still be passed.

&lt;doc_type&gt; is the type of documentation you want to update, User or Tech (Required).

&lt;documentation&gt; is the documentation you want updated (Optional). If blank or not passed, existing documentation will be removed. Maximum length of 1264 characters.

---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2012-01-27
Topic revision: r1 - 2012-01-27 - JeanNeron