OpenInsight Documentation

https://wiki.srpcs.com/
Admin
OpenInsight is an application development platform that enables developers to build business...
Tokens:1,610,260
Snippets:25,471
Trust Score:8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Registry Key Values Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3346048

Example demonstrating how to retrieve a list of values for a registry key and check for errors. Use this when you need to fetch all values associated with a specific key.

```script
 * Get a key's list of values
List = SRP_Registry("LISTVALUES", "HKCU\Software\MyApp", "", "", Error) EQ 0 then
If List EQ "" AND Error NE "" then
   Msg(@Window, "LISTVALUES Error: ":Error:@FM:@FM:@FM:4)
end
```

--------------------------------

### Basic NSIS Installer Script

Source: https://wiki.srpcs.com/display/WhitePapers/Deploying%2BOpenInsight%2BApplications%2Busing%2BNSIS

This script creates a simple installer that names the installer, defines the installation directory to the desktop, and installs a single file 'c:\test.txt' to the installation directory.

```nsis
# Name the installer
OutFile "MyInstaller.exe"
# Define the directory to install to using one of the predefined constants
InstallDir $DESKTOP
# Every NSIS script has at least one section.
Section
    # Define the output path for this file
    SetOutPath $INSTDIR
    # Define what to install and place it in the output path
    File "c:\test.txt"
SectionEnd
```

--------------------------------

### Basic+ Example: OLE Operations with VSPrinter and VSPDF

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342858

This example demonstrates a comprehensive workflow involving OLE objects for printing and PDF creation. It shows how to create OLE instances, get and set properties, call methods, and crucially, how to check the status after each OLE operation using OleStatus. Ensure OleCreateInstance is called before using other OLE functions.

```Basic+
subroutine Test_OLE_Basic_PDF(void)
declare subroutine OlePutProperty, Msg
declare function OleCreateInstance, OleGetProperty, OleCallMethod, OleStatus

// Create the Ole Object for VSPrinter

oleObj = OleCreateInstance('VSPRINTER7.VSPRINTER.1')
status = OleStatus()
if status then
  msg(@window,'OLE Error code: ':status)
  return
end

// Get the AbortCaption property of the VSPrinter Print window

property1 = OleGetProperty(oleObj, 'AbortCaption')
status = OleStatus()
if status then
  msg(@window,'OLE Error code: ':status)
end

// Change the AbortCaption property of the VSPrinter Print window

OlePutProperty(oleObj, 'AbortCaption', 'Testing...')
status = OleStatus()
if status then
  msg(@window,'OLE Error code: ':status)
end

// Get the AbortCaption property of the VSPrinter Print window after it has been changed

property2 = OleGetProperty(oleObj, 'AbortCaption')
status = OleStatus()
if status then
  msg(@window,'OLE Error code: ':status)
end

// Calls the STARTDOC method of the ole object to begin printing the document.

ReturnValue = OleCallMethod(oleObj, "STARTDOC")
status = OleStatus()
if status then
 msg(@window,'OLE Error code: ':status)
end

// Create the text to print

text = "OpenInsight is the only database development and application environment that provides both Windows, "
text: = "Linux and Java-based GUI tools to develop and deploy web-based and client server applications that "
text: = "support native XML, SQL, Lotus Notes. There are 1.6 mm licenses of Revelation products across 80k "
text: = "deployed sites worldwide."

// Print the text

OlePutProperty(oleObj,"TEXT",text)
status = OleStatus()
if status then
  msg(@window,'OLE Error code: ':status)
end

// End the print job

ReturnValue = OleCallMethod(oleObj, "ENDDOC")
status = OleStatus()
if OleStatus() then
  msg(@window,'OLE Error code: ':status)
end

// Save the text to a temp file for use in the VSPDF OLE object

returnValue = OleCallMethod(oleObj,"SAVEDOC","pdftemp.txt")
status = OleStatus()
if OleStatus() then
  msg(@window,'OLE Error code: ':status)
end

// Start the VSPDF OLE object to create the pdf file

oleObj2 = OleCreateInstance('VSPDF.VSPDF.1')
status = OleStatus()
if OleStatus() then
  msg(@window,'OLE Error code: ':status)
  return
end

// Create the PDF file

returnvalue = OleCallMethod(oleObj2,"convertfile","pdftemp.txt","C:\\temp\\new_ole_func.pdf")
status = OleStatus()
if OleStatus() then
  msg(@window,'OLE Error code: ':status)
end
return
```

--------------------------------

### Initialize Printer for Report

Source: https://wiki.srpcs.com/display/Commands/Set%2BPrinter%2BINIT

