This manual describes the installation of the PalstatCAQ quality management software on the server including all its components.
If the requirement is to make data available for multiple locations located in different states and thus accessed remotely. We strongly recommend a solution using RDP access to the central server where the application and MSSQL are located.
Example1: A user on the local network inserts a 50MB attachment into the QSD module and works with the document or attachment in any Palstat module on the local network without any problems. However, a user on a VPN with 256kbps line throughput has no chance to work with the program.
Example2: Users on the local network use the STOPKARTY module and it contains 800tis records. No one has set up a global filter that will not show outdated and archived data. On the local network the program will be slow every time the grid is loaded, but on the VPN it will be completely non-functional. Before the SQL server can return the data to the application over the VPN it will timeout.
The speed of the application startup when using a VPN can be partially solved by a local copy of the system on a Clint PC. Please refer to the document for a possible solution, which is only informative and more solutions can be found.
Technologically, it is possible to run PALSTAT CAQ and MSSQL server on many virtualization technologies.
Example:
We recommend using branded HW (IBM, DELL, HP, Lenovo) with the possibility of purchasing an extended warranty - repair directly at the customer's site, the possibility of guaranteeing the start of work on the removal of HW defects or guaranteeing the time of removal of HW defects.
RAM memory size
For MS SQL Server operation, the recommended RAM size is 1:1 to the size of the running database (or the sum of active databases *data). For MS SQL Server, enough RAM has a significant impact on the responsiveness of the PALSTAT CAQ system. If it is not possible to provide the required RAM, place the MSSQL data files on SSDs.
Disk configuration
RAID 10 or RAID 1 is recommended for database storage. RAID 5 is not recommended for SQL databases (http://cs.wikipedia.org/wiki/RAID). The speed of the disk/disk array and the quality of the disk controller have a major impact on the response of the PALSTAT CAQ system. Use SSD and NVMe to achieve high performance and fast response of the entire system.
When installing all components on a single server, we recommend the following directory structure
It is a desktop Win32 application executable on Windows systems, which is the main UI for system users.
Open the ./CONFIG/database.enc file for editing and modify it according to the following example. First of all you need to edit the "Data Source" values where you insert the name or IP of the server where the SQL server is located, then edit the "user" and "password" according to the previously set. When editing, it is always necessary to follow the semantics of the XML standard.
The configuration file is described in the section SUPPORT - Sample database file
Run the application on the server ./APL/Launcher.exe
If the application is configured correctly, the initial initialization, creation of tables and auxiliary structures occurs. Use the ADMIN user for access without entering a password.
Never start the client installation until PalstatCAQ is up and running on the server. In order for the SQL database to be accessible from another computer, it is necessary to configure TCP/IP on the SQL Server and enable the appropriate ports on the firewall. If you are not sure which port SQL communicates on, disable the firewall on the server during testing and create the appropriate rules on the server after testing Palstat functionality on the client. By default, MSSQL communicates on port 1433 and 1434 browser.
Next, just create a shortcut on the client PC from a shared folder on the server that will point to the application signpost, i.e. ./APL/Launcher.exe. It is possible to launch the application from a UNC path or from a mapped disk.
If you want to personalize the appearance of PALSTAT or are experiencing difficulties when you have changed the appearance in WINDOWS. You can customize the launch shortcut and assign one of the looks below. In the example you can see the use of the style for the FMEA module.
WARNING: Styles other than the default style are not fully supported and may cause graphics to overflow or display incorrectly.
Edit shortcut: ../APL/launcher.exe /style 2019COLOR
Available looks (each style separated by a comma):
BASIC (default), BEZIER, 2019COLOR, 2019WHITE, 2019DARK, 2019BLACK
The CAQservice will be used in many aspects of your PalstatCAQ deployment and is recommended to be installed and run alongside your existing system package. It is a win64 system service and thus can only be installed on Windows OS.
Before installing and configuring the service, verify that you have a free and available port that you plan to use, for example, by using the "Resource Monitor" application, "Network" tab, then "Listening Ports"
The installation package includes the ".../CAQservice" directory, which you unpack on the server where you want to run the service, often the same machine where the application itself is. However, this directory must not be part of the user share.
You can set the rule on the firewall with this command, assuming you are using port 8001:
netsh advfirewall firewall add rule name="CAQservice" dir=in protocol=TCP localport=8001 action=allow
Service Settings
Service registration on the server
Change the user to run the service
netsh http add urlacl url=http://+:8001/ user=DOMAIN/user
Verification can be done by.
netsh http show urlacl
We have confirmed that when a user changes, various non-standard service behaviors and correct port opening can occur. In some cases it is necessary to manually delete the port from the system and then restart the service. For example, when calling the CAQservice API service URL, an "HTTP Error 503" error is returned. The service is unavailable".
Proceed as follows:
netsh http delete urlacl url=http://+:8001/
netsh interface ipv4 show tcpconnections | Select-String "Listen"
netstat -aon | find /i "listening"
Adding a user
In the "User Database" module there must be a user "SERVICE" with rights for the "Reporting Viewer" module
CAQservice has its own service API for extracting some basic information about the operation of the PalstatCAQ system. The functionality is still being extended and will be updated on this page.
URL address | Functionality |
http://mujserver:8001/api/ | Default page |
http://mujserver:8001/api/status/ | The service status display returns 1 if the service is functional. |
http://mujserver:8001/api/status/info/?encrypt=false | Detailed information |
http://mujserver:8001/api/mail/test?receiver=example@example.com&sender=example_sender@example.com | Testing the SMTP server configuration |
http://mujserver:8001/api/activation/ | License activation status |
http://mujserver:8001/api/data/eventlog/ | Displays the last 100 events from the system logging table. |
http://mujserver:8001/api/web/string?url=https://www.palstat.cz/caqservice_request/&encrypt=false | Verification if the service has access to WEB / PROXY permeability check |
http://mujserver:8001/api/debug/checklistener | Status Listener |
Přejděte na "CAQservice - plánovač úloh"
If your company uses a proxy server for Internet access, edit the palservice.xml configuration file. In the section enter the IP address of your Proxy server including the port it is running on e.g. 192.168.0.1:8080.
Proper proxy settings affect:
The correct configuration and availability of the requested URLs can be verified using the query below, where the request is passed to the CAQservice, which attempts to contact the requested URL and returns the result to the browser. The test result must not result in an error. "An error has occurred."
http://server:8001/api/web/string?url=https://www.palstat.cz/caqservice_request/&encrypt=false
This functionality is available from version 2022.01.xxx and requires an active CAQserver component together with a purchased SMS package. The messages are sent via a third party service and the sender number defaults from the USA. The form of sending notifications for certain events is always defined by customer requirements.
Message reception can be tested in CAQadmin (System Administration) under the Diagnostics tab.
If you have defined any report in the PalstatCAQ system to send the output to the users' email, you must configure an SMTP server for the CAQservice to send the emails. Configuration is done in the ".../Palstat3G/CAQservice/CONFIG/Config.xml" file. Your configuration file may contain many other parameters and settings. Editing should only be done by an IT person with knowledge of the structure and operation of XML.
Description of the parameters:
<?xml version="1.0" encoding="utf-8" ?>
<palstat>
<globalconfig>
<mail>
<email host="192.168.0.1" port="587" enablessl="true" user="username_smtp" password="pwd_smtp" defaultmailaddress="palstat@domain.com" encoding="Utf-8" />
</mail>
</globalconfig>
<appconfig>
</appconfig>
</palstat>
Activating a function in "System Administration"
To activate the sending of emails, you must set up the appropriate reporting and enable it in System Administration.
Furthermore, the "Scheduler" tab in ./CAQdesktop/APL/CAQadmin.exe (System Administration) must be checked for the "Mail" line.
Testing email throughput
To verify the correctness of the configuration of email parameters, you can use the service API call from CAQservice, as shown on this page in the "Service API" section. This step is required to verify functionality and without performing it, do not perform or attempt to configure the Reporting module to send messages.
Testing using the service API
This is a basic form of test that is sufficient to verify the throughput of the CAQservice to the SMTP server.
http://server:8001/api/mail/test?receiver=example@example.com&sender=example_sender@example.com
Testing from CAQadmin "System Administration"
It offers a graphical interface and it is necessary to have the CAQservice running beforehand, without which "System Management" will not even start.
Go to the "Diagnostics" tab, select the "TEST" button and edit the sender and recipient address.
Finally, click on the "Run" button where the SMTP test line must have a response content of "Sent".
With proper configuration of the service, SMTP server and reporting, individual email messages are forwarded to the PALMAILQUEUE queue table where each email can take on different states. For example, when the SMTP server is unavailable or other errors occur. By opening the named table and sorting by the status column, it is possible to see which emails are in error status and why. The table is also accessible in the CAQadmin.exe diagnostic tool where you can view the table under the Diagnostics -> Log tab.
Check out FlowChart email processing.
CAQapi: HTTP/S data layer that allows data to be extracted from the system to other systems and visualizations.
Required for CAQweb mobile appNutné pro mobilní aplikaci CAQweb
More information can be found in a more detailed document.
CAQweb: HTTP/S UI layer for users in limited functionality on selected modules.
ATTENTION This setting must match how you have set up user authentication in Palstat itself and you must also fill it in the "Authentication.config" configuration file (see below).
If you use authentication against Active Directory, then you will probably need to add the IIS server (http://url.example.cz) on the stations in the "Internet Options" in the "Control Panel" to the "Trusted Sites" or "Local Intranet" zone, depending on the security level set on your network, so that the domain controller can be contacted and the user authenticated.
You should now see the default page for CAQapi and CAQweb at the address of the web page where you added the application under IIS. For example:
CAQweb | |
Production address: | http://url.example.cz/CAQweb/ |
Configuration test address: | http://url.example.cz/CAQweb/status/ |
CAQapi | |
Production address: | http://url.example.cz/CAQapi/ |
Configuration test address: | http://url.example.cz/CAQapi/status/xml/ |
Swagger | http://url.example.cz/CAQapi/swagger/ |
The setup can be done, for example, by using a free service that can be used to sign the IIS server. The certificate is automatically renewed at regular intervals. The implementation can be applied in the following ways see https://letsencrypt.org/docs/client-options/
Our company uses win-acme (.NET), which is published on GitHub - https://github.com/PKISharp/win-acme/releases
You download and extract the ZIP to any location on the server where you want to apply IIS e.g. c:/LetsEncrypt
The DNS must be set to the correct resolution and the machine where you want to apply must be able to see the address.
Run letsencrypt.exe
You then go through the wizard as per your needs. One possible scenario is described below, but it is not fixed.
The result is a signed IIS machine or site and a task created in the scheduler to check the certificate for currency and renew it when it is about to expire.
We set up an IIS site called ssl.palstat.cz and set up DNS routing (the address is only fictitious, use the appropriate DNS name for your deployment).
1)
2)
3)
4)
5)
6)
7)
8)
Configuration files are always included in the installation or upgrade package and can be used during installation with appropriate customization for the installed environment.
".../Palstat3G/CAQservice/CONFIG/palservice.xml"
<serviceSetting>
<serverIpAddress>192.168.0.1</serverIpAddress>
<apiPort>8001</apiPort>
<apiBaseUrl></apiBaseUrl>
<palstatPath></palstatPath>
<serviceName>CaqService</serviceName>
<lang></lang> <!-- to force the use of a particular language, otherwise it is taken out of the system; values: cs/de/en -->
<tempDir>Service</tempDir> <!-- When not set, the default value is used, values: [Service] (default value), [System] (c:/windowstemp) or defined path example: [C:/Palstat_3G/CAQservice/TMP], WEB app CAQservice on IIS ignores this setting -->
<userAuthMode>0</userAuthMode>
<log>
<information>true</information>
<error>true</error>
<warning>true</warning>
<debug>false</debug>
</log>
<runDelay>10000</runDelay>
<webSettings>
<Credentials>DefaultCredentials</Credentials>
<Proxy>
<Url></Url>
<Credentials>DefaultCredentials</Credentials>
</Proxy>
</webSettings>
<modules>
<module id="WebPortal" enable="false" />
<module id="ErrorReport" enable="true" />
<module id="EventHandler" enable="true" />
<module id="Scheduler" enable="true" />
</modules>
</serviceSetting>
".../Palstat3G/CAQservice/CONFIG/config.xml"
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<palstat>
<globalconfig>
<webserver>URL ADDRESS OF CAQweb MODULE</webserver>
<webapi>URL ADDRESS OF CAQapi MODULE</webapi>
</globalconfig>
</palstat>
Place the other parameters that were previously contained in this file into ../CAQservice/CONFIG/config.xml in the directory of the service itself. Respectively, the application's config.xml file will contain only the following. You will use the same file for CAQdesktop, CAQapi and CAQweb.
".../Palstat3G/CAQdesktop/CONFIG/Config.xml"
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<palstat>
<globalconfig>
<serviceipadress>192.168.0.1</serviceipadress>
<serviceapiport>8001</serviceapiport>
<serviceapicontrol>true</serviceapicontrol>
</globalconfig>
<appconfig>
</appconfig>
</palstat>
It works on the CAQdesktop server, but not on the client stations. Check the basic settings as with any other program that is supposed to communicate on a dedicated port:
This is a rather vague error and is often caused by the absence of .NET4 or the client PC does not have a server with the application included in the local zone, continue with the chapter "Client Installation".
It is called immediately when you try to log in to the application. It is caused by incorrect configuration of the database.enc configuration file or incorrect user settings on the SQL server. As a trial, you can set higher access rights for the user "pal" see. "Creating a user"
It is caused by an invalid key for decoding the license file or connection file.
The connection configuration file is miswritten (not UTF-8) or the message follows the "Decryption error" and it is necessary to resolve the previous error condition first. Or you have a syntax error in the file writing.
The documented problem is the use of the WebDAV module, which is not required for CAQapi or CAQweb, but can be installed on IIS for another project of yours. You need to modify the configuration of this module for Site or Application on IIS for CAQapi/web or remove it from IIS. More details can be found in the discussion thread on stackoverflow.com
Modifying WebDAV handler behavior.
New versions of applications make irreversible changes to the databases when they are updated. Thus, downgrading is only possible at the cost of data loss. Not only must the APL directory be replaced with an older one from the backup, but also the databases corresponding to the respective Palstat 3G version must be restored from the backups. Technically this is possible, but for the reasons described above we do not recommend it.
For each update we recommend to backup the APL directory e.g. to APL.old1, APL.old2... and also backup the database. If you have set up automatic daily backups, a regular backup is sufficient.
If the customer for any reason requires a downgrade with data preservation this will first have to be assessed by the technical director and any SQL modifications and conversions will be charged according to complexity.
In most cases DOWNGRADE can be done one version number back. For example, if you have been sent a new version 2020.02.005 and it is subsequently determined that there is a serious problem that prevents you from using the program to its fullest extent, you can revert to 2020.02.000. This example cannot be applied as a precedent.
In some cases, it is required and necessary to centrally terminate PALSTAT on all stations and prevent users from running PALSTAT again. This is commonly used when performing a SW Upgrade.
Each PALSTAT installation contains a CONFIG directory where you can find the file service.lck.bak By renaming the file to service.lck you will activate the application lock, which has two basic functions.
In some cases, forcing the termination with a lock may not work. Unfortunately, we cannot control this and in case this happens, it is necessary to manually terminate such users or open files on the sharing server.
The content of the file consists of several configuration values. Individual parameters can be commented by placing a semicolon at the beginning of the line.
command=service
runtimemessage=The PALSTAT system is currently undergoing maintenance and the restart will be possible in a few minutes
startmessage=Maintenance of the PALSTAT system is in progress
manager=OMZaccngDiUBADgA
Description of parameters:
You can get the key for the manager parameter from the registers in the
HKEY_CURRENT_USER/Software/PALSTAT.NET pod ID
![]() |
© Copyright 1992 - 2025 PALSTAT s.r.o. |
PALSTAT s.r.o. Bucharova 230 543 02 Vrchlabí CZECH REPUBLIC |
tel.: +420 499 422 044 tel.: +420 499 692 016 www.palstat.cz |
» Home Page » Training » References » News |
» Events » Partners » Support » Contact |
» Products » Customer portal » Remote support » Update |
» Terms and Conditions » Gallery » Map » Portal 2 |