Tags:
create new tag
view all tags

.UTIL UPDATE DOCUMENT

This subroutine is called to update documentation via ILF.


Usage:

      PASS         <app_id>                   FIELD            SHARE? N
      PASS         <version>                  FIELD            SHARE? N
      PASS         <item_type>                FIELD            SHARE? N
      PASS         <process_type>             FIELD            SHARE? N
      PASS         <name>                     FIELD            SHARE? N
      PASS         <doc_type>                 FIELD            SHARE? N
      PASS         <documentation>            FIELD            SHARE? N
      GOSUB    --- .UTIL UPDATE DOCUMENT
      *        Check for errors
      IF       --- .UTIL UPDATE DOCUMENT      NE

Description:

This subroutine is called to update documentation via ILF. All parameters except for <documentation> are required. If any required parameters are missing, the subroutine will CANCEL.

<app_id> is the application whose documentation you want to update (Required).

<version> is the version of application whose documentation you want to update (Required).

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

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

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

<doc_type> is the type of documentation you want to update, User or Tech (Required).

<documentation> 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.


-- JeanNeron - 2012-01-27

Topic revision: r1 - 2012-01-27 - JeanNeron
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback