Reform Engine

From FabSoft
Jump to: navigation, search


ReformEngine 01.jpg



Software & Hardware Requirements

Click Here

Software Installation

Network

The most common installation method is to install Reform on a dedicated Windows server. This Reform computer can accept jobs from a multitude of devices.

ReformEngine 02.png


When you download one of the technologies from FabSoft/Downloads the installation routine will automatically install this Reform Base.

Reform Spooler

Overview

The Spooler program is used to monitor jobs generated by your applications. Simply specify the path and the filenames to monitor and the Spooler will constantly watch for output files to process. Anytime a file is generated from your application, the Spooler Program will match it with a form that you have designed and distribute it to the appropriate output device(s).

To open the Spooler, go to: navigate to your desktop and open folder FabSoft Reform, then the Base then Reform Spooler

ReformEngine 19.png

Spooler Interface

Start / Stop  

ReformEngine 20.jpg
ReformEngine 21.jpg

Press Start to begin the monitoring process. Press Stop to end the monitoring process. When the Spooler is running, it is constantly monitoring your chosen directory for new files to process.

Refresh Form List  

ReformEngine 22.jpg

Use this button to refresh the list of available forms or workflows files, in the forms directory this typically automatically done. When this is done, the newly created form will appear in the list. The Spooler will not be able to use a form if it is not listed.

Setup Reform Spooler  

ReformEngine 23.jpg

Open the Spooler’s Setup dialog box to modify settings for the Reform Spooler.

Process Results

ReformEngine 24.png

When a print job is successfully processed, the bottom window of the Spooler interface will display the message ’Last Processed:’, followed by the name of the form that was used and the date and time of the print job.

How the Spooler Works

The Spooler, while it is running, constantly monitors your chosen Spooler directory for changes. If it detects a new file, it will attempt to match that transaction up with a form/workflow and process it. The transaction will only be picked up if they pass the Spooler filter parameter (which can be set up from the Spooler at File>Setup>Spooler Parameters Setup Wizard). The Setup Wizard will guide you through the process of configuring the Spooler parameters, and provide detailed explanations with each step.

Once the file meets the filter selection criteria, the Spooler needs to match it to a form/workflow. A transaction can be of type Text/ASCII, PCL Script, Postscript, or any other windows format. The Spooler chooses the form for these transaction files using three different methods in the following order:

1. The Spooler opens the transaction file and searches through its list of Form Keys to find the proper form/workflow to use. See the Form Key section of this document for more information on how to configure these objects on Forms.

2. The Spooler attempts to match the transaction file with a form of the same name. If a report is printed to a file called ORDER.OUT in the C:\Reform…\Spooler directory, the Spooler looks for a corresponding ORDER.FOM file in C:\Reform…\Forms. If it finds the related form, it will open ORDER.OUT and ORDER.FOM for processing. The Spooler also checks for partial matches of the file names. For example if the file in the Spooler folder was named ORDER72563.out, it could also match the form named ORDER.FOM. Partial matches will use the form with the name most similar to the beginning of the text file name. Note: If a Form Key Field exists on the ORDER.FOM form, it will not be checked since the Spooler already matches the file names.

3. If the output file does not meet the criteria for the first two methods, the default form (default.fom) will be used. If the default form does not exist, the Spooler will ignore the output file and the print job will not be processed.

Once the Spooler has completed steps 1, 2 or 3 above, the transaction file will be copied to the \Reform…\Backups directory, and the file in the Spooler directory will be deleted. The backup file is helpful for troubleshooting purposes.

Note: Upon writing the current transaction file to the Backups directory, if a file with the same name is already in the directory, the older file will be overwritten. The built-in Health Monitor will delete the files in the backup directory after a period of time.

File Menu

Setup—Launches Spooler configuration page.

Audit All Forms—This compiles a text file of all of your forms and information about them, such as send-to device, page-process scripts, and attachment information.

Setup Purge Backups Schedule—This window allows you to set a schedule to clean out backup files in the \Reform\Backups folder. This is especially useful if you are processing a large amount of files as the backups folder can tend to get large. This feature is also available in the built-in Health Monitor.

Purge Backups—This option will delete all files in the \Reform\Backups folder.

Start Minimized—Enable/disable this option to determine if the Spooler interface should start as a window, or minimized to the system tray.

Exit—Exits the Reform Spooler. Keep in mind that if the Spooler is started and running as a service, exiting the Reform Spooler interface will not stop the service from monitoring and processing Spooler files.

Add Spooler Service Instance—Displays a wizard that installs a new Reform Spooler service with the specified credentials and Spooler path. Creating multiple Spooler Instances allows Reform to monitor and process multiple directories simultaneously.

Edit Spooler Service Instance—Displays a wizard that configures the highlighted service’s credentials or Spooler path.

Action Menu

Start—Starts the highlighted Spooler Instance and begins monitoring the Spooler directory for files to process.

Stop—Stops the highlighted Spooler Instance and stops monitoring for files.

Start All—Starts all of the Spooler Instances and begins monitoring the Spooler directories for files to process.

Stop All—Stops all of the Spooler Instances and stops monitoring for files.

Remove Selected Service—Removes and Uninstalls the selected Spooler Service Instance.

Log Menu

Detail Log—Toggles the Detail Log option. When enabled, more information about each print stream that is processed is written to the log. It will tell you which print stream has been matched up with which form, whether or not a Form Key was detected, etc. If the Detail Log option is Disabled, it will only write to the log when a print stream has been processed. This option is useful for debugging print streams not correctly being matched up to forms.

Save Log Result—On the Process Results tab, this option will save the log’s contents to a text file.

View Log File—Displays the log file in an external text editor, ie. Windows Notepad.

Clear Log File—Clears the results in the log file.

Setup

General