Use the INIT message to start a print job. This example configures the report title, orientation, margins, and reads window size from OIPI.INI. The report will be printed in landscape orientation with 0.5 inch margins.

```Revelation BASIC
/* The following example shows how to use the INIT message to print a report to the Print Preview window. The report will be printed in landscape orientation with 0.5 inch margins. The size and position of the Print Preview window will be read from the OIPI.INI file. */
declare function Set_Printer
title = "Test":@FM:@FM
title := "Cancel Button"
title := "on the %s on %s":@FM
title := "Now Printing Page %d of Report":@FM
stat = Set_Printer("INIT", "Report 1", title, "", 1, 4)
stat = Set_Printer("TEXT", "Test 1 2 3")
stat = Set_Printer("TERM") ;* End printing
```

--------------------------------

### SRP_Get_Fonts

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=2098750

Gets the fonts installed on the machine.

```APIDOC
## SRP_Get_Fonts

### Description
Gets the fonts installed on the machine.

### Method
Not specified (assumed to be a function call within the SRP Utilities library)

### Endpoint
Not applicable (this is a library function, not an HTTP endpoint)

### Parameters
Not specified in the source text.

### Request Example
Not specified in the source text.

### Response
Not specified in the source text.

### Version Introduced
2.1.10
```

--------------------------------

### Execute Script Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342977

This example demonstrates how to execute a script and retrieve results using QryMethod. It includes error handling and resource cleanup.

```Unspecified
* example for QryMethod:
function ExecuteScript(Script)
$insert XO_Equates
* returns @rm/@fm delimited results
Results = ""
* create connection (this could take params if you wanted,
* but calling it with no params lets the user choose what
* connection, etc.  this is how the query window calls it:
hXO  = XOInstance()
hQry = 0
if hXO then
   * create the query handle for the connection handle
   hQry = QryInstance(hXO)
   if hQry then
      * execute a script
      Flag = QryMethod(hQry, QRY_EXECUTE$, Script)
      if Flag then
         /* retrieve results and stick them in an @rm
            delimited array */
         loop
            Flag = QryMethod(hQry, QRY_GETROW$, Row)
         while Flag
            Results := @rm: Row
         repeat
         Results [1,1] = ""
         * cancel script
         Flag = QryMethod(hQry, QRY_CANCEL$)
      end else
         gosub error
      end
      * close the query handle
      Flag = QryMethod(hQry, QRY_DESTROY$)
   end else
      gosub error
   end
  * close the connection
  Flag = XOMethod(hXO, XO_DESTROY$)
end else
   gosub error
end
return Results
* Error handling
Error:
   if hQry then
      Flag = QryMethod(hQry, QRY_GETERROR$, "", "", "",|
                       "",Text)
   end else
      Flag = XOMethod(hXO, QRY_GETERROR$, "", "", "", |
                     "",Text)
   end
   convert @vm to @tm in Text
   Def = ""
   Def<MTEXT$>    = Text
   Def<MCAPTION$> = "ExecuteScript Error"
   Def<MICON$>    = "!"
   Msg(@window, Text)
   Results = ""
return
```

--------------------------------

### File Selection Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=1540965

Demonstrates how to specify a list of files and folders to be backed up, including wildcards and relative paths. Use @FM as a delimiter.

```script
Files = "*.ocx":@FM:"?DATAVOL":@FM:"OI*.*":@FM:"ProgRef.chm"
```

--------------------------------

### Btree Search String Examples

Source: https://wiki.srpcs.com/display/Commands/Btree.Extract%2BSubroutine

Examples demonstrating how to construct search strings for 'starting with', 'ending with', and 'containing' operations in Btree.

```BtreeScript
srch_strng = "CITY":@VM:"S]":@FM
```

```BtreeScript
srch_strng = "CITY":@VM:"[P":@FM
```

```BtreeScript
srch_strng = "CITY":@VM:"[P]":@FM
```

--------------------------------

### Get Array Element by Index

Source: https://wiki.srpcs.com/display/SRPUtilities/Paths

Retrieve an element from an array by specifying its index within square or angle brackets. This example gets the 12th item from the 'items' array.

```csharp
Result = SRP_JsonX_Get("menu.items[12]")
```

--------------------------------

### CreateQueue and CreateEngine Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=2491715

Demonstrates creating an engine and then a queue on that engine. Ensure the engine handle is valid before calling CreateQueue.

```csharp
// Create a queue on an engine created by CreateEngine in the SYSPROG account.

Error = CreateEngine(Engine, "\\.\\REVCAPI_TEST",  "SYSPROG",CREATE_ENGINE_OPEN_ALWAYS$,  1)
Error = CreateQueue(Queue, Engine, "", "", "SYSPROG")
```

