Difference between revisions of "Document conversion"

From PARS
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 8: Line 8:
  
 
The page is accessed via: <br>
 
The page is accessed via: <br>
'''Main Menu > Contact Management > External contact''' <br> <br>
+
'''Main Menu > System management > System > Document converter''' <br> <br>
 +
 
 +
=Troubleshooting=
 +
 
 +
If users are receiving a message stating that the Document Converter is offline or unreachable, then the Document Converter needs to be restarted. The method for restarting the Document Converter depends on the method selected to run it (see below). <br> <br>
  
 
=Configuration=
 
=Configuration=
  
 
The PARS Document Converter is an executable that needs to run on a server that PARS can access. Typically this executable is run on the IIS server hosting PARS but this is not required; the Document Server can be set to run on another server if required. <Br> <br>
 
The PARS Document Converter is an executable that needs to run on a server that PARS can access. Typically this executable is run on the IIS server hosting PARS but this is not required; the Document Server can be set to run on another server if required. <Br> <br>
 +
 +
Google Chrome must be installed on the machine that is going to run the PARS Document Converter. <br> <br>
  
 
===Method 1===
 
===Method 1===
Line 18: Line 24:
 
Method 1 is the default. When a PARS Service Pack is run, the Document Converter will be started on the IIS server. If the Document Converter stops or becomes unreachable you would need to run a PARS Service Pack to restart it. <br> <br>
 
Method 1 is the default. When a PARS Service Pack is run, the Document Converter will be started on the IIS server. If the Document Converter stops or becomes unreachable you would need to run a PARS Service Pack to restart it. <br> <br>
  
To use Method 1, simply select the option then click '''Save'''. <br> <br>
+
To begin using Method 1, simply select the option then click '''Save'''. <br> <br>
 +
 
 +
Using Method 1 you can restart the Document Converter by running a PARS Service Pack, or manually by accessing the server hosting PARS. First open Task Manager. If there is Background Process called "PARS XSLListener" running, kill it. <br> <br>
 +
 
 +
Next go to the ...\_tools\XSLListener folder within the PARS installation directory e.g.: <br>
 +
''C:\inetpub\wwwroot\PARS\_tools\XSLListener'' <br> <br>
 +
 
 +
Run the XSLListener.exe file from this folder to restart the Document Converter. The Document Converter will now run as a Console Application, and must be left running on the server. <br> <br>
  
 
===Method 2===
 
===Method 2===
  
Method 2 is used if you want the Document Converter to run on another server. Some schools experience an issue where the IIS server must be rebooted before the Document Converter will resume correct function. To avoid this situation, the Document Converter can be run as an app on another server. When the Document Converter is run in this way, it can be restarted by closing and reopening the app, rather than restarting the server. <br> <br>
+
The Document Converter will run as a service on the IIS server hosting PARS. This method does not require a Windows account to remained logged in to the server. The Document Converter will be run as a Local System service. <br> <br>
  
To use Method 2 first log on to the server on which you would like the Document Converter app to run. Visit the Document Server page in PARS and select Method 2 then use the '''Download files''' button to download the Document Converter. <br> <br>
+
To begin using Method 2, simply select the option then click '''Save'''. <br> <br>
  
You can extract the Document Converter files to any location on the computer. Run the .exe file to begin the Document Converter, which will close all instances of Google Chrome on the machine. This .exe file can be restarted as and when necessary. If the .exe is closed, the Document Server will be offline. <br> <br>
+
When using Method 2, the only way to restart the Document Server is by running a PARS Service Pack. <br> <br>
  
=Troubleshooting=
+
===Method 3===
  
If users are receiving a message stating that the Document Converter is offline or unreachable, then the Document Converter needs to be restarted. The method for restarting the Document Converter depends on the method selected to run it (see above). <br> <br>
+
Method 3 is used if you want the Document Converter to run on another server. Some schools experience an issue where the IIS server must be rebooted before the Document Converter will resume correct function. To avoid this situation, the Document Converter can be run as an app on another server. When the Document Converter is run in this way, it can be restarted by closing and reopening the app, rather than restarting the server. <br> <br>
  
Alternatively if you are
+
To use Method 3 first log on to the server on which you would like the Document Converter app to run. Visit the Document Server page in PARS and select Method 3 then use the '''Download files''' button to download the Document Converter. <br> <br>
  
There are two methods available to configure the PARS Document Converter.  Each of the methods is described on screen in PARS. Once you have selected and configured a method, use the '''Test''' button to check that the Document Converter is working correctly. <br> <br>
+
You can extract the Document Converter files to any location on the computer. Run the .exe file to begin the Document Converter, which will close all instances of Google Chrome on the machine. This .exe file can be restarted as and when necessary. If the .exe is closed, the Document Server will be offline. <br> <br>

Latest revision as of 11:55, 11 December 2018

The Document Conversion page

The Document Conversion page is used to install and run the PARS Document Converter. This process will convert certain types of documents to PDF. Student Reviews, Behaviour Slips, Detention Slips and Removal Slips are all handled by the Document Converter. PDFs generated via External Contact and reports (either using the Share button or by automating a report) are not affected by the Document Converter.

The following permissions are required to access the External Contact page:
System Management > Access PARS management options (On)
System Management > Manage document conversion settings (On)

The page is accessed via:
Main Menu > System management > System > Document converter

Troubleshooting

If users are receiving a message stating that the Document Converter is offline or unreachable, then the Document Converter needs to be restarted. The method for restarting the Document Converter depends on the method selected to run it (see below).

Configuration

The PARS Document Converter is an executable that needs to run on a server that PARS can access. Typically this executable is run on the IIS server hosting PARS but this is not required; the Document Server can be set to run on another server if required.

Google Chrome must be installed on the machine that is going to run the PARS Document Converter.

Method 1

Method 1 is the default. When a PARS Service Pack is run, the Document Converter will be started on the IIS server. If the Document Converter stops or becomes unreachable you would need to run a PARS Service Pack to restart it.

To begin using Method 1, simply select the option then click Save.

Using Method 1 you can restart the Document Converter by running a PARS Service Pack, or manually by accessing the server hosting PARS. First open Task Manager. If there is Background Process called "PARS XSLListener" running, kill it.

Next go to the ...\_tools\XSLListener folder within the PARS installation directory e.g.:
C:\inetpub\wwwroot\PARS\_tools\XSLListener

Run the XSLListener.exe file from this folder to restart the Document Converter. The Document Converter will now run as a Console Application, and must be left running on the server.

Method 2

The Document Converter will run as a service on the IIS server hosting PARS. This method does not require a Windows account to remained logged in to the server. The Document Converter will be run as a Local System service.

To begin using Method 2, simply select the option then click Save.

When using Method 2, the only way to restart the Document Server is by running a PARS Service Pack.

Method 3

Method 3 is used if you want the Document Converter to run on another server. Some schools experience an issue where the IIS server must be rebooted before the Document Converter will resume correct function. To avoid this situation, the Document Converter can be run as an app on another server. When the Document Converter is run in this way, it can be restarted by closing and reopening the app, rather than restarting the server.

To use Method 3 first log on to the server on which you would like the Document Converter app to run. Visit the Document Server page in PARS and select Method 3 then use the Download files button to download the Document Converter.

You can extract the Document Converter files to any location on the computer. Run the .exe file to begin the Document Converter, which will close all instances of Google Chrome on the machine. This .exe file can be restarted as and when necessary. If the .exe is closed, the Document Server will be offline.