Go to File>Setup to open the Spooler configuration panel. It is recommended that all these directories are on the local computer.

ReformEngine 25.png

Default Spooling Directory

This specifies the location that the Spooler will be monitoring for files. The Spooler will only check for files that meet the criteria set in the Spooler Parameters Setup Wizard. Note: Individual instances are configured with separate Spooler folders when created.

Form Directory

This is where the forms that the Reform Spooler monitors are stored. Every time the Reform Spooler starts, it gathers all available forms from this location and adds them to the list of available forms. Thus, any forms saved in this directory are considered Active forms. Whenever it finds a file to process, the Spooler opens the corresponding form (.FOM). Then, it processes the information and deletes the processed file upon completion.

***IMPORTANT: Forms can only be edited using the VDP Designer or the Workflow Designer and requires the VDP Plug-in.

Output File Backup Directory

This is where the Spooler backs up the latest processed output files. The backup output file is used for designing forms. In order to change the Backup Directory, simply click on the button beside the control and select the appropriate directory.

Image Directory

This is where Reform looks for pictures when Image / Image Linked objects are used. All image files should be stored in this location so that Reform can display the pictures.

Queue Directory

This is where some of the Plug-ins configuration settings and temporary files are stored.

Error Directory

This is where the failed process files are stored.

User Interface Language

Select the default language.

Backup Output Files

Check this selection if you would like the Reform Spooler to store a copy of each processed file into the Reform\Backups\ directory. If unchecked, processed output files will not be available in the backup directory for later retrieval. Once a system is running in production, it is recommended to disable this option to avoid using unnecessary hard drive space. Note: The Health Monitor application installed with Reform is also capable of maintaining the folders to avoid file buildup.

Show Printing Status / Show Printing Detail

Show Printing Status is useful in cases where you need to be informed of what Reform is processing.

To setup the spooler monitoring filter, click the "Spooler Parameters Setup Wizard" Button:

Spooler Parameters

ReformEngine 26.png

Spooler Parameters - Define Monitoring Filter

ReformEngine 27.png

The window information details the settings configured by the wizard.

Caution: If you change the Spooler directory to a location containing other types of files, make sure you set the filter to process only the files that are designed for the Reform Spooler; otherwise, the other files may become corrupted.

Spooler Parameters - Queue Intervals

ReformEngine 28.png

Clicking Finish will take you back to the Spooler Setup Page.

Advanced

Character Filter-- Here you can enter the ASCII values for any characters that you want removed from the beginning of the file. This is especially useful if your print streams are inconsistently inserting spaces at the tops of some pages. Use this option with Replace Range.

Replace Range--This specifies how many characters to check against the character filter list to see if they should be replaced.

Reform Spooler Service

The first time you run the Reform Spooler, it will automatically install the Reform Spooler Service into your System Services. To view your system’s services, go to Start > Control Panel > Administrative Tools > Services. Locate the Reform Spooler Service in the services list, as shown below. The Service name is formatted as "RM_Reform15_Spooler_***", where the asterisks indicate the instance name.

ReformEngine 29.png

Double-click Reform Spooler Service to bring up the Reform Spooler Service Properties dialog. In this dialog you can set various preferences that will change the way the service operates.

ReformEngine 30.png

To allow the Spooler to start automatically when the system is turned on, select Automatic from the Startup Type drop-down list. Note: Reform is set to Automatic by default.

ReformEngine 31.png

Next you need to update the login properties so that the Reform Spooler Service will be run under an administrative account. Click on the LogOn tab. Select the This Account option.

ReformEngine 32.png

Click on the Browse button. Here you must select the domain that you will be logging on under.

ReformEngine 33.png

Click the Locations button and select the domain or local computer. Click OK. In the Select User window (shown above), type in the username of the account that has administrative privileges on this machine and click Check Names to verify that you entered it correctly and check it for validity. If it shows up underlined, click OK.

Note: For the service to run as the user you just entered, the administrator must have been logged on to the current machine at least once. This will make sure the account has been given sufficient permissions and the profile has been set up properly.

Back in the properties window, enter the password for the account in both boxes. Click Start to start the service. Note: For uninterrupted use of Reform, the account’s password should be configured to never expire.

ReformEngine 34.png

Click OK. Restart the service to ensure the new account is used and the credentials are valid. You can now close out of the services window.

Adding instances to the Reform Spooler

Reform has the ability for the administrator to create additional instances of the Reform Spooler. Each additional spooler service monitors its own directory maximizing the throughput of the workflow environment. However, the throughput is limited by the server’s hardware. Listed below are the steps to add an instance to the spooler in Reform. (For demonstration purposes, the instance named RM_Reform…_Spooler_2 will be added.)

1. Browse to the …\Program Files\ Reform… folder and select New Folder from the menu.

ReformEngine 35.png

2. Rename the new folder to Spooler2.

ReformEngine 36.png

3. Go to Start > Programs > Reform PDC > Reform Spooler.

ReformEngine 37.png

4. Select the File menu, and then click Add Spooler Service Instance from the menu.

ReformEngine 38.png

5. Enter the instance name, and then click next. Multiple instances cannot have the same name.

ReformEngine 39.png

6. Enter the account’s domain\username and the account password. Then click Next. Note: The account requires the "Log on as a Service" right. For simplicity, the same account is typically used for all instances.

ReformEngine 40.png

7. Specify the full path of the Spooler2 folder that was created in the previous steps, and then click Finish.

ReformEngine 41.png

8. An alert dialog indicating that RM_Reform…_Spooler_2 was installed successfully will be displayed. Click Ok.

ReformEngine 42.png

9. Once installed, RM_Reform…_Spooler_2 will be listed under Service Instance of the Spooler Services tab.

ReformEngine 43.png

10. Highlight RM_Reform..._Spooler_2 and then click the start button. This will start the service.