--------------------------------

### Execute RDKINSTALL with runCommand

Source: https://wiki.srpcs.com/display/WhitePapers/Deploying%2BOpenInsight%2BApplications%2Busing%2BNSIS

Use this snippet within an InstFiles page's Leave event to execute RDKINSTALL. Ensure `startOI` was called previously and always use the `/NOUNLOAD` flag. This method routes OI messages to the InstFiles window and updates the progress bar.

```nsis
Function InstallLeave
    ; Execute RDKINSTALL, we don't need to call startOI because we did that during the
    ; Application Login Page's leave event. Note that runCommand will route messages form
    ; OI to the InstFiles page window... it even updates the progress bar!
    SetOutPath $INSTDIR
    srputil::runCommand /NOUNLOAD 'RUN RDKINSTALL "$INSTDIR\SRPRDKINSTALL"'
    srputil::shutdownOI
    ; remove the temporary rdk install folder
    RMDir /r $INSTDIR\SRPRDKINSTALL
FunctionEnd
```

--------------------------------

### Indexc Function Example - Finding Substring

Source: https://wiki.srpcs.com/display/Commands/Indexc%2BFunction

Assigns the starting position of the first occurrence of a substring to a variable. The search is case-insensitive.

```BASIC+
FIRST = Indexc("ABracAdabrA", "caD", 1)
```

--------------------------------

### Example: Backup all files

Source: https://wiki.srpcs.com/display/BackupUtility

A simple example to back up all application files to 'Backup.zip' using the SRP Launcher INI file.

```SRP_Backup
SRP_Backup("Backup.zip", "SRP Launcher.INI")
```

--------------------------------

### HTTP Headers Returned by Inet_Trace

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342598

This is an example of the HTTP headers returned when OECGI.EXE is properly installed and Inet_Trace is executed. It provides debugging information.

```HTTP
CONTENT_LENGTH = 0
CONTENT_TYPE = 
GATEWAY_INTERFACE = CGI/1.1
Https = off
HTTP_ACCEPT = image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, */*
HTTP_COOKIE = 
HTTP_FROM = 
HTTP_REFERER = 
HTTP_USER_AGENT = Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
PATH_INFO = /INET_TRACE
PATH_TRANSLATED = C:\Inetpub\wwwroot\INET_TRACE
QUERY_STRING = FOO=BAR
REMOTE_ADDR = 127.0.0.1
REMOTE_HOST = 127.0.0.1
REMOTE_IDENT = 
REMOTE_USER = 
REQUEST_METHOD = GET
SCRIPT_NAME = /cgi-bin/oecgi.exe
SERVER_NAME = 127.0.0.1
SERVER_PORT = 80
SERVER_PROTOCOL = HTTP/1.1
SERVER_SOFTWARE = Microsoft-IIS/5.1
SERVER_URL = 

```

--------------------------------

### On...GoTo Statement Syntax Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342867

Demonstrates the syntax for the On...GoTo statement, separating labels with commas.

```BASIC
On T GoTo Debit, Credit, Update
```

--------------------------------

### Define Database Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=2491743

This example shows how to define a database using the Define_Database subroutine. Ensure the last two parameters are passed as null. It also includes basic error checking using Get_Status.

```script
* The last two parameters should be passed as null.
declare subroutine Set_Status, Define_Database
declare function Get_Status
$insert Logical
Set_Status(FALSE$)
Define_Database(@dbid, TRUE$, "", "")
if Get_Status(Error) then
Set_Status(FALSE$)
* handle the error here
end

```

--------------------------------

### Get Nested Object Member

Source: https://wiki.srpcs.com/display/SRPUtilities/Paths

Access members of a sub-object by separating member names with a period. This example retrieves the 'items' array from the 'menu' object.

```csharp
Result = SRP_JsonX_Get("menu.items")
```

--------------------------------

### On...GoSub Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342864

Demonstrates how to use the On...GoSub statement to branch to different subroutines based on a calculated position. Ensure the 'index' parameter is within the bounds of the provided labels.

```BASIC
labels = "LABEL1,LABEL2,LABEL3,LABEL4"
locate input_parm in labels Using "," Setting POS then
  On Pos GoSub LABEL1, LABEL2, LABEL3, LABEL4
end
return
 
LABEL1:
* Code of some type
Return
LABEL2:
* Code of some type
Return
LABEL3:
* Code of some type
Return
LABEL4:
* Code of some type
Return
```

--------------------------------

### Get Entire Menu Object

Source: https://wiki.srpcs.com/display/SRPUtilities/Paths

