dmf documentation

8/8/2019 DMF Documentation

http://slidepdf.com/reader/full/dmf-documentation 1/31

Web ToolkitDom a in Free Rem ote Files Guide

Version 4.3 © Information | Cap ital

Dec em b er 7, 2010



Web Too lkit Develop er Guide

Version 4.3

Definitions

Remote File A rem ote file is a Q -po inter to a file p hysic a lly loc a ted on a nothe r

system tha t is a c c essible b y the loc a l ac c ount. Unlike sta nda rd Q-po inter

VOC definitions, the first line in a d efinition for a rem ote file definition is RQ .

Node A nod e is the term fo r a rem ote system . A nod e is b ased on e ntries

loc a ted in the OS host’ s ta b le. Eac h no d e d efined rep resents anothe r systemto w hic h an a c c ount ca n ac c ess remo te files from a remo te a c c ount.

Rem ote File Perm ission s Eac h rem ote ac c ount, and in turn ea c h rem ote file, must b e set w ith

a c c ess permissions. These p ermissions c ontrol ac c ess and I/ O operations

from remote systems.TKT.COMMS

TKT.COMM S ac c ount m ust b e insta lled on a ny syste m serving up , orusing rem ote files.




Version 4.3

1 – Insta ll o f TKT.COMMS Ac c ount

1. Go to the TKT relea se a c c ount, and ente r the d a ta ba se environm enta t TCL.

2. At the c omm and promp t, type:TKT.INSTALL.COMMS

The following will oc c ur:




Version 4.3

1.1 – Post Install of TKT.COMMS Ac c ount

After the TKT.COMM S ac c ount is newly insta lled , the fo llowinga c c ounts must b e setup for ac c ess by rem ote system s.

TKT.ADM INTKT.COMMSUV

Please refer to section 5, Acc ount and File Ma nag ement , for d eta ils on howto set up the a c c ounts neede d.




Version 4.3

1.2 – TCP/ IP Port Ac c ess Setup – Linux

1. Log into the system a s root .2. At the c omm and promp t, type:

system-config-securitylevel

1. Using the TAB key, naviga te to the CUSTOMIZE butto n, a nd hit ente r.




Version 4.3

1.2 – TCP/ IP Port Ac c ess Setup - Linux

1. Using TAB , insure tha t the Ethernet c a rds a re c onsidered b oth asTruste d Device s and as Ma sq uera de Devic es , by moving to ea c hentry and p ressing the spa c eb ar. When a c tivated , an asterisk, “ *”, willbe disp la yed.

2. Using TAB , naviga te to the Other Ports field . If the re is a lrea dy a nyentries, simp ly p ress the spa c eb ar to a dd a nothe r entry.

3. Ad d 11001 to the Other Ports field, the n TAB to the OK button andpress enter.

4. Ba c k on the p rima ry sc ree n, TAB to the OK b utton, and p ress ente r tosave the c hang es.




1.2 – TCP/ IP Port Ac c ess Setup - Linux

Version 4.3

1. Refresh the netw ork settings so tha t the new c hange s will take effec t,by typing the following a t the c omm and prompt:

service network restart




Version 4.3

1.3 – Sta rting the TKT.COMMS Soc ket Listener

1. After insta ll, the fo llow ing c om ma nd nee d s to be issued to sta rt theSoc ket Liste ner:/GSASYS/TKT/TKT.COMMS/bin/StartCommServer




Version 4.3

2 – DMF Me nu

1. Cho ose the ADMIN link from the m a in TKT d evelop me nt menu.

1. Cho ose the Dom ainFree Adm inistra tion menu op tion. NOTE: The m enu c a na lso b e linked to the me nu structure o f a n a p p lica tion. This p reve nts thenec essity for the TKT d eve lop me nt to b e a uthorized on a p rod uc tion server.




2 – DMF Menu

Version 4.3

1. The follow ing o p tions a re p resent on the DMF Administration menu:

Ac c t & File Ma nag eme ntThis op tion is the p roc ess for defining a c c ounts a nd files to b e sha red

in a rem ote setup .

AppID Manag ementThis a llow s for d efining of a p p lic a tions on the loc a l system. It also

a llow s for de fining a p p lica tions on rem ote system s, ba sed on nodename. NOTE: This rep la c es the nee d to ma nua lly setup the WEB_DEVAPPS file.

Server Node Manag eme ntThis a llows fo r de finitions of rem ote syste ms, as well as the loc a l syste m.NOTE: All nodenames MUST b e p resent in the syste m’ s ho st ta b le.