ReformEngine 44.png

11. RM_Reform…_Spooler_2 will be installed as a service on the local server.

ReformEngine 45.png

If the new service does not start, try re-entering the service user and password.

Removing an Instance of the Reform Spooler

Reform has the ability for the administrator to remove instances from the Reform Spooler. Listed below are the steps to remove an instance from the spooler in Reform. (For demonstration purposes, the instance named RM_Reform.._Spooler_3 will be removed.)

1. Select RM_Reform..._Spooler_3 and then click the stop button. This will stop the service for the selected instance.

ReformEngine 46.png

2. With RM_Reform..._Spooler_3 still highlighted, select the Action menu, and then click Remove Selected Service from the menu.

ReformEngine 47.png

3. A prompt will be displayed to confirm that you would like to remove the instance. Click yes to remove the spooler service.

ReformEngine 48.png

4. An alert dialog indicating that RM_Reform..._Spooler_3 was uninstalled successfully will be displayed. Click Ok.

ReformEngine 49.png

5. RM_Reform..._Spooler_3 has been removed from under the Server Instance list of the Spooler Services tab.

ReformEngine 50.png

6. RM_Reform..._Spooler_3 has been removed from the Services list on the local server.

ReformEngine 51.gif

7. The final step is to manually delete the Spooler Folder of the Instance that was removed. (Note: before deleting the folder, it is recommended to confirm no data within it is needed.) Browse to the folder’s location, and Right Click on the Spooler3 folder. Click delete.

ReformEngine 52.gif

Health Monitor

The Reform Health Monitor and Maintenance Utility contain various tools to help you monitor and maintain the status of Reform, MOST, and all of their Plug-ins. It is a valuable resource for automating the upkeep involved with having a server or workstation with Reform on it.

To open the Health Monitor, Go to Start > Programs > Reform… > Monitoring > Health Monitor.

ReformEngine 53.png

To generate a comma-separated values file of the Health Monitors current settings, click Generate CSV File at the bottom of the main screen. The CSV file will be generated, automatically opened in Notepad, and saved in the same directory as Health Monitor.

If the Health Monitor service, used for cleanups and monitoring, is not installed, you can do so by clicking Install Service at the bottom of the main screen. If you click it and the service is installed, an error message will inform you. Note: The Health Monitor service is installed by default with Reform.

To exit the Health Monitor, select Exit Setup in the bottom left corner of the main window.

General Configuration

You can set the Enable Logging drop down menu under General Configuration of the main window to TRUE or FALSE. When set to TRUE, Health Monitor will record its actions in log files in Reform…\Backups\Logs. When set to FALSE it will not. It is recommended this be set to TRUE during configuration/testing and production.

The Startup Delay text box in the General Configuration section of the main window will delay the Health Monitor that many seconds after starting before it will begin monitoring the system. This is to ensure the system is fully started and helps avoid alerts caused by the system startup process (services starting, network connections setting up, etc). The suggested value is 300 seconds (5 minutes). Once you have typed a value, click Apply Changes in the bottom right corner of the main window.

Cleanup Configuration

The Health Monitor can clean up directories and database tables to conserve space.

In the Time to Run drop down menu, you can specify what time cleanup will run daily, in twenty-four hour format. You can also select hourly if you want cleanup to run every hour instead of once a day. Once you have made your selection, click Apply Changes in the bottom right corner of the main window.

Modify Directory Configurations

Directory Cleanup can search for old files and delete them. To set up directory cleanup, look under the Cleanup Configuration section in the main window and click Modify Directory Configurations. You will see a list of directories configured to be cleaned up and some that are DISABLED.

ReformEngine 54.png

To edit or view a specific directory’s settings, you can select that directory and click Edit. You can also click New to configure a directory for cleanup. If you select new, please enter a description for the directory and click Ok.

ReformEngine 55.png

You will then be taken to the Directory Settings window to configure the directory for cleanup.

ReformEngine 56.png

In the settings window, you can specify the settings used to determine which files will be deleted by the Health Monitor. Below is a description of each setting.

  • Directory: Will contain the path of the directory that will be monitored. You can specify a directory to monitor by typing its name in the Directory box, or by clicking the Browse button next to it and selecting one.
  • Filter: Specifies what kind of files to delete. For example, *.* will delete all files with any extension, *.log will delete any file with the log extension, and error.log will only look for the file named error.log. You can specify multiple filters by separating them with commas.
  • Days Old: Enter the number of days. Files older than the specified number of days will be deleted.
  • Clean Sub Dirs: Set Clean Subdirectories to TRUE or FALSE to allow deleting of files in a subdirectory. If it is set to TRUE, any folders inside the directory will also be searched for files to delete. If it is set to FALSE, they will not.
  • Delete Empty Sub Dirs: When this is set to TRUE, empty subdirectories inside of the directory will be deleted when the folder is scanned. If it is set to FALSE they will not.
  • White List: The White List is filter for files not to be deleted, even if they otherwise meet the criteria. Type any files or a filter for files that you wish not to be deleted by cleanup in the White List Box, using the same format as the filter box. As before, you can specify multiple files and/or filters if they are separated by commas.
  • Enabled: Set Enabled to TRUE to have this directory rules run, or to FALSE to not have it run at the specified time.

Click Run Rule Now to run this rule immediately with the specified settings.

Click Save to save your settings and return to the list of directory cleanups. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Modify SQL Configurations

Database Cleanup can look for old database entries and delete them. To configure database cleanup, look under the Cleanup Configuration section in the main window and click Modify SQL Configurations. You will see a list of database tables set to be cleaned up.

Note: The Health Monitor can only clean up tables with at least one datetime type column.

ReformEngine 57.png

