JAL: Dictionary and SQL server from RKTools main menu

2017-06-22T22:51:20Z

Dictionary and SQL server from RKTools main menu

← Older revision		Revision as of 22:51, 22 June 2017
Line 71:		Line 71:
	The DOCument command is typically implemented while using another facility such as the Procedure Editor. It documents the work being done in that facility. Issuing the command takes you to the Update function, enabling you to update the entry corresponding to the database entity being worked on. For example, if you have modified a procedure, you can issue the DOC command to document the changes in the dictionary entry for that procedure.</p></li>		The DOCument command is typically implemented while using another facility such as the Procedure Editor. It documents the work being done in that facility. Issuing the command takes you to the Update function, enabling you to update the entry corresponding to the database entity being worked on. For example, if you have modified a procedure, you can issue the DOC command to document the changes in the dictionary entry for that procedure.</p></li>

	<li>If using the [[RKWeb]] interface, select <code>Manage > Dictionary > Documents</code>. </li>		<li>If using the [[RKTools#mainmenu\|RKTools main menu]], select the <b>Document</b> menu item. If using the [[RKWeb]] interface, select <code>Manage > Dictionary > Documents</code>. </li>
	</ul>		</ul>

JAL: add link

2017-06-16T23:58:19Z

add link

← Older revision		Revision as of 23:58, 16 June 2017
Line 42:		Line 42:
	To log on to the Documentation facility, choose one of the following methods:</p>		To log on to the Documentation facility, choose one of the following methods:</p>
	<ul>		<ul>
	<li>		<li>Select the number of the Documentation facility option from the Dictionary/204 main menu.
	Select the number of the Documentation facility option from the Dictionary/204 main menu.
	<p>		<p>
	If your main menu does not display the Documentation option, you cannot access this facility from the Dictionary/204 menu. You can, however, access the facility by using options 2, 3, and 4, if you have user privileges for other facilities.</p>		If your main menu does not display the Documentation option, you cannot access this facility from the Dictionary/204 menu. You can, however, access the facility by using options 2, 3, and 4, if you have user privileges for other facilities.</p></li>
	</li>
	<li>		<li>Invoke the Documentation facility from the primary screens of another Dictionary/204 facility with the INVOKE command. The syntax of the command is:
	Invoke the Documentation facility from the primary screens of another Dictionary/204 facility with the INVOKE command. The syntax of the command is:
	<p class="code">INVoke DOCUMENT </p>		<p class="code">INVoke DOCUMENT </p>
	<p>		<p>
	Although this logon method does not require that you have user privileges for the Documentation facility, it does not let you use the facility for documenting any entity type. You can use the facility only for documenting entries of entity types controlled by facilities for which you do have user privileges. The main menu requires you to specify the entity type of the entry you are documenting.</p>		Although this logon method does not require that you have user privileges for the Documentation facility, it does not let you use the facility for documenting any entity type. You can use the facility only for documenting entries of entity types controlled by facilities for which you do have user privileges. The main menu requires you to specify the entity type of the entry you are documenting.</p>
	<p>For example, if you are a Procedure Editor user, you can add descriptive documentation to PROCEDURE entries using this facility. But if you are not a File Management user, you cannot add descriptive documentation for FILE, FIELD, FIELD GROUP, or RECORD entries, because these are controlled by the File Management facility.</p>		<p>
			For example, if you are a Procedure Editor user, you can add descriptive documentation to PROCEDURE entries using this facility. But if you are not a File Management user, you cannot add descriptive documentation for FILE, FIELD, FIELD GROUP, or RECORD entries, because these are controlled by the File Management facility.</p>
	<p>		<p>
	To document the entries of uncontrolled entity types (such as VIEWs or REPORTs), you must have Documentation facility privileges.</p>		To document the entries of uncontrolled entity types (such as VIEWs or REPORTs), you must have Documentation facility privileges.</p>
	<p>		<p>
	The dictionary administrator can establish further restrictions by specifying the set of entities each user is allowed to modify. These special restrictions are described in [[#Establishing security restrictions\|Establishing security restrictions]].</p>		The dictionary administrator can establish further restrictions by specifying the set of entities each user is allowed to modify. These special restrictions are described in [[#Establishing security restrictions\|Establishing security restrictions]].</p></li>
	</li>
	<li>		<li>Call the Documentation facility subsystem from the Model 204 command prompt by typing the subsystem name:
	Call the Documentation facility subsystem from the Model 204 command prompt by typing the subsystem name:

	<p class="code">> DOCUMENT </p>		<p class="code">> DOCUMENT </p>
	<p>		<p>
	You can log on to the Documentation facility with this method only if the DOCUMENT subsystem has been started. Logging on by this method, you can document entries controlled by facilities for which you are an authorized user. </p>		You can log on to the Documentation facility with this method only if the DOCUMENT subsystem has been started. Logging on by this method, you can document entries controlled by facilities for which you are an authorized user. </p></li>
	</li>
	<li>		<li>The Update function of the Documentation facility can be implemented by issuing the DOCUMENT command from the command line of some Dictionary/204 primary screens. The syntax of the command is:
	The Update function of the Documentation facility can be implemented by issuing the DOCUMENT command from the command line of some Dictionary/204 primary screens. The syntax of the command is:

	<p class="code">DOCument </p>		<p class="code">DOCument </p>
Line 72:		Line 69:
	(In most cases this command has an assigned PF key.)</p>		(In most cases this command has an assigned PF key.)</p>
	<p>		<p>
	The DOCument command is typically implemented while using another facility such as the Procedure Editor. It documents the work being done in that facility. Issuing the command takes you to the Update function, enabling you to update the entry corresponding to the database entity being worked on. For example, if you have modified a procedure, you can issue the DOC command to document the changes in the dictionary entry for that procedure.</p>		The DOCument command is typically implemented while using another facility such as the Procedure Editor. It documents the work being done in that facility. Issuing the command takes you to the Update function, enabling you to update the entry corresponding to the database entity being worked on. For example, if you have modified a procedure, you can issue the DOC command to document the changes in the dictionary entry for that procedure.</p></li>
	</li>
			<li>If using the [[RKWeb]] interface, select <code>Manage > Dictionary > Documents</code>. </li>
	</ul>		</ul>

ELowell at 22:32, 9 December 2016

2016-12-09T22:32:21Z

← Older revision		Revision as of 22:32, 9 December 2016
Line 655:		Line 655:

	<p class="figure">[[File:Dictionary_fig8-17.png]]</p>		<p class="figure">[[File:Dictionary_fig8-17.png]]</p>

			==See also==
			{{Template: Dictionary/204 topic list}}

	[[Category: Dictionary/204]]		[[Category: Dictionary/204]]

ELowell: Created page with " ==Overview==
The Documentation facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of..."

2016-12-06T01:21:48Z

Created page with " ==Overview== <p> The Documentation facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of..."

Show changes

Dictionary/204 Documentation facility - Revision history

JAL: Dictionary and SQL server from RKTools main menu

JAL: add link

ELowell at 22:32, 9 December 2016

ELowell: Created page with " ==Overview== The Documentation facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of..."

ELowell: Created page with " ==Overview==
The Documentation facility provides an interface for defining and describing attributes and relationships that are not controlled by the system or by one of..."