Referenc e O bje c ts MenuThis is a link to the me nu tha t c on trols the d efinitions of Refe renc e

Objects for the a cc ount b eing m aintained.




Version 4.3

3 – Server Nod e M ana ge me nt

1. Cho ose d efined nod es b y c licking the sp yglass to g ene ra te a list.




Version 4.3

3.1 - Server Nod e Entry

1. Enter the Server Node Name . This na me MUST exists in the syste m’ s ho stta b le fo r ac c ess. In b oth AIX a nd Linux systems, the host ta b le isloca ted at /etc/hosts . Onc e d efined , the system should g et aresponse from the Server Node Nam e , when a PING c om ma nd isissued.Exa mp le of nod e nam e:

The Prosec ution Attorney serve r is loc a te d a t 192.168.2.20. The Nod enam e w ill b e prosatty . When ente red into the hosts ta b le, the PINGc om ma nd w ill show:# ping prosattyPING prosatty: (192.168.2.20): 56 data bytes64 bytes from 192.168.2.20: icmp_seq=0 ttl=255 time=0 ms64 bytes from 192.168.2.20: icmp_seq=1 ttl=255 time=0 ms64 bytes from 192.168.2.20: icmp_seq=2 ttl=255 time=0 ms

2. If the Server Node Name being d efined is the loc a l server, che c k thebo x for Local Host Server .

3. If the Server Node Name is d efined a s the Ma ste r server holding theda ta for the CIDX, aka Ma ster Ind ex, system ; then c hec k the b ox forDMF Server .




Version 4.3

3.1- Server No d e Entry

4. If the Server Node Name being d efined ne ed s spec ia l netw ork routingrules to ac c ess, then enter the routes nee ded in the g rid .

5. Ente r the IP ad d ress for the Server Node Name in the field IP addressfor rem ote file interfac e.

6. Ente r the p ort num ber tha t the system will use for rem ote files in thefield Port Number. Usua lly the p ort number should b e 11001.

7. If the Server Node Name being d efined is the Local Host Server , andthe server should no t a llow inc om ing c onne c tions, then c hec k the b oxfor Disable Inbound Connections to this Node. Remember, This is ONLY

valid for the Loc al Host Server nod e e ntry.

8. If the Server Node Name be ing d efined should not a llow for outboundc onnec tions, then c hec k the b ox for Disab le Outbound Connec tionsto the Node.




Version 4.3

3.1- Server No d e Entry

9. Choo se from the d rop do wn in the field Node Datab ase Typ e , theda tab ase that the Server Node Nam e is running .




Version 4.3

4 – App lic ation ID Manag em ent

This p roc ess a llows for the d efinition o f a ll a p p lic a tions on a system,whethe r it is a loc a l or a rem ote system .

This p roc ess rep la c es the nee d to ma nua lly ma inta in theWEB_DEVAPPS file o n a ny system.

Enter the follow ing into the grid p rovide d for a ny ap p lic a tion:

1. APPID is the rea l ap p lic a tion id . NOTE: For ap p lica tions which run frommultiple da ta a c c ounts, ea c h sep a ra te from ea c h other, the APPID isthe c om mon a pp lic ation id that a ll a c c ounts share.




4 – App lic ation ID Mana ge ment

2. Called By is the a p plic ation id that c a n c a ll the d efined APPID . Thisa llow s for multip le entries of synonym a p p lic a tion id s to b e d efined fora sing le APPID.

Exa mp le of Usa g e:

For the a p p lic a tion tk t , there a re three sep arate d a ta a c c ounts.Eac h ac c ount will be c alled by a unique nam e.

3. In the Dom ain Free Serve r Nod e field , enter the p rev iously d efined

nod e nam e that the ap plic a tion is loc a ted . NOTE: This should ONLY b eente red whe n the a p p lic a tion is on a rem ote system .

4. In the Data Ac c ount Name field, enter the ac c ount nam e that thea p p lic a tion is running from . The a c c ount MUST BE d efined in theUV.ACCOUNT file.

Example:For the tk t a p p lic a tion, there a re three a c c ounts, a s p ic tured

a b ove, TKT.RELEASE.4.3, TKT.RELEASE.4.2a , a nd TKT.RELEASE.4.1b b

5. The fie ld Data Path is ente red onc e the Data Ac c ount Name is ente redb a sed on the informa tion found in the UV.ACCOUNT file.

Version 4.3




Version 4.3

5 – Ac c ount and File Manag em ent