To edit or view a specific SQL table, you can select that SQL table and click Edit. You can also click New to configure a SQL table for cleanup. If you select new, please enter a description for the SQL table and click Ok.

ReformEngine 58.png

You will then be taken to the SQL Settings window to configure the SQL table for cleanup.

ReformEngine 59.png

In the settings window, you can specify how to delete old database entries.

  • Connection: In the connection box, type FSMonitorDataSource. This is the default value used by Reform. If your database was configured differently, type the correct value for your setup instead.
  • Table Name: Click Get Tables under the Connection box. The Table Name drop down menu should now have all of the Reform database tables listed in it. Select the one to cleanup.
  • Log Table Size: Set the Log Table Size drop down menu to TRUE or FALSE. If it is set to TRUE, Health Monitor will record the size of the selected table when it is creating the log for this cleanup. If it is set to FALSE, it won’t.
  • Date Column: Click Get Columns. The Date Column drop down menu should now have every column in the table that is the datetime type. Select the one that will be used to determine the entries’ ages.
  • Days Old: Type how many days old the entries can be before they will be deleted. Entries older than this number will be deleted during cleanup, as determined by the Date Column.
  • Custom SQL Conditions: You can type Custom SQL Conditions, if you only want certain entries to be deleted. These will be placed in the WHERE portion of the DELETE SQL query. For example, you can type "Username <> ’admin’ " if you want entries from the user admin to not be deleted. Be sure to use proper SQL syntax.
  • Enabled: Set Enabled to TRUE to make this cleanup run, or to FALSE to not have it run at the specified time.

Click Run Rule Now to run this rule immediately with the specified settings.

You can click Preview SQL if you would like to see the SQL query that will execute when this cleanup runs. It will also show you how many database entries would be affected by the query if it were executed now.

Click Save to save your settings and return to the list of database rules. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Monitor Configuration

In the main window under the Monitor Configuration section, click Modify Monitor Configurations to show the Monitor Settings window.

ReformEngine 60.png
ReformEngine 61.png

These options allow you to monitor the states of printers, directories, services, drives, database tables, ports, and server performance.

To set how often monitoring occurs, type a number in the Minutes between monitoring box. The Health Monitor will check every monitor set up from this panel regularly, waiting that number of minutes in between. The suggested value is 5 minutes. When you have typed a value, click Apply.

Printer Configurations

Printer Monitoring can see if a printer has too many jobs backed up in the queue. To set up printer monitoring, click Printer Configurations in the Monitor Settings window.

ReformEngine 62.png

To edit or view a specific printer, you can select that printer and click Edit. You can also click New to configure a printer for monitoring. If you select new, please enter a description for the printer and click Ok.

ReformEngine 63.png

You will then be taken to the Monitor Printer Settings window to configure the printer for monitoring.

ReformEngine 64.png

In the settings window, you can specify how to monitor a printer.

  • Remote Server: You can choose to monitor a printer on another server by entering the fully qualified domain name of that remote server here.
  • Printer: You can select a printer from the Printer drop down menu. Here you should see all printers installed on your machine (or the remote server if a name is typed in the above field).
  • Job Limit: Type a number in the Job Limit box. If the number of jobs in the queue is above this number when the monitor is checking, a warning will be generated in the Event Log.
  • Enabled: This value can be set to TRUE to enable monitoring or to FALSE to not have it monitor.

To see how many jobs the selected printer currently has, you can click Refresh Printer Job Count.

Click Save to save your settings and return to the list of monitored printers. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Directory Configurations

Directory Monitoring can see if directories contain files that are too old. To set up directory monitoring, click Directory Configurations in the Monitor Settings window. You will see a list of directories being monitored.

ReformEngine 65.png

To edit or view a specific directory, you can select that directory and click Edit. You can also click New to configure a directory for monitoring. If you select new, please enter a description for the directory and click Ok.

ReformEngine 66.png

You will then be taken to the Monitor Directory Settings window to configure the directory for monitoring.

ReformEngine 67.png

In the settings window, you can specify how to monitor a directory.

  • Directory: Specify a directory to monitor by typing its name in the Directory box, or by clicking the Browse button next to it and selecting one.
  • Filter: Specify what kind of files to monitor for under filter. For example, *.* will monitor all files with any extension, *.log will monitor for any file with the log extension, and error.log will monitor for only the file named error.log. You can specify multiple filters if they are separated by commas.
  • Minutes Old: Files that are found in this directory that are older than this specified value will write a warning in the Event Log when monitoring occurs.
  • File Count Limit: If the directory is found to have more files than this specified value when monitoring occurs, it will write a warning in the Event Log.
  • Enabled: This value can be set to TRUE to enable monitoring or to FALSE to not have it monitor.

You can see how many files are currently in the selected directory by clicking Refresh Directory File Count.

Click Save to save your settings and return to the list of monitored directories. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Service Configurations

Service Monitoring can check the status of a service. To set up service monitoring, click Service Configurations in the Monitor Settings window. You will see a list of services being monitored.

ReformEngine 68.png

To edit or view a specific service, you can select that service and click Edit. You can also click New to configure a service for monitoring. If you select new, please enter a description for the service and click Ok.

ReformEngine 69.png

You will then be taken to the Monitor Service Settings window to configure the services for monitoring.

ReformEngine 70.png

In the settings window, you can specify how to monitor a service.

  • Remote Server: You can choose to monitor a service on another server by entering the fully qualified domain name of that remote server here.
  • Service: Select a service to monitor on your machine (or the remote server if a name is typed in the above field) from the Service drop down menu. Here you will see all of the installed services listed.
  • Auto Start: Set Auto Start to TRUE to automatically turn on this service if it stops.
  • Enabled: This value can be set to TRUE to enable monitoring or to FALSE to not have it monitor. If set to TRUE and the service is stopped when monitoring occurs, a warning will be written in the Event Log.

