Difference between revisions of "RPC HELP M Entry In RP File"
From VistApedia
(Created page with " RPC Entry in the Remote Procedure File After the M code is complete, you need to add the RPC to the REMOTE PROCEDURE file (#8994). The following fields in the REMOTE PROCE...") |
|||
| Line 1: | Line 1: | ||
| − | + | [[RPC_Broker_Help| RPC Broker Help Home]] | |
| − | + | <h2>RPC Entry in the Remote Procedure File</h2> | |
| − | + | After the M code is complete, you need to add the RPC to the REMOTE PROCEDURE file (#8994). The following fields in the REMOTE PROCEDURE file (#8994) are key to the correct operation of an RPC: | |
| − | RPC Entry in the Remote Procedure File | ||
| − | |||
| − | + | {| class="grey" border="1" cellpadding="2" | |
| − | + | |- | |
| − | + | ! Field Name | |
| − | + | ! Required? | |
| − | + | ! Description | |
| − | + | |- | |
| − | + | | NAME (#.01) | |
| − | + | | Yes | |
| − | + | | The name that identifies the RPC (this entry should be namespaced in the package namespace). | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | + | | TAG (#.02) | |
| − | + | | Yes | |
| − | + | | The tag at which the remote procedure call begins. | |
|- | |- | ||
| − | | | + | | ROUTINE (#.03) |
| − | | | + | | Yes |
| − | | | + | | The name of the routine that should be invoked to start the RPC. |
|- | |- | ||
| − | | | + | | WORD WRAP ON (#.08) |
| − | | | + | | No |
| − | | | + | | Affects GLOBAL ARRAY and WORD PROCESSING return value types only. If set to False, all data values are returned in a single concatenated string in Results[0]. If set to True, each array node on the M side is returned as a distinct array item in Results. |
|- | |- | ||
| − | | | + | | RETURN VALUE TYPE (#.04) |
| − | | | + | | Yes |
| + | | This can be one of five types: SINGLE VALUE, ARRAY, WORD PROCESSING, GLOBAL ARRAY, GLOBAL INSTANCE. This setting controls how the Broker processes an RPC's return parameter. | ||
|} | |} | ||
Latest revision as of 11:19, 6 July 2015
RPC Entry in the Remote Procedure File
After the M code is complete, you need to add the RPC to the REMOTE PROCEDURE file (#8994). The following fields in the REMOTE PROCEDURE file (#8994) are key to the correct operation of an RPC:
| Field Name | Required? | Description |
|---|---|---|
| NAME (#.01) | Yes | The name that identifies the RPC (this entry should be namespaced in the package namespace). |
| TAG (#.02) | Yes | The tag at which the remote procedure call begins. |
| ROUTINE (#.03) | Yes | The name of the routine that should be invoked to start the RPC. |
| WORD WRAP ON (#.08) | No | Affects GLOBAL ARRAY and WORD PROCESSING return value types only. If set to False, all data values are returned in a single concatenated string in Results[0]. If set to True, each array node on the M side is returned as a distinct array item in Results. |
| RETURN VALUE TYPE (#.04) | Yes | This can be one of five types: SINGLE VALUE, ARRAY, WORD PROCESSING, GLOBAL ARRAY, GLOBAL INSTANCE. This setting controls how the Broker processes an RPC's return parameter. |