Use a simple path to retrieve the entire 'menu' object from the JSON. This is the starting point for navigating the data structure.

```csharp
Result = SRP_JsonX_Get("menu")
```

--------------------------------

### Create Volume Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=2491695

Demonstrates how to create a new volume named 'My_Vol' and specifies its data and control file locations. Includes error checking using Get_Status().

```subroutine
declare subroutine create_volume, fsmsg
declare function get_status
/* 
create volume named My_Vol in C:\Datafolder, storing linear hash files. 
*/
create_volume("MY_VOL","RTP57",'C:\Datafolder','','')
if get_status(errcode) then
  fsmsg()
  return 1
end
```

--------------------------------

### Example of OLE Object Interaction with VSPrinter and VSPDF

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342843

This example demonstrates creating OLE objects, getting and setting properties, calling methods like STARTDOC and ENDDOC, and converting a text file to PDF using VSPDF. Ensure OLE objects are created before calling methods.

```Basic+
subroutine Test_OLE_Basic_PDF(void)
declare subroutine OlePutProperty, Msg
declare function OleCreateInstance, OleGetProperty, OleCallMethod, OleStatus
 
// Create the Ole Object for VSPrinter
 
oleObj = OleCreateInstance('VSPRINTER7.VSPRINTER.1')
status = OleStatus()
if status then
   msg(@window,'OLE Error code: ':status)
   return
end
 
// Get the AbortCaption property of the VSPrinter Print window
 
property1 = OleGetProperty(oleObj, 'AbortCaption')
status = OleStatus()
if status then
   msg(@window,'OLE Error code: ':status)
end
 
// Change the AbortCaption property of the VSPrinter Print window
 
OlePutProperty(oleObj, 'AbortCaption', 'Testing...')
status = OleStatus()
if status then
   msg(@window,'OLE Error code: ':status)
end
 
// Get the AbortCaption property of the VSPrinter Print window after it has been changed
 
property2 = OleGetProperty(oleObj, 'AbortCaption')
status = OleStatus()
if status then
   msg(@window,'OLE Error code: ':status)
end
 
// Calls the STARTDOC method of the ole object to begin printing the document.
 
ReturnValue = OleCallMethod(oleObj, "STARTDOC")
status = OleStatus()
if status then
  msg(@window,'OLE Error code: ':status)
end
 
// Create the text to print
 
text  = "OpenInsight is the only database development and application environment that provides both Windows, "
text: = "Linux and Java-based GUI tools to develop and deploy web-based and client server applications that "
text: = "support native XML, SQL, Lotus Notes. There are 1.6 mm licenses of Revelation products across 80k "
text: = "deployed sites worldwide."
 
// Print the text
 
OlePutProperty(oleObj,"TEXT",text)
status = OleStatus()
if status then
   msg(@window,'OLE Error code: ':status)
end
 
// End the print job
 
ReturnValue = OleCallMethod(oleObj, "ENDDOC")
status = OleStatus()
if OleStatus() then
   msg(@window,'OLE Error code: ':status)
end
 
// Save the text to a temp file for use in the VSPDF OLE object
 
returnValue = OleCallMethod(oleObj,"SAVEDOC","pdftemp.txt")
status = OleStatus()
if OleStatus() then
   msg(@window,'OLE Error code: ':status)
end
 
// Start the VSPDF OLE object to create the pdf file
 
oleObj2 = OleCreateInstance('VSPDF.VSPDF.1')
status = OleStatus()
if OleStatus() then
   msg(@window,'OLE Error code: ':status)
   return
end
 
// Create the PDF file
 
returnvalue = OleCallMethod(oleObj2,"convertfile","pdftemp.txt","C:\\temp\\new_ole_func.pdf")
status = OleStatus()
if OleStatus() then
   msg(@window,'OLE Error code: ':status)
end
return

```

--------------------------------

### Get Current Event Name

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=2491950

Call this function to retrieve the name of the current event. It does not accept any parameters. For example, if called during a 'CLICK' event, it will return 'CLICK'.

```script
/* On any event place the following code and the message will display the event.
For example if on the CLICK of a button you were to call the function, it would return "CLICK".
*/
declare function Get_Current_Event
thisEvent = Get_Current_Event()
```

--------------------------------

### Example Usage of Make.List Subroutine

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=3342686

Demonstrates how to use the Make.List subroutine to create a select list of customer keys. It includes file opening, error handling, and saving the generated list.