You can check the current status of the selected service by clicking Check Service Status.

Click Save to save your settings and return to the list of monitored services. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Drive Space Configurations

Drive Monitoring can see if a disk drive has too little free space. To set up drive monitoring, click Drive Space Configurations in the Monitor Settings window. You will see a list of drives being monitored.

ReformEngine 71.png

To edit or view a specific drive, you can select that drive and click Edit. You can also click New to configure a drive for monitoring. If you select new, please enter a description for the drive and click Ok.

ReformEngine 72.png

You will then be taken to the Monitor Free Drive Space Settings window to configure the drive for monitoring.

ReformEngine 73.png

In the settings window, you can specify how to monitor a drive.

  • Remote Server: You can choose to monitor a drive on another server by entering the fully qualified domain name of that remote server here.
  • Drive: Select a drive from the Drive drop down menu. Be aware that all drive letters are in the list, not just mounted ones. You must select an existing, local, NTFS formatted drive to work.
  • Limit(GB): Enter a number for Limit, in gigabytes. If the free space on the selected drive is below this number of gigabytes when the monitoring occurs, a warning will be written in the Event Log.
  • Enabled: This value can be set to TRUE to enable monitoring or to FALSE to not have it monitor.

You can check how much space is currently free on the selected drive by clicking Check Drive Space. If there is a problem finding the drive, you will get an error notification. If the drive can be found, but is not local or NTFS, then the free space will be reported as 0.

Click Save to save your settings and return to the list of monitored drives. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Database Configurations

Database Monitoring can see if Reform database tables have entries that are too old. To set up database monitoring, click Database Configurations in the Monitor Settings window. You will see a list of database tables being monitored.

ReformEngine 74.png

To edit or view a specific database table, you can select that database table and click Edit. You can also click New to configure a database table for monitoring. If you select new, please enter a description for the database table and click Ok.

ReformEngine 75.png

You will then be taken to the SQL Settings window to configure the database table for monitoring.

ReformEngine 76.png

In the settings window, you can specify how to monitor a database table.

  • Connection: In the connection box, type FSMonitorDataSource. This is the default value used by Reform. If your database was configured differently, type the correct value for your setup instead.
  • Table Name: Click Get Tables under the Connection box. The Table Name drop down menu should now have all of the Reform database tables in it. Select the one to monitor.
  • Date Column: Click Get Columns. The Date Column drop down menu should now have every column in the table that is the datetime type. Select the one that will be used to determine the entries’ ages.
  • Minutes Old: Type a number for Minutes Old. Entries in the selected table that are older than this will write a warning in the Event Log when monitoring occurs.
  • Custom SQL Conditions: You can type Custom SQL Conditions, if you only want certain entries to be monitored. These will be placed in the WHERE portion of the DELETE SQL query. For example, you can type "Username <> ’admin’ " if you want entries from the user admin not to be monitored. Be sure to use proper SQL syntax.
  • Enabled: Set Enabled to TRUE to make this cleanup run, or to FALSE to not have it run at the specified time.

You can click Preview SQL if you would like to see the SQL query that will execute when this monitoring runs. It will also show you how many database entries are returned by the query now.

Click Save to save your settings and return to the list of Database Monitoring rules. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Port Configurations

Port Monitoring can check connections to specified ports at an IP Address. To set up port monitoring, click Port Configurations in the Monitor Settings window. It is recommended to use Ping Monitoring for Reform servers and other Reform connections.

ReformEngine 77.png

To edit or view a specific port, you can select that port and click Edit. You can also click New to configure a port for monitoring. If you select new, please enter a description for the port and click Ok.

ReformEngine 78.png

You will then be taken to the Monitor Port Settings window to configure the port for monitoring.

ReformEngine 79.png

In the settings window, you can specify how to monitor a Port.

  • IP Address: Type the IP Address of the device you would like to check the port of.
  • Port Number: Type the port number you would like to monitor.
  • Timeout: Amount of time (milliseconds) that will be waited for response from port before timing out.
  • Enabled: This value can be set to TRUE to enable monitoring or to FALSE to not have it monitor.

You can click Check Port if you would like to see status of the selected port.

Click Save to save your settings and return to the list of Ports. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

Ping Configurations

Ping Monitoring can monitor the ping response of Reform servers and other IPs (SQL server, Email server, …). To set up ping monitoring, click Ping Configurations in the Monitor Settings window.

ReformEngine 80.png

To edit or view a specific ping, you can select that ping and click Edit. You can also click New to configure a ping for monitoring. If you select new, please enter a description for the ping and click Ok.

ReformEngine 81.png

You will then be taken to the Monitor Ping Settings window to configure the ping for monitoring.

ReformEngine 82.png

In the settings window, you can specify how to monitor a ping.

  • IP Address: Enter the IP address you wish to ping in the IP Address box.
  • Max Response Time: Enter a time (milliseconds) for Max Response Time (-1 is no limit). If a response takes longer than this time, Health Monitor will stop waiting and treat it as a failed connection.
  • Enabled: This value can be set to TRUE to enable monitoring or to FALSE to not have it monitor.

You can see the results of pinging the selected IP address by clicking Check Ping.

Click Save to save your settings and return to the list of pings. You can also click Cancel to discard any changes you made since entering the settings window, or Delete to remove the settings entirely from the list.

SMTP Email Alert Configuration

Email monitoring can send emails with information about monitor events out as an email. To set up monitor emails, click SMTP Email Alert Configuration. It is recommended that the Event Log Monitor program be used instead for greater functionality and flexibility. See the Event Log Monitor section of this document for more information.

ReformEngine 83.png
  • SMTP Server: Enter your SMTP server address
  • Port(optional): Enter the port address used by the SMTP server
  • Email To: Email address that will receive information about monitored events.
  • Email From: Dedicated email address that used to send out monitored events emails.

