Skip to content

MVsharp Quick Start Guide

How to manage your MVsharp environment with most common functions and features.

Contents

1 Introduction

2 Pre Requisites

3 Creating new Accounts

4 Creating Files

4.1 Structure of a VOC File Pointer

4.2 Creating SQL Server Files and Directories

4.3 Q Pointers and Remote Files

5 Compiling basic programs

6 Configuring MVsharp Options

7 Executing windows commands

8 Accessing Printers

8.1 LISTPTR

8.2 SETPTR

Introduction

This guide describes the most commonly used features of the MVsharp toolset that are used to build/manage applications on MVsharp. The guide covers the following areas:

  1. Creating new Accounts.

  2. Creating the various types of files on the Data Stores supported by MVsharp.

  3. Creating index's.

  4. Managing users.

  5. Backing up and Restoring SQL Server.

Pre Requisites

The following environment is required in order to use MVsharp:

  1. MVsharp Installed.

Creating New Accounts

The concept of different accounts is supported by MVsharp. Each account is a self contained environment that has it's own VOC, File Pointers and programs.

Each MVsharp account consists of 2 parts:

  1. A database in SQL Server. Initially this will only contain the VOC, ERRMSG and DICT.DICT files and it's dictionary.

  2. A directory containing the Account.xml setup and all Directory files including system directory files like &HOLD&, &PH& and &SAVEDLISTS&

The CREATE.ACCOUNT command will create a new Account. The syntax is:

CREATE.ACCOUNT {AccountName}

In the example below we are going to create an Account called DEMO

>CREATE.ACCOUNT DEMO

Account Name :DEMO

Sql Server Instance :localhost

User Id :sa

Password :MVsharp

MVsharp Path (C:\MVsharp Accounts):

Updating Compiler Verbs

Updating Internal Verbs

Updating Database Verbs

Updating External Verbs

Updating Dictionary of VOC

Updating VOC

Executing Statements

Creating object directory 'MVsharp.BP.Lib'

Compiling ED

ED Compiled


Compiling INIT.MS.FILES

INIT.MS.FILES Compiled


ED Cataloged

INIT.MS.FILES Cataloged

Updating Compiler Verbs

Updating Internal Verbs

Updating Database Verbs

Updating External Verbs

Updating Dictionary of VOC

Updating VOC

Executing Statements

AE Cataloged

Initializing ERRMSG...

Creating Dictionary File D_ERRMSG

Creating File _ERRMSG

Updating DICT.DICT...

Creating File _DICT_DICT

Updating Sql Extensions

Updating Sql Extensions

Successfully deployed Sql Extensions on DEMO

Account "DEMO" Created

The new account is created and ready for use.

Creating Files

MVsharp supports a variety of file types and database storage engines all with the same account. The following is a list of supported files types and storage engines.

|Hashed | This is a hashed files similar to other MV systems hashed files. They do not support transaction processing and are created on the file system in the Accounts directory.| |SqlArray | Data is stored in SQL Server as a key value pair. The dynamic normalisation engine that MVsharp injects in SQL Server allows SQL to select and sort on these files. This is the preferred file type for SQL Server.| |SqlServer | Data is stored in SQL Server as a key xml pair. Your MVsharp application will however still receive a key record when accessing them from a MVsharp application.| |SqlNative | Data is stored in SQL Server as fully normalised SQL tables. The BASIC language has been enhanced to allow you to use the same BASIC syntax to select, read and write these normalised tables.| |Directory | Data is stored as files in a directory. (BP files are required to be in this format).| |MongoDB | Data is stored as a key list pair on a MongoDB Server. They behave exactly the same as SqlArray files except the stored engine is MongoDB. It also supports indexing.| |Universe/Unidata | Data is stored in a Universe/Unidata database but can be accessed as if they are local files to your MVsharp account.|

The syntax for creating files is:

CREATE.FILE {FileName}

CREATE.FILE {FileName} Type={FileType}

CREATE.FILE {FileName} Type={FileType} ON {AccountName}

Structure of a VOC File Pointer

A VOC entry is created for each file in an Account. The structure of the VOC pointer is as follows:

>CT VOC CUSTOMER

CUSTOMER

0001 File

0002 _CUSTOMER

