The Master Data Model for Veteran Care

Developer Documentation » MVDM » Remote_Procedure

Remote_Procedure

Remote Procedure

This file is used as a repository of server-based procedures in the context of the Client/Server architecture. By using the Remote Procedure Call (RPC) Broker, applications running on client workstations can invoke (call) the procedures in this file to be executed by the server and the results will be returned to the client application.

Each remote procedure entry is associated with an entry point (ROUTINE with optional TAG). Calls to these procedures can include parameters of different value types. The resulting value of the call can be either a string, a list of strings or a word processing string as indicated by the RETURN VALUE TYPE field (.04).

The remote procedure may be available for use by anyone or its use may be restricted to one or more application. The range of availability is indicated by the AVAILABILITY field. IF THERE IS NO ENTRY IN THE AVAILABILITY FIELD, then the procedure is assumed to be PUBLIC.

A remote procedure may be removed from service for a period of time by setting the INACTIVE field. A request for use of a procedure which is marked inactive will result in an error being returned to the originating application.

Fileman ID: 8994

Base VDM Class: Remote_Procedure-8994

Property Summary

Property Count: 14

Type Count
STRING 5
ENUMERATION 4
BOOLEAN 3
NUMERIC 1
OBJECT 1

Sub-Object Count: 1

ID Label Field ID
1 Input Parameter inputParameter

↑ Return to top

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Name
  name
STRING name   INDEXED
REQUIRED
 
Tag
  tag
STRING tag      
Routine
  routine
STRING routine   REQUIRED  
Return Value Type
  returnValueType
ENUMERATION return_value_type   REQUIRED 0: GLOBAL INSTANCE
1: ARRAY
2: SINGLE VALUE
3: GLOBAL ARRAY
4: WORD PROCESSING
Availability
  availability
ENUMERATION availability     0: RESTRICTED
1: AGREEMENT
2: PUBLIC
3: SUBSCRIPTION
Inactive
  inactive
ENUMERATION inactive     0: ACTIVE
1: REMOTE INACTIVE (ACTIVE LOCALLY)
2: INACTIVE
3: LOCAL INACTIVE (ACTIVE REMOTELY)
Client Manager
  clientManager
BOOLEAN client_manager      
Word Wrap On
  wordWrapOn
ENUMERATION word_wrap_on     0: TRUE
1: FALSE
Version
  version
NUMERIC version      
Suppress Rdv User Setup
  suppressRdvUserSetup
BOOLEAN suppress_rdv_user_setup      
App Proxy Allowed
  appProxyAllowed
BOOLEAN app_proxy_allowed      
Description
  description
STRING description      
Input Parameter
  inputParameter
OBJECT input_parameter     inputParameter
Return Parameter Description
  returnParameterDescription
STRING return_parameter_description      

↑ Return to top

Sub-Objects

1. Input Parameter

Field ID: inputParameter

Properties

Label/Field ID Datatype FromVDM Default Attributes Range
Input Parameter
  inputParameter
STRING input_parameter   INDEXED
REQUIRED
 
Parameter Type
  parameterType
ENUMERATION parameter_type     0: LITERAL
1: LIST
2: REFERENCE
3: WORD PROCESSING
Maximum Data Length
  maximumDataLength
NUMERIC maximum_data_length      
Required
  required
BOOLEAN required      
Sequence Number
  sequenceNumber
NUMERIC sequence_number   INDEXED  
Description
  description
STRING description      

↑ Return to top


Document generated on August 31st 2017, 2:55:48 pm