The p roc ess fo r Ac c ount and File Mana gem ent is where all permissionsa re set for rem ote systems to a c c ess files and ac c ounts.

After defining no d es and a p p lic a tions, the Ac c ount and FileManagement proc ess a llow s for the set up a ll the a c c ounts and files tha tare allowe d to b e a c c essed by the de fined node s.




Version 4.3

5.1 – Account Setup

1. The p roc ess fo r Ac c ount and File Mana gem ent , starts with a grid listingof a c c ounts on the system that a re d efined to b e a c c essed by remotesystems.

2. Choo se from the d rop d ow n, the Ac co unt Name to be a llowe d forrem ote a c c ess.

3. When chosen, the field Default Ac c ess Permissions , will fill in w ith asystem defa ult va lue of RWXSCDA. The permissions a llowed a re:Permission Definition R READ a c c ess is a llow ed .W WRITE a c c ess is a llow ed .X Exec ute of TCL verbs is a llowed .S SELECT a nd SSELECT ac c ess is a llowed .C CLEARFILE ac c ess is a llow ed .D DELETE a c c ess is a llowed .A ADD ac c ess is a llow ed .

Multiple p ermissions a re e nte red within the field .

EXAMPLES:To g ive a n a c c ount rea d a nd write permissions only, ente r RW To g ive a n ac c ount read , write, ad d and d elete p ermissions, ente rRWAD




Version 4.3

5.1 – Ac c oun t Setup

4. The field Owner’s Acc ount de fines the o wner of the ente red rem oteac c ess a llow ed Acc ount Name. This field is ma nd a to ry. In m ostc irc umsta nc es, the Owner’s Account will be the sa me a s the Account

Name .

5. The field Owner’s AppID defines the TKT app lica tion ID assoc iate d tothe Owner’s Account field.

6. Rep licate Files Defa ult is a drop d ow n de fining if the ac c ount enteredwill ha ve its files rep lic a ted to anothe r system. Rep lic a tion is a nothe rpart o f Domain Free , and is d isc ussed in ano ther do c ume nt.For the initia l entry, lea ve the system e nte red va lue o f Default .

7. The ac tion butto n Set Default File Properties a llows for ind ividua l fileswithin the a c c ount, to b e set up unique with sep arate and differentpermissions from other files in the ac c ount.




Version 4.3

5.2 – File Ma nag em ent Ac c ess Control

Once the ac tion button Set Default File Properties is c lic ked for anac c ount in the Ac c ount Setup process, the File Mana ge me nt Ac c ess Controlp roc ess is launc hed .

This p roc ess a llows for the sett ing o f uniq ue permissions on a per fileba sis.

The p roc ess a lso a llow s for the d efinition of Refe renc e Ob jec ts a s we lla s Prog ra ms tha t a rem ote system will be a llow ed to e xec ute.

NOTE: The a c tion b utton Rem ote Triggers is a fea ture to be introd uc edin a future relea se.

To a c c ess deta il permissions for a file in an a c c ount, do the follow ing:

1. Loc a te the file to a c c ess in the p rovide d g rid.2. Clic k the ac tion butto n Deta il Perm issions.




Version 4.3

5.2.1 – Detail Permissions for a File

1. For ea c h remo te system tha t w ill ac c ess the file, ente r the d efinedsystem in the Node Nam e field. Also, the re is a spy g lass which w illreturn a list o f a ll defined nodes on the system.

2. If the permissions to the file a re to b e limited to a single remo teapp lica tion, ente r the a p p lic a tion ID in the field Calling Application ID .

3. If the permissions to the file a re to be limited to a single user, ente r theuser nam e in the User Name field.

4. Ente r the permissions for the file in the Permissions field.5. When d one, c lic k the SAVE co mp ute button, at the bo ttom of the

page. The g lob a l buttons, at the top of the sc ree n, are NOT allow ed .

Eac h file c an c onta in multiple p ermissions set tings ba sed on the entries in thegrid. The a c c ess c an be set b y nod e, or by no de and c a lling a pp lic ation, or

by no de , by c alling a pp lic a tion, and by a spe c ified user.

Eac h set p ermissions d efined for a file m ust ha ve a n assoc iate d nod e.

NOTE: By ente ring permissions here, the system will REJECT ac c ess to the file, ifthe a c c ess is be ing req uest b y a nod e no t d efined in the g rid .




Version 4.3

5.2.2 – Referenc e Objec ts Tab

The sec ond ta b in the File Mana ge me nt Ac c ess Control a llow s for thepublishing of previously defined Reference Objects.

