PixieWare Software: PixieWeb Manual
Website Design and Data Extract Solutions

By Dave Johnstone



Index of PixieWeb Control Commands

This is a complete list of PixieWeb control commands and functions. These commands are categorised by their method of use.

  • Working through ASP or VB for screen-scraping
  • Working through ASP or VB to TCL/Access
  • Working through ASP or VB to special PixieWeb-style PICK program (FBF)
  • Working through ASP or VB to PX.BACKSRV

Commands When Using a VB or ASP Script to Connect to TCL

At start of the VB or ASP script, assign the object reference to a variable or property. (i.e. create an instance of a specific object). The Pixie object is created for communications with the Telnet server (PICK) and persists for the duration of a session. Each special Pixieweb Function is prefixed with the object reference (Pixie).

For example:
Dim Pixie
SetPixie = Server.CreateObject("PixieWMA.clsAgent")
Pixie.ExecuteCompareMethod = 1
Pixie.Port (23)

Commands Parameters Description
ExecuteCompareMethod 1 = Case insensitive Case testing of text reply sent from TCL.
Port nn Assigns TCP/IP port number.
Host nnn.nnn.nnn.nnn Assigns TCP/IP server address.
CommPort nn Serial port number.
InputBufferSize nnnn Some environments require an appropriate buffer size to be set otherwise output is truncated.
Settings nnnnn,N,n,n Serial modem settings.
TimeOut nn Sets the no. of seconds before timeout if no response from the Host.
Connect (AUTO = Auto connect) (TICKLE = Send a CR first) First contact with the host, using connection settings. May need to send a CR to wake up TCL environment.
State ERROR, PAGE, TCL, STARTUP Returns a string identifying status of the object.
ExecuteET ("string.sent", "expected.response") Sends text string to TCL and defines expected response if processed OK.
ExecuteRaw ("string.sent") Sends text string to TCL with no checking if processed OK.
ExecuteTX ("string.sent") Sends text string to TCL but expected response if processed OK is </TX>.
ExecutePM ("string.sent", "exp1,exp2,..") Sends text string to TCL but defines several expected responses if OK.
ExecutePS ("propertyname") A device to make future expansion smoother by letting us add properties without changing the external "COM Interface" structure. At present only one propertyname "PATH" is implemented, where PixieWMA.dll reports back what folder it is in. eg sPath = Pixie.ExecutePS("PATH") A typical returned value would be "C:\Program Files\PixieWeb\" .
ExecuteConnect ("string.sent", "expected.response") When using a modem for dial-ups you connect in 2 stages. Pixie.Connect gets you to the modem, then you need Pixie.ExecuteConnect for first contact with host when you dial the number.
LogBook (file.path.name, log.message) Updates a log of activities. Can be used to capture debugging data.

Commands When Using an ASP to Connect to PX.BACKSRV