0003 D__CUSTOMER

0004 SqlServer

0005 {Account} <- only used for MongoDB, SqlNative, Universe, Unidata, QM and jBASE

Description:

  1. Must contain 'F' or 'File'

  2. The name of the Data Portion of the file

  3. The name of the Dictionary portion of the file

  4. The type of file

  5. The account name where the file resides

Creating SQL Server Files and Directories

To create the default SQLARRAY type SQL Server files you use:

CREATE.FILE CUSTOMER <- this will default to SQLARRAY

or

CREATE.FILE CUSTOMER Type=SqlArray

 

To create directory type files:

CREATE.FILE BP Type=Directory

This will create a directory in your current account as well as a Hashed file D_BP that will be used as the dictionary portion.

Q Pointers and Remote Files

MVsharp supports two different methods for accessing files in other accounts. The first method is to use standard Q pointers to create VOC entries that point to files in other accounts. Q pointers have always been dangerous as anyone with a little knowledge can access sensitive data by simply create a VOC entry to get financial or payroll data.

To overcome this security issue, MVsharp only allows access to data in other accounts if the account has been "Linked" to the source account. This is done in the administrator tool. Once the account has been linked, you can create normal Q pointers.

To see what accounts have been linked to your account, use the LINKED.ACCOUNTS function

Account Name        Account Type    Database Name Path

NetbuilderPlusLD    MVsharp        CRP c:\\MVsharp Accounts/NetbuilderPlusLD

ADSV16-EXEC         MVsharp        CRP C:\\MVsharp Accounts/ADSV16-EXEC

CRP                 MVsharp        CRP C:\\MVsharp Accounts/CRP

>

A Q Pointers is created like this:


>CT VOC PARAMS

PARAMS

0001 Q

0002 ADSV16-EXEC

0003 PARAMS

>

The second method is helpful when you wish to split the dictionary and data portions between 2 SQL Server databases. The format for Remote Pointers is:

>CT VOC CUSTOMER

   CUSTOMER

0001 F

0002 [CRP-DATA].[dbo].[_CUSTOMER]

0003 [CRP-DATA].[dbo].[D__CUSTOMER]

0004 SqlServer

The format is always:

[SQL Database].[dbo].[SQL FileName]

These are less secure as no account linking is required.

Compiling BASIC Programs

BASIC programs are transpiled into C# code and then compiled into a .Net dll. The dll's are stored in a Directory file with the same name as your program file with a .Lib suffix.

BASIC programs must be stored in a Directory file .

The syntax for compiling BASIC programs is:

BASIC {ProgramFile} {ProgramName} ({Options}

BASIC {ProgramFile} * ({Options}

BASIC {ProgramFile} ({Options <- Used when there is an active selectlist

 

Options Description
D Generate a dll that has debug and the symbol table. If this option is not specified, you will not be able to break into a program and all DEBUG statements are ignored.
G By default, the C# code is transient and is discarded once the dll has been generated. When the G option is specified, the C# code is written to a src directory in the .Lib folder.
L Used in conjunction with G option above. When the L option is specified, the C# source is written into the same file as the BASIC source code.
N Include lines numbers in the object.

Configuring MVsharp Options

MVsharp can emulate various 'Pick' flavours and these are configured in the MVSHARP.CONFIG record in the VOC file. Each configuration option is specified as a separate attribute.

The following options can be set:

Options Description
ENCODING={Encoding} This allows you to specify the encoding your wish strings to be encoded in your BASIC programs.
VSCODEDEBUG When specified, the debugger will attempt to connect to the Visual Studio Code MV# Debugger.
DATE.EUROPE When specified, the date is displayed in European Format: dd/MM/yyyy.
SHOW.TRACE When specified, the stack trace is displayed as programs are executed. This is useful for debugging batch processes but has no value in interactive processes.
INFORMATION.MODE When specified, the runtime environment emulates a PRIME INFORMATION mode.
PICK.MODE When specified, the runtime environment emulates a PICK mode.
COUNT.SUP When this option is specified all SELECT statement will be executed as asynchronous SQL queries. Records can be processed while the query is being executed. NOTE @SELECTED is not updated.
COLLATION={collation} Set the SQL Server Collation to be used when creating new files and when processing queries.
PICK.TCL Emulate the D3 TCL environment with a ':' prompt and '>' for active select list. D3 update processor commands also work on the TCL prompt.
UNIDATAEXEC The BASIC EXECUTE command behaves like Unidata including the ability to execute OS command with the "!" at the prompt.
D3.MODE The compiler emulates the D3 compiler, includes case insensitivity etc.
LOGTCL Every command executed from the command line is logged in the &LOGS& file.

Executing Windows Commands

Any Windows commands can be executed with 'DOS' command from the MVsharp command line. The DOS command creates a Windows command line shell, executes the arguments passed and returns to MVsharp command line.

This is useful when executing DOS functions to copy files, run DOS executables or get you environmental variables.

Example:


>DOS /c SET

PATHEXT=.COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC

PROCESSOR_ARCHITECTURE=x86

PROCESSOR_ARCHITEW6432=AMD64

PROCESSOR_IDENTIFIER=Intel64 Family 6 Model 44 Stepping 2, GenuineIntel

PROCESSOR_LEVEL=6

PROCESSOR_REVISION=2c02

ProgramData=C:\ProgramData

ProgramFiles=C:\Program Files (x86)

ProgramFiles(x86)=C:\Program Files (x86)

ProgramW6432=C:\Program Files

PROMPT=$P$G

PSModulePath=C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules\

PUBLIC=C:\Users\Public

RemoteIpAddress=169.254.107.162

SystemDrive=C:

SystemRoot=C:\WINDOWS

TEMP=C:\WINDOWS\TEMP

TMP=C:\WINDOWS\TEMP

USERDOMAIN=ONGROUP

USERNAME=MVsharpSHARP-1$

 

Windows commands can also be executed from a BASIC program using the EXECTE function in BASIC.

Example:

Command = "copy c:\temp\file.txt e:\process.txt"

EXECUTE Command Capturing Output

CRT Output

Accessing Printers

MVsharp does not have it's own spooler. It utilizes the Windows Spooler, removing the complexity of managing 2 different spoolers. The following commands can be used to managing your print spooling.

All Windows Spooler functionality can be used with MVsharp including local printers, remote printers, UNC printers etc.

LISTPTR

The LISTPTR command will display a list of all the printers defined on your system.

>LISTPTR

Printer..............................Port.......................... Status..

microsoft xps document writer        PORTPROMPT:                    Running

microsoft print to pdf               PORTPROMPT:                    Running

fax                                  SHRFAX:                        Running

SETPTR

The SETPTR command either displays the current printers definitions or sets the printer definition you would like to use.


>SETPTR 1

Unit No : 1

Page Width : 132

Page Depth : 66

Top Margin : 3

Bottom Margin : 3

Print Mode : 1

Default Job Name : MVsharp

Destination Printer :

 

The format of the SETPTR is:

SETPTR unit {, width, depth, topmargin, bottommargin, mode, options}

 

Options Description
unit The printer unit from 0 to 10. Unit 0 is the default printer. Units 1 through 10 can be accessed by using the PRINT ON unit in BASIC.
width The page width.
depth The page depth.
topmargin No of lines to skip at the top of each page.
bottommargin No of lines to skip at the bottom of each page.
mode Defines where the output is directed.
1 -- output id to the printer device
3 -- output is to a hold file
options Additional options separated by comma's as defined below.
Additional Options Description
AT printername Direct output to specified printer.
AS filename Used with mode 3 to specify the name of the hold file.
AS NEXT id Used with mode 3 to specify an incremental starting number for subsequent hold file prints.
BRIEF Does not prompt you as to whether you wish to set the printer options.

Copyright © 2018 Prosol Group

All rights reserved.

Prosol Group make no representations that the use of its products in the manner described in this publication will not infringe on existing or future patent rights, nor do the descriptions contained in this publication imply the granting of licenses to make, use, or sell equipment or software in accordance with the description.

Possession, use, or copying of the software described in this publication is authorized only pursuant to a valid written license from Prosol Group or an authorised sub licensor.

Neither Prosol Group nor its employees are responsible for any errors that may appear in this publication. The information in this publication is subject to change without notice.

All other trademarks and service marks are property of their respective holders.