The c hec k box labeled Pub lish a llows for rem ote systems to b e a b le toa c c ess the Referenc e Ob jec t.

The ac tion butto n Detail Permissions a llow s for the setup of uniquep ermissions to the Refe renc e Ob jec t, just like with norma l files in the a c c ount.

Refe renc e O bjec ts a re d isc ussed in its ow n d oc ume nt, and for now

should b e left alone .




Version 4.3

6 – Runtime Ac c ount Setup

Onc e a ll d efinitions have be en entered , to ena ble the runtime a c c ount forrem ote file o p erations, do the follow ing:

1. At TCL, ma ke a new VOC item c a lled *BASIC.DIRECTIVE. 2. Ente r the follow ing o n Line 1:

*$R 3. Save the ne w item.4. Selec t the c onte nts of the app lic a tion’ s source file.5. R.BASIC the c onte nts of the a pp lica tion’s source file.

With the ne w VOC item , and the re-co mpile o f the source p rog ra ms usingR.BASIC , the a p p lic a tion is now rea d y for rem ote files.

NOTE: If a p rog ram is neve r to b e remo te file a wa re, then enter the follow ingc om me nt line in the hea ding of the sourc e:

*$NOR Also, if the p rog ram c a lls other sub routines, eac h one o f those sub rout inesmust have the *$NOR line.

Mixing p rogram s c onta ining *$NOR with other p rog rams that do not have thed irec tive will ca use unp red ic tab le results. Do Not do this.




Version 4.3

6.1 – Setup a Rem ote Q-Pointe r

To c rea te a rem ote Q-pointer in a n a c c ount tha t will ac c ess a file o n arem ote system, do the follow ing a t TCL.

1.

Edit a new VOC item, that is the na me of the new rem ote Q-pointer.2. Enter the fo llow ing on ea c h line:<1> = RQ <2> = remote a cc ount name <3> = rem ote file na me <4> = nod e na me of rem ote system

NOTE: The lite ral let te rs RQ are req uired on line 1.

After sa ving the ne w VOC item , test the c onne c tion to the file b y using theR.LIST verb. Deta ils on this verb c a n b e found in sec tion 8.




Version 4.3

6.2 – Allow Rem ote Systems to Ac c ess a Proc ess in the Runtime Ac c ount

As with a ll users on the loc a l syste m, a WEB_USER en try must be c rea te d for arem ote system, so tha t the rem ote system c an run p roc esses in the loc a lruntime ap plic ation ac c ount.

The User Id for a rem ote system w ill b e:

nodename :calling_applicationID

Where:

Nodename is the d efined no de na me of the remo te system

Calling_applicationID is the a pp lic a tion on the rem ote system tha t willb e running p roc esses in the loc a l runtime a pp lic a tion.

No p a ssword is nee d ed for the user.

Like w ith other WEB_USERS, the a c c ess permissions of this user must b e setuplike a ny other loc a l server.




Version 4.3

7 – R.BASIC rules with Ac c ounts that Are Rem ote Aware

Rule 1 Ea c h p rogram written outside of the norma l FIND/ LIST/ PROC ESSsc ree ns, must ha ve the top 8 lines set to spec ific c ontents. Line 1 will eitherhave the keyword PROGRAM or the keywo rd SUBROUTINE , at the b eg inning

of the line. The next 7 lines will c onta in an aste risk “ *” as the first c ha rac ter.

Exam ple Prog ra m:001:PROGRAM HELLO.WORLD002:*003:*004:*005:*006:*007:*008:*

009:PRINT ‘HELLO WORLD’010:STOP011:END

Exam ple Sub routine :001:SUBROUTINE HELLO.WORLD(ERR.MSG)002:*003:*004:*005:*006:*

007:*008:*009:CALL WTK.OPEN.FILE(‘WEB_TEMP’,FILE.TEMP,ERR.MSG)010:IF ERR.MSG # ‘’ THEN RETURN011:PRINT ‘HELLO WORLD’012:RETURN013:END

This style of c od ing is req uired for use with rem ote a ware a c c ounts, and theR.BASIC compiler.

This style o f c od ing a llows for use of the SOURCE CONTROL sc ree n, and thec ap turing of c omm ents of cha nges to c od e.




Version 4.3

7- R.BASIC Rules

Rule 2 How to write IF/ THEN/ ELSE sta te ments

The fo llowing IF/ THEN/ ELSE is NOT allowed.

IF X=1 THENY=1ELSE

Y=10END