Methods/Functions Parameters Description
ExecuteET ** ("string.sent", "expected.response") Sends text string to MV and defines expected response if processed OK.
ExecuteRaw ** ("string.sent") Sends text string to MV with no checking if processed OK.
ExecuteTX ** ("string.sent") Sends text string to MV but expected response if processed OK is </TX>.
ExecutePM ** ("string.sent", "exp1","exp2","..") Sends text string to MV but defines several expected responses if OK.
ExecuteTag ** ("string.sent", "stag", "etag") Sends text string to MV, but can define and remove start & end tags.
FileGetText (file.path.name) Get disk file contents as a string.
FileGetStream (file.path.name) Get disk file as an array of bytes.
LogBook (file.path.name, log.message) Updates a log of activities, e.g. Web site visitors.
Response **   Returns a string giving the complete MV response.
ResponseRaw **   Returns a string containing the "raw response" from MV.
ResponseCleanup **   Removes non-printing characters form Response.
RRead ** (item, filename, itemid) Reads MV file using record key provided - record not locked.
RReadU ** (item, filename, itemid) Reads MV file using record key provided - record locked.
RReadV **   Extracts specific attribute from retrieved MV record - record not locked.
PxRowSet ** (filename,fieldcnt,query,fieldlist,timeout) Returns results of a query sentence as a 2D array (SelectResult).
SelectResult ** (field,rec) Array built by PxRowSet and referenced by Field (col) and Rec (row).
Extract ** (row,col) Retrieves a specified cell from SelectResult
SelectUbound ** (1) =cols   (2)=rows Provides the number of columns or rows in SelectResult.
PxEscape ** (string_to_process [, quote_process_flag]) Use to process data before storing in an MV engine. The optional flag can be set to True to do additional escaping on the quotation marks.
PxDescape ** (raw_retrieved_string_from_MV) Use PxDescape to "unpack" or "decode" data previously processed with PxEscape.
Delete ** (filename,itemid) Delete a specified record from a MV file.
WWrite ** (item, filename, itemid) Writes record to MV file using key provided - record not locked.
WWriteU ** (item, filename, itemid) Writes record to MV file using key provided - record locked.
WWriteV ** (item, filename, itemid) Writes specific attribute into retrieved MV record - record not locked.
Release ** (filename, itemid) Releases (clears) locks from previous Reads or Writes.
ExecutePage ** ("string.sent","exp.resp","lines.per.page") Streams reponse from MV a page of data at a time. 
ContinuePage **   Streams next page of data from MV. Works with ExecutePage.
SegmentReplace ** (sTextOriginal, sFind, sReplace) Equivalent of the VB6 "Replace" for those on VB5, Word 97 and below.
Sleep (X) Idles the application for (x) seconds
Delay (X) same as Sleep, idles the application for (x) seconds
Index ** (sOriginalString, sSubString, sOccurrence) Returns the position in a string of the nth occurrence of a substring, e.g. n = Index(s, "*", 4)
Matches ** (refer appendix-1) Returns T or F depending on whether the string matches a format code.
Num ** (string) Returns T or F depending on whether argument in Numeric.
Dcount ** (refer appendix-1) Returns number of subsections in a string as defined by given delimiter.
Field ** (refer appendix-1) Returns a substring, given delimiter, and number.
Extract ** (refer appendix-1) Returns substrings of dynamic variables.
RReplace ** (refer appendix-1) Returns result of replacing a substring of a dynamic variable.
Delete ** (refer appendix-1) Returns result of deleting a substring from dynamic array.
Dylete ** (refer appendix-1) "Dynamic Array Delete" - Returns the result of deleting a substring from a dynamic array.
E.G. s = "111þ222þ333þ444" ; sDel = Pixie.Dylete(s, 3) ; 'Result: sDel = "111þ222þ444"
Insert ** (refer appendix-1) Returns result of Inserting a substring into dynamic variable.
Locate ** (refer appendix-1) Returns T or F depending if a substring is found in a string, or substring.
OConv ** (internal.string, process.code) Converts internal value to external equivalent (only: d, mr.., mc..).
IConv ** (external.string, process.code) Converts external value to internal equivalent (only: d, dj, mrI).
MVR ** (refer appendix-1) MV Read converting char(253) to char(13 ).
MVW ** (refer appendix-1) MV Write converting char(13 ) to char(253).
MVOConv ** (string, process.code) MV Read with processing code applied.
MVIConv ** (string, process.code) MV Write with processing code applied.
MVX2D ** (Attr1, Attr2) A derived parallel multivalued calculation. E.G. MVX2D(Price, Qty) where it may be used in the following manner: SELECT ORDERS.A0 ......, MVOconv([A9],"mr4") AS Qty, MVOconv([a10],"mr2") AS Price, MVX2D(Price, Qty) AS ExtPrice FROM ORDERS

Commands When Using an ASP to "Screen Scrape" The Output From Text-Based Programs

Commands Parameters Description
FormAnalyse   Used before ItemGet - tags text strings with associated (x,y) co-ords.
ItemTop nn Indicates where (y co-ord) on a terminal to start reading (screen scrape).
ItemLeft nn Indicates where (x co-ord) on a terminal to start reading (screen scrape).
FormItemGet   Loads a text string into Response based on nominated (x,y)  co-ord.
Response   Contains result of a previous function (eg FormItemGet).

When Using an ASP to Connect to a Re-Engineered Host Application Program

These commands (keywords) are coded into the formerly text generating program for an interactive on-the-fly communication session. We call this behavior - field-by-field (or FBF) communications. The user interface is only one web page which rewrites its internal contents as the application runs (i.e. repaint only those areas required). These commands control the web page rewrite process by affecting the entire page, or just the individual page elements (e.g. a field).

