Csprox Installation Manual 1
Csprox Installation Manual 1
2. Install CSProX
The file CSProX.exe can be downloaded from www.serpro.com. You must
select the default option: “CSProX+Server (Full Installation)” (figure 2).
5. Connect to the standalone server from the same machine where the server is
installed
Once the server is running, execute “CSENTRY rentry.pfr”
(CSProXCSEntry shortcut). There is a copy of the rentry pfr in the
installation folder.
Enter the administrator‟s user/password (figure 10).
You should be able to see the welcome message defined in figure 6.
7. Adding projects
When the standalone server is running correctly, you‟re ready to generate
and publish new projects (See “Remote Entry Administration” topic for
details).
Software Installation
2. Click “Next” on the first dialog and select the language that will be used
by some parts of the system.
Figure 1
Small words (Table, and, by, Legend, etc.) generated by tables and
maps
Font style, in order to support languages such as Russian, Ukrainian,
or Armenian on data entry screens and in tabulation output.
CSProX allows you to select the components you want to install. During the
installation you will see the following component dialog:
Figure 2
Remember that you can always change the components by rerunning the
installation.
The program RStartup.EXE allows configuring the remote entry server. You
can press “Cancel” (see dialog below) and continue with the configuration process
later executing directly the program RStartup.EXE from the CSProX installation
folder or through the option “Server/System Data Base Initialization” from the
program group.
Figure 3
“Dsn”: Is the SYSTEM DSN name where the remote entry tables will be
installed. Normally it is named “rentry”. To create a system DSN see “Creating a
DSN” topic (below).
“User/Password”: Is a valid user name –and password- having the right
permission to connect to the DSN.
Figure 4
Note that the REntry administrator user is not the same user as the REntry
DSN user. You can use the same name but conceptually they are different users.
At this point RStartup is ready to generate the system tables in the “rentry”
DSN.
After pressing the “Connect” button, some dialogs should appear informing
that the system tables are being generated. After that the following dialog appears:
Figure 5
Note that if the “No” button is selected, you won‟t have any server
information and thus, you won‟t be able to perform any remote task including the
handling of the REntry administrative tables. Therefore, we strongly suggest that
at this time you are prepared to select the “Yes” option described below.
However, if you select the “No” option, you can rerun the RStartup program to
define a valid server.
The field “Name” corresponds to the internal server name (the system can
have more than one server). At this point we have defined the first server named
“datacapture1”.
The field “Address” indicates where the server will run. By default the port is
“4444” but the user can change it.
There are two kinds of servers: the “Standalone Soap Server” and the “Isapi
Soap Server”. The Isapi Server configuration will be explained under “Running the
ISAPI REntry Server” topic.
The Standalone server can be a “normal” server (the address starts with
“http”) or a “secure” server (the address starts with “https”). The secure server
uses SSL.
If you have any problem during the configuration, you can run
“RStartup.EXE” again.
Once the configuration is finished, the database “rentry” should have the
following tables:
These tables are populated with the basic information to allow the
administrator to connect to the unique pre-installed remote entry application:
RENTRY.ZIE.
To test that everything is working correctly you need to perform the following
steps:
Run a Server (StandAlone or Isapi)
Execute CSEntry to connect to a server
The first time it‟s better to run the standalone server in order to check that
everything is working correctly. The Isapi server requires some extra configuration
in Internet Information Server.
We need to define the Port number where the server will run. In addition, we
need to specify whether we want to run the server in secure mode -selecting the
SSL checkbox- or normal.
After clicking on the “Run” button, the dialog described in Figure 3 will be
shown. This dialog allows defining the system DSN. After pressing “Connect” in
that dialog the following dialog is shown:
Figure 8
This dialog is similar to the one shown on Figure 4 except that conceptually,
the “User” field only allows “Administrators”. No other user is allowed to run the
server.
Figure 9
This dialog only appears when there is no license information defined. The
“Licensee Name” and “Product Key” fields correspond to a valid key provided by
the CSProX product seller. See www.serpro.com for further information regarding
licenses.
CSProX Installation Manual 9
www.serpro.com
After pressing the “Ok” button –assuming the “Product Key” is correct, the
server starts running. An icon should appear on the icon tray bar.
To stop the server just click on the icon located on the icon tray bar and
click over the “Stop” and “Exit” buttons.
The most common applications are executed using the CSEntry module
either as standalone or connected to the server. CSEntry clients are the most
common to connect to the server to run specific applications. The applications that
CSEntry clients are able to run are CSProX applications packed in a file called
“ZIE”. A “ZIE” file can be defined as a collection of applications and data files
related to a project that can be accessed by different users simultaneously.
REntryA on the other hand can be used only by clients of the type
administrators. Those clients connect to the server through the “REntryA.EXE”
program. REntryA allows defining and publishing ZIES that will be used by
CSEntry clients. See the “Remote Entry Administration” topic below for a
complete description.
[Zie]: This block is also required and has only one entry:
“ZIE=” followed by the “ZIE-Name”.
Together with the CSProX software there is a “REntry.PFR” file that can be
used to connect to the REntry server and have access to populate the system‟s
administration tables. We just need to copy this file to the working folder where we
want to have the REntry applications and double click on this file to execute
CSEntry. Note that the REntry.PFR should be modified accordingly providing the
server address if we want to connect as a remote user. The address provided is a
local address.
If you‟re behind a proxy you must add the “ProxyAddress” entry in the
[Server] section of the “RENTRY.PFR”:
[Server]
Address=http://local_pc:4444
ProxyAddress=<Proxy-Address>
After double clicking on the REntry.PFR file the CSEntry program will send
the connection message to the server running on local_pc on port 4444 according
to the address specified above “Address=http://local_pc:4444”.
Figure 10
If the proxy address has been included in the RENTRY.PFR file, it will be
shown on the dialog above. However, the user can and should be able to modify it
since users might have different addresses or not have at all.
Figure 11
This dialog indicates that the user is connected to the server. The Welcome
message was defined during the server configuration process (see figure 6).
After that, the target application (in this case RENTRY.ZIE) starts to work.
The application starts showing the following menu:
Figure 12
The Isapi server runs under Internet Information Server. When the prefix
“https” is used in the address the Internet Information Server must be a “secure”
server.
http://server_hp/rentry_test/mod_gsoap.dll?rsoap
In this case “server_hp” is the name of the server machine and “rentry_test”
is the virtual directory.
The field “Execute Permissions” (see below) must be set as: “Scripts and
Executables”. In Windows XP-PRO the corresponding dialog is:
In Windows XP-PRO you can access the IIS configuration program through:
“Control Panel”, “Performance and Maintenance”, “Administrative Tools”, “Internet
Information Services”.
To test that the REntry server is running, from Internet Explorer go to:
http://server_hp/rentry_test/mod_gsoap.dll?rsoap
The message is indicating that the ISAPI REntry server is waiting for POST
requests. Those requests are sent by the REntry clients: CSEntry and REntryA.
If you get a different message you must check the Internet Information
Server configuration manual. The most typical problems are related to
permissions. Please check the Authentication Methods associated to
mod_gsoap.dll. In IIS 6.0 you can reach that dialog (see figure below) through IIS
Managermod_gsoap.dll PropertiesFile SecurityEdit Authentication and
Access Control. If you have enable the anonymous access be sure that the "User
name" and "Password" are correct and the user has enough privileges to load dlls.
Figure 13C
If you are adding a new ISAPI server (different to the defined in figure 6)
you will need to register it in the servers table. To register the server, select option
9: “Servers Table Handling", (see figure 12) and specify the server name (for
example: “datacapture2”) and the server address (it must end with the suffix
“mod_gsoap.dll?rsoap”) as in http://server_hp/rentry_test/mod_gsoap.dll?rsoap.
The welcome message is optional.
Figure 14
Finally, to test the server, change in the file “rentry.pfr” the line:
“Address=http://local_pc:4444”
to
“Address=http://server_hp/rentry_test/mod_gsoap.dll?rsoap “
Save the new “rentry.pfr” file and execute “CSEntry rentry.pfr”. After
displaying the welcome message, the administrator menu should be displayed
(Figure 12).
Creating a DSN
The DSN names are defined using the “ODBC Data Source Administrator”
program provided with the windows operating system. In Windows XP-PRO this
program can be accessed through: “Control Panel”, “Performance and
Maintenance”, “Administrative Tools”, “Data Sources (ODBC)”. Make sure you use
the System DSN instead of User DSN.
To add a new DSN you must click the “Add” button and the following dialog
will appear:
Figure 16
Figure 17
A valid User and Password must be provided. For testing purposes you
can use the “root” user without password. Normally that combination is valid in
MySql.
Figure 19
If everything has been properly done, the following message should come
up:
Figure 20
At this point the System DSN “rentry” using the database “rentry” has been
defined.
When we execute “REntryA.EXE” the dialog shown on figure 3 will show up.
After filling the correct information, the dialog specified on figure 8 will be
displayed. This dialog has 3 buttons instead of 2 (the button “Connect” was
replaced by the button “OnLine” and “OffLine”)
ZIE manipulation.
Import/Export data from the Data Base to CSProX and vice versa.
Create relational tables from a CSProX dictionary.
Tables administration tasks (view tables and start a REntry server).
Queries over the log table.
When REntryA starts in On-Line mode, all the published ZIES not located in
the “RAFILES” folder are copied from the server.
This panel shows a tree containing all the ZIEs already published. At the
beginning there is no ZIE published and the tree is empty.
To create a new ZIE, select the “Create” button and the following dialog will
be displayed:
Figure 21
The “Project Root Folder” should be the node from which the entire project‟s
sub-folders are hanging from (as illustrated on the tree below). The system will
scan from the “Health” folder down searching for all the “.PFF” files and other
relevant files (e.g. “.DCF”, “.ENT”, etc.) to generate the ZIE/project tree as
illustrated on figure 26. In our illustration below, we have a “Health” project node
from which we have defined three sub-folders named “Apps”, “Data”, and “Dicts”.
Each one of them stores, for organization purposes, the application(s), the data
that will be used in the project, and the various data dictionaries used by the
application(s). Thus, at the time you generate the ZIE the whole project should
CSProX Installation Manual 21
www.serpro.com
have been implemented and properly tested locally by the project administrator.
Note that the same folder structure found at the time the ZIE is built will be later
reproduced in the clients‟ computers when the ZIE is retrieved and the files
exploded/extracted.
Figure 21B
After specifying the project root folder and clicking on the “Next” button, the
ZIE tree is built and the following dialog will be displayed:
The dialog shows a tree organized by “.PFF” files. The folder must contain
at least one “.PFF” file. In this example we have 12 data entry applications.
The right button click allows defining different parameters for some
elements on the tree. The options menu depends on the node type.
We first need to define in the “INI” node the starting directory for the
application in the client machine. This directory is a relative path. The default path
is „.‟. When there is no folder under the input directory chosen in figure 21, the only
option is the current directory („.‟).
Figure 23
The “Include All” and “Exclude All” options allow including or excluding all
the files under the PFF node.
In every node under the “PFF” node and ending with “.PFF”, the menu has
the following options:
Figure 25
The option “Primary PFF” permits identifying which is the application that
will be executed first by the CSEntry client (main application) when the ZIE file is
executed. The ZIE node should have one and only one “Primary PFF” file. Any
other “.PFF” file must be called by the primary application using the ExecSystem
function (launching another CSProX application) and tagged as “Secondary”.
The “DCF” node under each “.PFF” node will contain a list of all the data
dictionaries of a particular application divided into two groups: “Input” and
“External” dictionaries (figure 26). By right clicking on a “.DCF” we can define the
attribute the data file associated to the dictionary will have. The attribute is
selected from the list displayed after you right click on the particular “.DCF” node
(see the list on the right part of figure 26).
Figure 26
When the data file (DD) is remote, the necessary relational tables are
generated in the server at the time the ZIE is published. The number of tables
generated depends exclusively on the data dictionary.
Finally, once we decided which files to include in the ZIE, we defined the
“Start In” folder, the primary “.PFF” file and the dictionary attributes, we are ready
to build the ZIE (“Build Zie” button). At this moment we must define the ZIE name
and the folder where the “.ZIE” file will be saved.
The ZIEs generated during the session will be shown in the ZIEs tree (left
pane). When we finish REntryA and we run it again, the tree will not include the
ZIEs generated in the previous session (they need to be published to appear on
the left pane).
We can load ZIEs in the ZIEs tree from the hard disk using the “Load”
button. To delete a ZIE from the ZIEs tree we need to use the “UnLoad” button.
Note that the “UnLoad” button will only delete the ZIE from the tree but it won‟t
delete the ZIE file from the hard disk.
CSProX Installation Manual 25
www.serpro.com
Finally, the last step is the ZIE publication. To publish a ZIE, we select the
one we want to publish from the ZIEs tree and then click on the “Publish” button
(the right mouse button on the ZIEs tree also shows a menu with the same option).
The following dialog will appear:
Figure 27
This dialog allows defining which DSN will be used for the data file for
certain dictionary (in this case the “ADMIN” dictionary). The fields “User” and
“Password” correspond to a valid user with permission to connect to the DSN
specified.
Once you connect to the DSN without problems, the following dialog will
appear:
Figure 28
This dialog only appears if the ZIE has more than one remote dictionary.
Select “No” to define each dictionary in a separated DSN (you can also select ”No”
and then repeat the information defined in figure 27 for each dictionary). Select
“Yes” to use the same DSN for all remote dictionaries defined in the ZIE.
When all the tables for each dictionary are generated in the respective
DSN, the following dialog appears:
The ZIE published is saved in the “RAFILES” folder. The next time you
execute REntryA, the ZIEs tree will show the ZIEs that are located in the
“RAFILES” folder.
RDSN, RDSN_REC: One row for each dictionary is added containing the
association between dictionary and DSN.
RPERMS, RPERMS_REC: One row is added with the name of the
current administrator, the ZIE name and the permissions read-write.
RZIE, RZIE_REC: One row is added with the name of the ZIE and the
date of publishing. The ZIE is set as enable.
RZIEUSER, RZIEUSER_REC: One row is added giving access to the
administrator to the ZIE.
The next step is to test the ZIE remotely and give access to the other users.
To connect to the server execute “CSEntry TEST.PFR” and connect as
administrator. To define TEST.PFR see the topic “Connecting to the Stand Alone
REntry Server”. The server must be running before to connect as a client.
This panel allows seeing the content of the system tables. Additionally,
positioning over the table “Servers” column “RSERVER_STATUS” with the mouse
right click appears a menu that allows changing the server‟s status (Stop, Start
and Pause). See the topic “Running the REntry Server” (above) for details.
Upload/Download Data
There are two icons (yellow arrows) on the control REntry toolbar that allow
to export CSProX data files to a RDB or to import data from the RDB to a CSProX
format.
Figure 30
The first icon (up yellow arrow) allows us to export a CSProX data file to the
RDB and is called “Upload” data. If we want to export a data file to an RDB, the
CSProX dictionary related to the data file can be part of an existing ZIE or it can be
a local dictionary. In the first case, the relational tables are already generated in
the DSN associated to the ZIE. On the other hand, in the second case (local
dictionary) we need to specify the DSN name where the relational tables have
been generated. After clicking on the “Upload” icon, the following dialog appears:
The input data file corresponds to a CSProX data file that will be exported to
the RDB and is associated to the data dictionary that we need to specify.
The dialog box shows the two options mentioned before to specify the data
dictionary: Server side ZIE embedded data dictionary or local dictionary. The first
option is used when the dictionary belongs to a ZIE, in which case, the DSN name
is associated to the couple “ZIE + Dictionary Name”. The second option allows
selecting any dictionary in which case, it‟s necessary to directly specify the DSN
for that dictionary where the RDB tables had been previously generated.
The default behavior for transmitting the cases is case by case. When the
“Case by Case” option is not selected, the system will export all cases in only one
package.
Figure 32