Configure Server Performance Monitor

Benchmark Testing can regularly run tests on a server for speed and connectivity. To set benchmark test settings, click Configure Server Performance Monitor on the Monitor Settings Screen. By default all tests are disabled. It is recommended that these tests are disabled in production.

ReformEngine 84.png

Configure MOST Monitor Settings

Spooler Balancing can monitor your Reform Spooler folders for files that are taking longer than expected to be processed and move them to a different spooler. To set spooler balancing settings, click Configure MOST Monitor Settings on the Monitor Settings Screen.

ReformEngine 85.png
  • Enable Balancing Directories: Set Enable Balancing Directories to TRUE or FALSE. When set to true, the spoolers will be monitored. When set to false, it will not.
  • Minutes old before moving files in the spooler folders: Enter a time in minutes a file will be in a spooler before being moved to another spooler.
  • Minutes between checking spooler directories: Enter the time in minutes between monitors of the spooler directories
  • View MOST Clients: Click View MOST Clients to see a list of devices using MOST

Reform Database Connection

Under Reform Database configuration, click on Modify Database Configuration to edit Reform’s default database connection.

ReformEngine 86.png

This is set to a default value that will access Reform’s standard tables that are created when it installs. This should only be edited if you are sure that you are connecting to a database other than the default one installed with Reform.

Reform Service Configuration

Service Configuration can set the accounts and startup settings of Reform services. Under Reform Service Configuration, click on Modify Service Settings to see all services associated with Reform and modify their properties. To see the most up to date list of services, click Refresh List.

ReformEngine 87.png

This window lists all services associated with Reform, MOST, and their Plug-ins. It contains their names, current statuses (running or stopped), startup modes (automatic, automatic delayed, manual or disabled), file version, and which account the service runs as.

To change the account that a service runs under, select the service and click Change Service Account under Selected Service, then enter the account’s username and password. To change the account for all services listed, click Change All Service Accounts under All services, and enter the account’s information

To start a service, select it and click Start Service under Selected Service. To start all services listed, click Start All Services under All Services.

To stop a service, select it and click Stop Service under Selected Service. To start all services listed, click Stop All Services under All Services.

To change a service’s startup mode, select the service and select a mode from the Set Service Startup to dropdown menu under Selected Service. Automatic means the service will start up with the server, Automatic Delayed means the service will start up with the server but will be delayed, Manual means the service will be stopped to begin with and must be started up on the server, and Disabled means that the service cannot be started (it must be changed to another startup mode to be started).

Backup / Restore

Backup or Restore allows you to backup all of the files in the Reform directory, and later restore Reform to the state you previously backed up. To backup or restore Reform, click Backup or Restore in the Backup/Restore section on the main window.

ReformEngine 88.png

To backup the Reform files, select Backup Files and click Next. The wizard will guide you through the process and back up your files.

ReformEngine 89.png

Checking Keep Old Backup Folders will keep old backups from previous times this feature was executed.

You will receive a confirmation popup when back up is complete.

ReformEngine 90.png

To restore Reform to a state you have previously backed up, select Restore Files and click Next. This option will only be available if you have previously created a backup of your Reform directory using the Health Monitor.

ReformEngine 91.png

Select a restore point. You can then click Compare Restore Point To Current Files to see what changes have occurred between the time you backed up Reform and now (you can also do this with Compare Reform Folders). You can click View Comments to see any comments made when backing up Reform at that point. Click Next and the wizard will guide you and restore Reform to your selected backup point.

Compare Reform Folders

Compare Reform Folders can compare the files in two folders containing releases of Reform and/or Reform backups. To open Compare Reform Folders, click Compare Reform Folders in the Backup/Restore section on the main screen.

ReformEngine 92.png

Select two folders to compare by typing them in or clicking Browse and finding them in the file directory. Click Compare and Health Monitor will compare the two of them, showing added, deleted and modified files.

Miscellaneous

In Miscellaneous Tools, you can get system information, see logged in users, do a benchmark test, show running processes, show share permissions, show port info, create a test event in the event log, compile a script into an executable, and test the pause functions. To see the miscellaneous tools, click Miscellaneous Tool in the Miscellaneous section on the main screen.

ReformEngine 93.png
  • System Information: Displays a list of system information
  • Display Logged In Users: Lists the users that are currently logged in
  • Benchmark Test: Tests server performance
  • Display Running Processes: Displays a list of all the processes currently running
  • Display Share Permissions: Displays a list of all the shared information
  • Verify Licenses: Displays the license information of Reform/MOST Plug-ins
  • File Search: Can search a directory for a specific file(s)
  • Display Port Information: Displays a list of ports being used
  • Create Event Entry: Tests writing to the Event Log
  • Compile a Script: Compiles a script into an executable
  • Test the Pause Functions: Used to test the results of using a pause function
  • Inspect Server Configuration: Displays a list of server information
  • LDAP User Query: Tests a specified LDAP query
  • Printer Driver Info: List of information on printer drivers

Event Log Monitor

The Event Log Monitor is a program that will send alert emails to any number of email addresses when something is written into the Event Log by an application that is being monitored. You can monitor the status of Reform, MOST, and all of their Plug-ins as well as any other programs. This can be very beneficial because email notifications will be sent immediately when an issue occurs on the server.

To open the Event Log Monitor, Go to Start > Programs > Reform… > Monitoring > Event Log Monitor. If you are using Windows Vista, 7, 8, Server 2008, or Server 2012, make sure that you run the Event Log Monitor as Administrator (right click and select "Run as Administrator") to ensure full functionality.

*Note: If you open the program and the service has not been installed yet, it will ask you if you want to install the Event Log Monitor Service, click Yes.