NOTE that a program must place a <TX> and </TX> to mark start and end of transmission from the back-server program. That is, it must wrap each of the following commands with the start/end signals.

Please also note that these exact same commands may be used to generate GUI screens with PixieLink.


Command syntax: Keyword|argument1\argument2\....

FBF  Commands Arguments Description

App.Shut Down

   
ERROR ERROR | error-message-text A host program TX that signals IE to immediately start emergency app. shut-down.
EXIT EXIT | DISCONNECT or  EXIT | (html code) A host program TX that will cause IE to shut-down app. normally.

DIV Control

IREPLACE IREPLACE | doc=html.code Replaces DIV contents.
INSERT INSERT | doc=html.code Appends to end of DIV contents.
DISPLAY DISPLAY | divtab=x (x=True or False) Makes DIV appear (True) or disappear (False).
Dialog Control 
MSGBOX (1) MSGBOX | message-text Sends message to IE but no confirmation signal returned to host program.
MSGBOX (2) MSGBOX | message-text\vbResponse Sends message to IE with confirmation response signal sent back to host program.
INPUTBOX INPUTBOX | dialog-box-message Host program generates free-form user input box for dialog (1 input only).
MODALBOX MODALBOX | html-code Host program generates free-form user input box with multiple selections.
STATUS STATUS | message-text Displays a message in the Windows status-bar.
STATUSCUSTOM STATUSCUSTOM | message-text Displays a message highlighted in yellow at the bottom of the screen.

Field Control

VALUE VALUE | fieldid=fieldvalue Assigns a value to specified field without cursor focus.
FOCUS FOCUS | fieldid=fieldvalue Assigns a value and cursor focus on specified field.
ENABLED ENABLED | fieldid=fieldvalue Allows specified field to be modified by a user and assign a value.
VALID VALID | fieldid=fieldvalue Same as VALUE but colours background of field and ENABLES.
REJECT REJECT | <current/previous>fieldid=fieldvalue Same as VALUE but colours field, focuses on field, with current/previous field assignment. 
READONLY READONLY | fieldid=fieldvalue Same effect as DISABLED.
DISABLED DISABLED | fieldid=fieldvalue Allows specified field to be unavailable to the user and assign a value. 

Grid Control

GROWNEW GROWNEW | gridid Generates a new grid row at end (bottom) of grid.
GROWDEL GROWDEL | rowid Deletes specified row from grid.
GROWINS GROWINS | rowid Inserts a new row into grid after specified row.

List Control

LIST LIST | val1\val2\val3\val4\val5 Generates a popup list box allowing user to select one option.
LISTM LISTM | val1\val2\val3\val4\val5 Generates a popup list box allowing user to select multiple options.

Cache Control

CACHE CACHE  Loads current page into cache. Host program must keep track of mult-page caching.
CACHERETRIEVE CACHERETRIEVE | n Retrieve page from cache and refresh current page. Removes from cache.
CACHERESET CACHERESET Clears cache and sets cache pointer to 0.
X,Y,W X | fieldid=xx Y | fieldid=yy W | fieldid=ww Alters the current field position (X/Y co-ords) or width.

Progress Window

PROGRESSBEGIN PROGRESSBEGIN | message-text Pops up a progress window and displays the entered text e.g. message-text = "Preparing Report". Use at the start of lengthy processes.
PROGRESS PROGRESS | message-text Use this command for each iteration of a LOOP. Message-text should include a counter e.g. " :J: " records, where J is the LOOP counter.
PROGRESSEND PROGRESSEND Closes the progress window. Use at the end of a lengthy process.



Discover Our Products and Services

Start I.T.

Web I.T.

Dig I.T.

Contract I.T.

Of I.T.

Grab I.T.

Designed and built by: Designed and built by PixieWare Software

Turn your WEB vision into reality!

Let us
provide
a website quote

Website Build Package
Creation of website (maximum 5 pages). Price: CDN$350 per website, $100 of fee due as an up-front downpayment, and $250 of fee due on project completion. Package does not include any additional external fees related to the project (e.g.):

  • Domain-name registration fee (annual fee)
  • Website hosting fee (monthly or annual fee)
  • Email-accounts processing fee (if relevant, a monthly or annual fee)
  • Any other fee related to domain name re-location or change of name server

Turn your WEB vision into reality!