The p rop er forma t a IF/ THEN/ ELSE sta te ment is:IF X=1 THEN

Y=1END ELSE

Y=10END

Or:IF X=1 THEN Y=1 ELSE Y=10

Rule 3 I/ O op erations syntax

For eac h READ/ WRITE/ DELETE op erat ion, the sta te ment should be o n its ow nline.

Example:The follow ing is NOT allowed:

IF X=1 THEN READ MYDATA FROM MYFILE,MYID ELSE MYDATA=””

The sta tement should b e:IF X=1 THEN

READ MYDATA FROM MYFILE,MYID ELSE MYDATA=””END




Version 4.3

7- R.BASIC Rules

Rule 4 I/ O op era tions a nd c om plex variab les

For an I/ O operation tha t uses a c om plex varia b le, no spa c es a re a llow ed . A

c om p lex variab le is usually a va riab le c onc a tena ted to a nother variab le o rliteral string.

Inc orrec t synta x:READ MYDATA FROM MYFILE,MYID : “*” : MYCOMPANY ELSE MYDATA=””

Correct syntax:READ MYDATA FROM MYFILE,MYID:“*”:MYCOMPANY ELSE MYDATA=””

Rule 5 I/ O op era tions with the following keyw ord s: ON ERROR, LOC KED,THEN a nd ELSE

The sta nd ard syntax has d oc ume nted in Data Basic must b e fo llow ed for allI/ O o pe ra tions and state me nts

Inc orrec t synta x:READ MYDATA FROM MYFILE,MYID LOCKED

Y=1THEN

X=1ELSE

Z=1

Correct syntax:READ MYDATA FROM MYFILE,MYID LOCKED

Y=1END THEN

X=1END ELSE

Z=1END




Version 4.3

7- R.BASIC Rules

Rule 6 I/ O sta tem ents must ha ve spa c e sep ara tors for keywords

Eac h I/O sta te ment, like READ a nd EXECUTE, must c onta in spac es a s

sep a ra tors betw ee n the keywo rds for the sta tem ent.

Inc orrec t WRITE synta x:WRITE “ABC”ON MYFILE,MYID

Correc t WRITE synta x:WRITE “ABC” ON MYFILE,MYID

Inc orrec t EXECUTE syntax:EXECUTE “LIST MY.FILE NAME DOB”CAPTURING MYRPT

Correc t EXECUTE syntax:EXECUTE “LIST MY.FILE NAME DOB” CAPTURING MYRPT

Rule 7 No Defa ult File Varia b le Op erations a re a llow ed

Example:OPEN ‘MYFILE’ ELSE PRINT ‘NO MYFILE’

R.BASIC does NOT sup port this.

The sta tement should be:OPEN ‘MYFILE’ TO MYFILE ELSE PRINT ‘NO MYFILE’

Rule 8 For any program that calls subroutines, those subroutines mustb e in the sa me rem ote aw are sta te tha t the p a rent p rog ra m is in.

As d isc ussed in sec tion 1, eac h rem ote awa re a c c ount w ill ha ve a VOCentry for *BASIC.DIRECTIVE. How eve r, if a p rog ram w ill neve r be remo teaw are, then the p rog ram mer ca n enter *$NOR, to turn off rem ote a wa re forthat one p rogram.

BUT, if the p a rent p rog ram is not remo te a wa re, and the sub routines a rerem ote aw are, this c an c a use unp red ic ta ble b eha vior.




Version 4.3

7- R.BASIC Rules

Rule 9 DataBasic Func tions

The fo llow ing tw o func tions a re NOT supported with R.BASIC .

SSELECT This is akin to the SELECT func tion, a nd sho uld no t b e used .Instea d , use EXECUTE a nd SSELECT the file .FORMLIST This func tion w ill be sup ported in a future relea se.

The INDICIES func tion is supported , but only with the follow ing syntax:INDICIES( filevariable,indexname )

Or with:INDICIES( filevariable,’’ )




8 – Verbs for use w ith Rem ote Files

For ea c h system tha t w ill ac c ess a rem ote system, a set of TCL verb sa re a va ilab le for use. These verbs a re ONLY va lid for files d efined as rem oteQ-pointers.

R.LIST and R.SORT

These ve rbs a llow for a LIST a nd SORT op era tion of a remote file .

R.SELECT

This verb will selec t item id’ s from the rem ote file.

R.ED

This verb will a llow for ed iting of a n item in a remote file.

R.EXC

This ve rb a llows for exec ution of a TCL verb in the remote syste maccount.

dmf documentation

Documents