RPC HELP Tutorial Step 4 - Revision history

Kdtop at 15:21, 16 July 2015

2015-07-16T15:21:51Z

← Older revision		Revision as of 15:21, 16 July 2015
Line 32:		Line 32:
	; now set termtype entries into data global		; now set termtype entries into data global
	'''IF''' '$D(DIERR) '''DO'''		'''IF''' '$D(DIERR) '''DO'''
	. '''SET''' %=0 F S %=$O(^TMP("DILIST",$J,2,%)) Q:%="" D		. '''SET''' %=0 F S %=$O(^TMP("DILIST",$J,2,%)) Q:%="" '''DO'''
	. . '''SET''' ^TMP($J,"ZxxxTT",%)=$G(^TMP("DILIST",$J,2,%))_"^"_$G(^TMP("DILIST",$J,1,%))		. . '''SET''' ^TMP($J,"ZxxxTT",%)=$G(^TMP("DILIST",$J,2,%))_"^"_$G(^TMP("DILIST",$J,1,%))
	'''KILL''' ^TMP("DILIST",$J) ; clean up		'''KILL''' ^TMP("DILIST",$J) ; clean up

Kdtop at 15:21, 16 July 2015

2015-07-16T15:21:21Z

← Older revision		Revision as of 15:21, 16 July 2015
Line 32:		Line 32:
	; now set termtype entries into data global		; now set termtype entries into data global
	'''IF''' '$D(DIERR) '''DO'''		'''IF''' '$D(DIERR) '''DO'''
	. '''SET''' %=0 F S %=$O(^TMP("DILIST",$J,2,%)) Q:%="" D		. '''SET''' %=0 F S %=$O(^TMP("DILIST",$J,2,%)) Q:%="" D
	. . '''SET''' ^TMP($J,"ZxxxTT",%)=$G(^TMP("DILIST",$J,2,%))_"^"_$G(^TMP("DILIST",$J,1,%))		. . '''SET''' ^TMP($J,"ZxxxTT",%)=$G(^TMP("DILIST",$J,2,%))_"^"_$G(^TMP("DILIST",$J,1,%))
	'''KILL''' ^TMP("DILIST",$J) ; clean up		'''KILL''' ^TMP("DILIST",$J) ; clean up

Kdtop at 18:43, 15 July 2015

2015-07-15T18:43:22Z

← Older revision		Revision as of 18:43, 15 July 2015
Line 16:		Line 16:
	* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Global_Instance\|GLOBAL INSTANCE]]		* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Global_Instance\|GLOBAL INSTANCE]]

	Since the type of data the tutorial application would like returned is a list of terminal types, and that list could be quite long, use a return value type GLOBAL ARRAY for your [[RPC_HELP_RPCs\|RPC]]. For the routine called by your RPC, this means that:		Since the type of data the tutorial application would like returned is a list of terminal types, and that list could be quite long, use a return value type [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Global_Array\|GLOBAL ARRAY]] for your [[RPC_HELP_RPCs\|RPC]]. For the routine called by your RPC, this means that:
	* Your routine should return a list of terminal types in a global. Each terminal type should be on an individual data node, subscripted numerically.		* Your routine should return a list of terminal types in a global. Each terminal type should be on an individual data node, subscripted numerically.
	* The return value of your routine (always returned in the routine's first parameter) should be the global reference of the data global, in closed root form. The data nodes should be one level descendant from the global reference.		* The return value of your routine (always returned in the routine's first parameter) should be the global reference of the data global, in closed root form. The data nodes should be one level descendant from the global reference.

Kdtop at 18:41, 15 July 2015

2015-07-15T18:41:25Z

← Older revision		Revision as of 18:41, 15 July 2015
Line 10:		Line 10:

	'''1.''' Choose the data format that your [[RPC_HELP_RPCs\|RPC]] should return. The type of data that you need to return to your client application determines the format of the routine that your RPC will call. There are five [[RPC_HELP_BROKER_RETURN_VALUE_TYPES\|Return Value Types]] for RPCs:		'''1.''' Choose the data format that your [[RPC_HELP_RPCs\|RPC]] should return. The type of data that you need to return to your client application determines the format of the routine that your RPC will call. There are five [[RPC_HELP_BROKER_RETURN_VALUE_TYPES\|Return Value Types]] for RPCs:
	* SINGLE VALUE		* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Single_Value\|SINGLE VALUE]]
	* ARRAY		* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Array\|ARRAY]]
	* WORD PROCESSING		* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Word_Processing\|WORD PROCESSING]]
	* GLOBAL ARRAY		* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Global_Array\|GLOBAL ARRAY]]
	* GLOBAL INSTANCE		* [[RPC_HELP_BROKER_RETURN_VALUE_TYPES#Return_Value_Types_--_Global_Instance\|GLOBAL INSTANCE]]

	Since the type of data the tutorial application would like returned is a list of terminal types, and that list could be quite long, use a return value type GLOBAL ARRAY for your [[RPC_HELP_RPCs\|RPC]]. For the routine called by your RPC, this means that:		Since the type of data the tutorial application would like returned is a list of terminal types, and that list could be quite long, use a return value type GLOBAL ARRAY for your [[RPC_HELP_RPCs\|RPC]]. For the routine called by your RPC, this means that:

Kdtop at 18:35, 15 July 2015

2015-07-15T18:35:43Z

← Older revision		Revision as of 18:35, 15 July 2015
Line 9:		Line 9:
	To do this:		To do this:

	'''1.''' Choose the data format that your [[RPC_HELP_RPCs\|RPC]] should return. The type of data that you need to return to your client application determines the format of the routine that your RPC will call. There are five ~~return value types~~ for RPCs:		'''1.''' Choose the data format that your [[RPC_HELP_RPCs\|RPC]] should return. The type of data that you need to return to your client application determines the format of the routine that your RPC will call. There are five [[RPC_HELP_BROKER_RETURN_VALUE_TYPES\|Return Value Types]] for RPCs:
	* SINGLE VALUE		* SINGLE VALUE
	* ARRAY		* ARRAY

Kdtop at 18:15, 15 July 2015

2015-07-15T18:15:58Z

← Older revision		Revision as of 18:15, 15 July 2015
Line 3:		Line 3:
	[[RPC_Broker_Help#Tutorial\|Tutorial Home]]		[[RPC_Broker_Help#Tutorial\|Tutorial Home]]
	<h2>Tutorial: Step 4 -- Routine to List Terminal Types</h2>		<h2>Tutorial: Step 4 -- Routine to List Terminal Types</h2>
	Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server (Step 3), you are ready to create custom [[RPC_HELP_RPCs\|RPC]]s that your application can call. For the tutorial, you will create an RPC that retrieves the list of all terminal types from the RPC Broker server.		Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server ([[RPC_HELP_Tutorial_Step_3\|Step 3]]), you are ready to create custom [[RPC_HELP_RPCs\|RPC]]s that your application can call. For the tutorial, you will create an RPC that retrieves the list of all terminal types from the RPC Broker server.

	The first step in creating an [[RPC_HELP_RPCs\|RPC]] is to create the routine that the RPC will execute. You must create its input and output in a defined format that will be compatible with being executed as an RPC.		The first step in creating an [[RPC_HELP_RPCs\|RPC]] is to create the routine that the RPC will execute. You must create its input and output in a defined format that will be compatible with being executed as an RPC.

Kdtop at 20:44, 5 July 2015

2015-07-05T20:44:07Z

← Older revision		Revision as of 20:44, 5 July 2015
Line 1:		Line 1:
			[[RPC_Broker_Help\| RPC Broker Help Home]]

			[[RPC_Broker_Help#Tutorial\|Tutorial Home]]
	<h2>Tutorial: Step 4 -- Routine to List Terminal Types</h2>		<h2>Tutorial: Step 4 -- Routine to List Terminal Types</h2>
	Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server (Step 3), you are ready to create custom [[RPC_HELP_RPCs\|RPC]]s that your application can call. For the tutorial, you will create an RPC that retrieves the list of all terminal types from the RPC Broker server.		Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server (Step 3), you are ready to create custom [[RPC_HELP_RPCs\|RPC]]s that your application can call. For the tutorial, you will create an RPC that retrieves the list of all terminal types from the RPC Broker server.

Kdtop at 17:30, 5 July 2015

2015-07-05T17:30:45Z

← Older revision		Revision as of 17:30, 5 July 2015
Line 63:		Line 63:
	Once you've tested your routine, and confirmed that it returns data correctly, the next step ([[RPC_HELP_Tutorial_Step_5\|Step 5]]) is to create the RPC that will call this routine.		Once you've tested your routine, and confirmed that it returns data correctly, the next step ([[RPC_HELP_Tutorial_Step_5\|Step 5]]) is to create the RPC that will call this routine.

	<h4>[[RPC_HELP_Tutorial_Step_3\|Step 3: Establish Broker Connection]]</h4>		<h4>[[RPC_HELP_Tutorial_Step_3\|PREV: Step 3: Establish Broker Connection]]</h4>
	<h4>[[RPC_HELP_Tutorial_Step_5\|Step 5: RPC To List Terminal Types]]</h4>		<h4>[[RPC_HELP_Tutorial_Step_5\|NEXT: Step 5: RPC To List Terminal Types]]</h4>

Kdtop: Created page with "

Tutorial: Step 4 -- Routine to List Terminal Types

Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server (Step 3), you a..."

2015-07-05T17:29:56Z

Created page with "<h2>Tutorial: Step 4 -- Routine to List Terminal Types</h2> Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server (Step 3), you a..."

New page

<h2>Tutorial: Step 4 -- Routine to List Terminal Types</h2>
Now that your application uses an RPC Broker component to connect correctly to an RPC Broker server (Step 3), you are ready to create custom [[RPC_HELP_RPCs|RPC]]s that your application can call. For the tutorial, you will create an RPC that retrieves the list of all terminal types from the RPC Broker server.

The first step in creating an [[RPC_HELP_RPCs|RPC]] is to create the routine that the RPC will execute. You must create its input and output in a defined format that will be compatible with being executed as an RPC.

To do this:

'''1.''' Choose the data format that your [[RPC_HELP_RPCs|RPC]] should return. The type of data that you need to return to your client application determines the format of the routine that your RPC will call. There are five return value types for RPCs:
* SINGLE VALUE
* ARRAY
* WORD PROCESSING
* GLOBAL ARRAY
* GLOBAL INSTANCE

Since the type of data the tutorial application would like returned is a list of terminal types, and that list could be quite long, use a return value type GLOBAL ARRAY for your [[RPC_HELP_RPCs|RPC]]. For the routine called by your RPC, this means that:
* Your routine should return a list of terminal types in a global. Each terminal type should be on an individual data node, subscripted numerically.
* The return value of your routine (always returned in the routine's first parameter) should be the global reference of the data global, in closed root form. The data nodes should be one level descendant from the global reference.

'''2.''' Create a routine, in the M account that your [[RPC_HELP_TRPCBroker|TRPCBroker]] component connects to, that outputs a list of terminal types in the format determined above. The format for each data node that is returned for a terminal type could be anything; for the sake of this application, set each data node to "ien^.01 field" for the terminal type in question. Store each node in ^TMP($J,"ZxxxTT",#).

ZxxxTT ;ISC-SF/KC TUTORIAL RTN, BRK 1.1; 7/22/97
;;1.0;;
TERMLIST(GLOBREF) ; retrieve list of term types
; return list in ^TMP($J,"ZxxxTT")
; format of returned results: ien^.01 field
'''NEW''' % ; scratch variable
'''KIL'''L ^TMP($J,"ZxxxTT") ; clear data return area
'''DO''' LIST^DIC(3.2) ; retrieve list of termtype entries
; now set termtype entries into data global
'''IF''' '$D(DIERR) '''DO'''
. '''SET''' %=0 F S %=$O(^TMP("DILIST",$J,2,%)) Q:%="" D
. . '''SET''' ^TMP($J,"ZxxxTT",%)=$G(^TMP("DILIST",$J,2,%))_"^"_$G(^TMP("DILIST",$J,1,%))
'''KILL''' ^TMP("DILIST",$J) ; clean up
'''SET''' GLOBREF=$NA(^TMP($J,"ZxxxTT")) ; set return value
'''QUIT'''

'''3.''' Test the routine. Call it like the Broker would:

> DO TERMLIST^ZxxxTT(.RESULT)

'''a.''' Confirm that the return value is the correct global reference:

> W RESULT
^TMP(566363396,"ZxxxTT")

'''b.''' Confirm that the data set into the global is in the following format:

^TMP(566347920,"ZxxxTT",1) = 1^C-3101
^TMP(566347920,"ZxxxTT",2) = 2^C-ADDS
^TMP(566347920,"ZxxxTT",3) = 3^C-ADM3
^TMP(566347920,"ZxxxTT",4) = 38^C-DATAMEDIA
^TMP(566347920,"ZxxxTT",5) = 106^C-DATATREE
^TMP(566347920,"ZxxxTT",6) = 4^C-DEC
^TMP(566347920,"ZxxxTT",7) = 5^C-DEC132
^TMP(566347920,"ZxxxTT",8) = 93^C-FALCO
^TMP(566347920,"ZxxxTT",9) = 6^C-H1500
^TMP(566347920,"ZxxxTT",10) = 103^C-HINQLINK
^TMP(566347920,"ZxxxTT",11) = 132^C-HINQLINK
^TMP(566347920,"ZxxxTT",12) = 63^C-HP110
^TMP(566347920,"ZxxxTT",13) = 34^C-HP2621

Once you've tested your routine, and confirmed that it returns data correctly, the next step ([[RPC_HELP_Tutorial_Step_5|Step 5]]) is to create the RPC that will call this routine.

<h4>[[RPC_HELP_Tutorial_Step_3|Step 3: Establish Broker Connection]]</h4>
<h4>[[RPC_HELP_Tutorial_Step_5|Step 5: RPC To List Terminal Types]]</h4>