The Event Log Monitor will open and the Service will get installed. To see the service please go to Start > Programs > Administrative Tools > Services.

ReformEngine 94.png

General Configuration

The first time the Event Log Monitor configuration is opened, it will prompt for a recipient email address. This address is used to populate the preconfigured rules installed with Reform. It is suggested to enter the desired recipient of the alerts at this time to simplify the setup.

ReformEngine 95.png

If the Email sender or server information has not yet been configured, you will be prompted to enter this information. Clicking Yes will bring you to the "Email" tab on the interface to fill the required fields.

ReformEngine 96.png

The Event Log Monitor contains two tabs for configuration; Filters and Email. Configure the Email tab first and then you can add the filters.

ReformEngine 97.png

Email

The Email tab has several settings, all of which are explained below.

ReformEngine 98.png

1. Server Address - This field will contain the Email Server Address (IP).

2. Port - The port used by the Email Server (Usually 25 for SMTP). If the email server requires a Secure connection, click the checkbox next to Port.

3. User Name - If the email server requires authentication, enter the Username here.

4. Password - If the email server requires authentication, enter the Password here.

5. Email From - Here you will add an Email From address that will be used to send out the notifications.

6. Subject - This will contain the Subject of the Emails that will be sent. By using the words shown below, such as %LEVEL%, the subject can be changed automatically showing exactly what type of Level has occurred.

7. Message - This will contain the message of the issue that occurred. The recommended Subject Line and Message are shown next:

Subject : An %LEVEL% has occured in %APPNAME% on %SERVERNAME%.

Message:

Server: %SERVERNAME%

Application: %APPNAME%

Date: %DATE%

Time: %TIME%

EventID: %EVENTID%

Level: %LEVEL%

Message: %MESSAGE%

After filling in the fields with the correct information, click Save.

ReformEngine 99.png

Tip: To copy the settings from the EventLogMonitor from Server 1 to Server 2 please copy the file from Reform…\Plugins\Monitoring\Settings.xml and paste it into the same location on the second server.

Filters

Now that the email server information is entered into the Email tab, we can setup filters.

ReformEngine 100.png

1. Log - You will need to select the type of Event Log that you would like to monitor the events from, and then choose it in the Log drop down menu.

2. Email Address - Add the Email Address that will receive the notifications. Multiple addresses may be used, just comma separate them.

3. Application Name - In the application name you will need to add the application name exactly as it is reported into the Event Log (reforment, Reform Email Monitor, ReformLicenseMgr, etc).

4. Level - In the level tab select the type of events you would like to receive emails for (Error, Warning, Information, or leave it blank to receive ALL events from this application).

5. Event ID - You can monitor for a specific event ID by entering it into the Event ID tab.

6. Message Contains - You can monitor for a specific word or phrase in the event message.

7. Do not monitor event - This checkbox will allow you to filter out certain events and they will not be emailed out (Example: By entering Event ID 100 on the Event ID section and checking the ’Do not monitor this event’, you will cause emails to NOT be sent whenever Event ID 100 is thrown by the specified application).

Once you have filled in the correct information, please click Add Filter. You should then see the filter listed above. You can repeat this process for as many filters as you would like.  Click Save when you are finished.

ReformEngine 101.png
ReformEngine 102.png

*Note: If you want to add Application Names for MOST, please select MOST from the Log dropdown and then add the filter.

In order to edit a filter you will have to add a new filter and delete the old filter. Start by selecting the specific filter you want to edit from the list, modify the information and click Add Filter, then highlight the original and click Remove Filter.

The steps below show an example of this procedure by changing the monitored application from reforment to Reform Email Monitor. Select the filter for reforment.

ReformEngine 103.png

Change any of the settings in the Add a Filter box and when you are done editing, click Add Filter, as shown below. By doing this, a second filter will be added to the list as shown below.

ReformEngine 104.png

You can then delete the original filter by selecting the filter from the list and then click Remove Filter.

ReformEngine 105.png

Now, only the new updated filter should be on the list. Click Save when you are finished.

ReformEngine 106.png

Testing Configuration

It is recommended to use the Event Log Monitor along with the Health Monitor. Please refer to the Health Monitor section in this User Manual for configuring the Health Monitor. If the Health Monitor is already configured, please stop a service that is being monitored by the Health Monitor and check if the email notification is being sent by the Event Log Monitor. As soon as the service is stopped, the Event Log Monitor will send an email to the address specified in the Filter tab, informing the email recipient of the event. In our case, an email was sent alerting someone that a service was stopped on a particular server.

SQL Recovery Process Service

Recovery files (.REC) are created by some of the Reform services and/or scripts when a SQL query fails. This service resubmits the queries until SQL becomes available again.  If a recovery query fails, the service writes to a log file and then will try again to resubmit after a short period of time.  If the recovery query is successful, the .REC file and log files for that submission will be moved to the Reform…\backups folder.

The RM_SQL_Recovery_Process service monitors these folders for recovery files:

Reform…\Plug-ins\SQL_Recovery\

If the Tracker Plug-in is installed, this folder is also monitored:

Reform…\Plug-ins\Tracker\ClientMonitor\OutputDirectory\SQLRecovery

Maintenance

There are certain directories that must be maintained after you start using Reform. Depending on the options you have configured in the Reform Spooler, the Spooler may create backups of all processed files into the Backups directory. If the Retain Images option is used with the Reform Printer driver, images of processed documents will be stored in the Reform…\Spooler\ImageQueue directory. As a system processes more and more jobs, the size of these directories can grow very quickly. Overall system performance can be affected by the large amounts of space that the files may take up. Obsolete files should be deleted according to your needs and file retention specifications.

Please see the Health Monitor and Maintenance Utility section for more information and instructions for monitoring and maintaining your server. It is recommended to monitor the following directories for growth:

C:\Program Files\Reform…\Spooler\ImageQueue