```Rocket U2 BASIC
subroutine make_list_example(parent)

Declare Function Unassigned, Get_Status, Get_Property
Declare Subroutine Msg, MAKE.LIST, fsmsg, Set_Status, Save_Select

$Insert Logical
$Insert Msg_Equates

* Initialize Variables
errCodes = ""
errFlag = ""

* Determine Parent Window
If Unassigned(parent) Then parent = @Window
frame = Get_Property(parent,"MDIFRAME")
If frame Then parent = frame

* Open Files
Open "CUSTOMER" To f_customers Then
  Open "DICT.CUSTOMERS" To d_customers Else
    errText = "Unable to open the Customers Dictionary file."
    errFlag = TRUE$
  End
End Else
  errText = "Unable to open Customers file."
  errFlag = TRUE$
End

If errFlag Else

  * A List of Customer keys
  custList = "1" : @vm : "2" : @vm : "22" : @vm : "26"

  * Create the List in Cursor 0 and if successful save the list
  Set_Status(0)
  MAKE.LIST(0, custList, f_customers, d_customers)
  If Get_Status(errCodes) Then
    FSMsg(errCodes)
  End Else
    Set_Status(0)
    Save_Select("","MAKE_LIST_TEST","","")
    If Get_Status(errCodes) then
      FSMsg(errCodes)
    end
  End
End

if errFlag Then
  msgStruct = ""
  msgStruct<MCAPTION$> = "Error"
  msgStruct<MICON$> = "H"
  msgStruct<MTEXT$> = errText : |Error Code: | : @file.error<1>
  Msg(Parent,msgStruct)
end

return

```

--------------------------------

### Register SRPControls.ocx Example

Source: https://wiki.srpcs.com/pages/diffpagesbyversion.action?pageId=1540597&selectedPageVersions=6&selectedPageVersions=5

Example of registering the SRPControls.ocx file. This command assumes the file is in the specified directory.

```bash
"C:\Revsoft\OICLient\SRPControls.ocx"
```

--------------------------------

### Get Specific File Attribute (Size)

Source: https://wiki.srpcs.com/display/Commands/RTI%2BOS%2BDirectory%2Bfunction%2BGetAttributes

This example demonstrates how to retrieve a single, specific attribute, such as the file size. The desired attribute is passed as a string.

```RTI Script
declare function RTI_OS_Directory

// returns the size of the file requested
directory = "c:\\revsoft\\oinsight"
filename = "readme.pdf"
attributes = "size"
result = RTI_OS_Directory( "GetAttributes", directory, filename, attributes )
```

--------------------------------

### Single-line and Conditional Comments

Source: https://wiki.srpcs.com/display/LanguageReference/Comments

Single-line comments start with an exclamation mark and are ignored. The example also shows a conditional comment that affects program flow.

```Revelation BASIC
! data (shelf #, type, title, composer, artist)
```

```Revelation BASIC
/* All the elements of CUST (I) from 1 to the highest key are written to the output file. */
```

```Revelation BASIC
If C = " " Then Go 3 Else Go 5; * test for spaces
```

--------------------------------

### Basic SRP_Backup Example

Source: https://wiki.srpcs.com/plugins/viewsource/viewpagesrc.action?pageId=1540965

A simple example of the SRP_Backup function, backing up all application files to 'Backup.zip' and using the default SRP Launcher INI.

```script
* Backup everything
SRP_Backup("Backup.zip", "SRP Launcher.INI")
```

--------------------------------

### Indexc Function Example - Finding Specific Occurrence

Source: https://wiki.srpcs.com/display/Commands/Indexc%2BFunction

Finds the starting position of the third occurrence of a substring within a string. Returns 0 if the occurrence is not found.

```BASIC+
T = Indexc("XXA1YYa1ZZA1,", "A1,", 3)
```

--------------------------------

### Initialize A Set Example

Source: https://wiki.srpcs.com/display/Commands/RTI_Sets%2BFunction

Example demonstrating how to initialize a new set using the RTI_SETS function with the INIT_SET$ equate.

```APIDOC
## Initialize A Set
```
* Initialize a set
set_A = "1" : @vm  : "2" : @vm : "3"
handle_A = RTI_SETS( INIT_SET$, set_A, 0, @vm )
```
```

--------------------------------

### Get Maximum OpenInsight Users

Source: https://wiki.srpcs.com/display/Commands/MAX_OI_USERS%2BFunction

Call this function to retrieve the maximum number of concurrent users allowed for your OpenInsight installation. The result can be used for display or logging purposes.

```OpenInsight BASIC
declare function MAX_OI_USERS
numUsers = MAX_OI_USERS()
call msg(@window,'This copy of OpenInsight has a maximum of ': numUsers : ' users!')
```
Tokens:
Raw