C:\Program Files\Reform…\Backups

Troubleshooting

Q: The Reform Spooler suddenly stops.

A: If the Spooler is stopping or restarting erratically, close the Spooler application. Bring up your system’s Services panel and find Reform Spooler Service. Refresh the Services list. Right-click the entry for Reform Spooler Service. Hit Stop. Open up the Spooler application [Start > Programs > Reform… > Spooler], and after it loads, click Run. The Reform Spooler Service should start up.

ReformEngine 107.png

If this does not work, try right-clicking the service and hitting Restart, and then re-launching the Spooler Application.

Alternatively, for information on what might be causing your Spooler to randomly turn off, you can check in the Event Log. To open the Event Log, open the Control Panel, go to Administrative Tools, open Event Viewer, select Application on the left pane, and look for errors with the source ReformSpooler.

Q: The Reform Spooler Service will not start.

A: Be sure that the Spooler Service is being run as an administrator. To check this, open up the Services panel on the server. Look for RM_Reform15_Spooler_***. First, refresh the Services panel to make sure that the service is definitely not running. Next, right-click on the Reform Spooler Service item and click Properties. Go to the Logon tab, select This Account, and enter an account that is an administrator on the server machine. It will need to run with full access because it needs to monitor folders and create, write to, rename, and move around files.

Q: The Reform Spooler service will not start even though it is set to use an administrative account.

A: If you have created a new administrator account, you must log in to the Reform server at least once so that the appropriate permissions can be applied to the new account. If you are setting the service to run under an account that you have not yet logged in under, the service will be unable to start correctly because it has not been configured by Windows yet to have full administrative access to the machine.

Q: The Reform Spooler log states that it could not find any forms to match the files to.

A: This can be caused by the service account not having sufficient permission to the spooler file. If the detailed log in the Reform Spooler is enabled, it will say that the file is locked because it does not have permission to read from the file.

ReformEngine 108.png

To correct this, you need to repair the security permissions on the Spooler folder.

1. Open a Windows Explorer window and navigate to C:\Program Files\Reform…\

ReformEngine 109.png

1. Right-click on the Spooler folder and click Properties.

2. Select the Security tab and click the Advanced button on the bottom of the window.

ReformEngine 110.png

3. Click the Add button to add a new permission entry.

ReformEngine 111.png

4. Enter Everyone, or a group that the service account belongs to, in the box and click Check Names. Then click OK to create the new permission entry.

ReformEngine 112.png

5. Select the checkbox for Allow Full Control. It will automatically check the rest of the boxes for you. Click OK.

ReformEngine 113.png

6. Check the box Replace permission entries on all child objects with entries shown here that apply to child objects. Then click Apply, and click OK.

ReformEngine 114.png


The permissions of the folder should now be set correctly.

Other company or product names mentioned herein may be trademark or registered trademark of their respective companies



Reform Issue Ticket

*User’s Name: ___________________________________ *User’s Login Name: ______________________________

*User’s Email Address: ____________________________ User’s Building: _________________________________

User’s Department: ______________________________ Support Contact’s Name: __________________________

Support Contact’s Email: __________________________ Support Contact’s Phone: __________________________

*Severity of Issue (Please check one):

0 - Test environment (non-production)

1 - Users are affected, but able to continue business

2 - Users are affected and it is affecting business, other functionality is working properly

3 - The software is not functioning properly at all – system outage

Number of Users Affected: _____________ List Each Users Login Name ________________________________

_________________________________________________________________________________________________

_________________________________________________________________________________________________

*Description of Issue: _________________________________________________________________________________________________

_________________________________________________________________________________________________

_________________________________________________________________________________________________

_________________________________________________________________________________________________

*Observations about the issue:

Frequency of Issue: Once / Random / Every Attempt / Other (Please Describe): ________________________________

_________________________________________________________________________________________________

First Occurrence (Date/Time): _____________________ Latest Occurrence (Date/Time): ________________________

  • *Issue is occurring at (Fill in all fields for Reform Server):
  • Reform Server(s)

Reform Server IP(s): _____________________________________________________________________________

Reform Version: ______________________________ Service Account: _______________________________

Is the Reform Server licensed? yes / no System ID: ____________________________________

Operating System: ____________________________ Anti-Virus Software: ____________________________

* Additional Information

*Have any changes been made to the Reform Server or Environment? yes / no If yes, What? When? By Who?

_________________________________________________________________________________________________

_________________________________________________________________________________________________

_________________________________________________________________________________________________

*What Plug-ins are being used? _______________________________________________________________________

_________________________________________________________________________________________________

*Is the service account a local administrator? yes / no

*Does the Reform Spooler service start? yes / no If no, what is the message that appears? ___________________

_________________________________________________________________________________________________

*When logging onto Reform Server are you logging in as the service account? yes / no

*What is the default printer when logged in as the service account on Reform Server? ___________________________

*Have any new printers been added or printer drivers been updated recently? yes / no If yes, Please explain

_________________________________________________________________________________________________

_________________________________________________________________________________________________

Is Remote Desktop being used to connect to the server? yes / no If yes, Is printer mapping disabled in the client settings tab of the RDP-TCP properties? yes / no

*Have any changes been made to the Forms? yes / no If yes, please explain _______________________________

_________________________________________________________________________________________________

_________________________________________________________________________________________________

What type of system is being used to print from? (Please check one)

- AS400 - Windows

- UNIX - Other ______________________

*Have any changes or updates been applied to the antivirus software used on the Reform Server? yes / no

If yes, What? When? _______________________________________________________________________________

_________________________________________________________________________________________________

*Have any changes been made to the device scripts or page process scripts? yes / no If yes, What? When? ______ __________________________________________________________________________________________________________________________________________________________________________________________________

* Fields are required