SYSPRO 8 Document Flow Manager Folder Poller

Exploring

This service monitors specified folders and uses the contract details to determine if the files in the folders should be sent to the DFM queue.

This service is used by:

  • Document Flow Manager

  • The default location for this service is:

    Program Files > SYSPRO > Document Flow Manager Folder Poller

Overview topic

Document Flow Manager

SYSPRO Services

Programs

Document Flow Manager Setup

DFM Service Maintenance

DFM Document Queue Query

XML Document Query

XML Document Control

XML Document Purge

PDF and Video Resources

Install Guides

Feature Guides

Starting

  • Microsoft .NET Framework 4.6

  • SYSPRO 8 e.net Communications Load Balancer

    A valid endpoint must be configured in the Setup Options program of SYSPRO 8.

  • The Document Flow Manager folders that are configured against DFM contracts must be accessible to this service.

  • This service is installed using the SYSPRO Installer Application.

  • The service can be installed multiple times, as determined by the workload.

  • If you require files to be processed in a certain sequence then you need to add them to the queue in the correct order.

    The Document Flow Manager processes files as they appear and as the data is available.

  • Processing speed may be affected by the number of contracts and folders in use.

Solving

You can debug this service by editing the associated config file in elevated mode (i.e. with administrator privileges).

The SYSPRODFMFolderPoller.exe.config file is located in the folder to which you installed the service.

You can view monitoring and troubleshooting messages about this service using the Event Viewer function in Windows:

(Control Panel > System and Security Administrative Tools > Event Viewer > Applications and Service Logs)

This service outputs an event log to the SYSPRODocumentFlowManager file.

You can start, stop, restart and configure this service using the Services function in Windows:

(Control Panel > System and Security Administrative Tools > Services)

Service operators are created by SYSPRO and are used by SYSPRO services to obtain information about SYSPRO.

The service operator code starts with a double underscore to differentiate them from other operators. A default company code must be assigned to each service operator within the Operator Maintenance program, as we use the company code to log in the service operator via e.net .

The following is a list of service operators and their function within SYSPRO:

  • The __ADSYNC service operator is used by the SYSPRO 8 Active Directory Sync Service to push Microsoft Active Directory (AD) information into SYSPRO for Active Directory managed operators.

  • The __BOT service operator is used by the SYSPRO 8 Bot Service.

  • The __DFM service operator is used by the SYSPRO 8 Document Flow Manager Folder Poller and SYSPRO 8 Document Flow Manager Queue Poller to monitor folders, send files to the queue and process files.

  • The __ESP service operator is used by the following services:

    • SYSPRO 8 Espresso Service,

    • SYSPRO 8 Espresso Notification Service,

    • SYSPRO Espresso Development Plugin and the

    • SYSPRO Avanti Web Service to obtain information for the password reset and forgot password functionality.

  • The __POS service operator is used by the SYSPRO 8 Point of Sale Services to determine and validate the setup options and required credentials at start up, update the required databases and post to SYSPRO (if the Point of Sale operator doesn't have access to SYSPRO).

  • The __RUL service operator is used by the SYSPRO 8 Rules Engine Service and the SYSPRO 8 Rules Data Service.

  • The __SA service operator is used by the SYSPRO 8 Analytics service to make business object calls.

  • The __SAI service operator is used by the SYSPRO 8 Machine Learning service.

  • The __SRS service operator is used by the SYSPRO 8 Reporting Host Service and the SYSPRO 8 Cognitive Service to manage client-side report printing.

  • Only specific services use service operators to log in via e.net.

  • SYSPRO creates service operators by copying the ADMIN operator. If the ADMIN operator record doesn't exist (i.e. it may have been deleted), then the current operator is used when saving system details from the Setup Options program.

Service operators are signed in by a SYSPRO service and are used for any functionality that is required by the service to obtain information about SYSPRO.

Normal operators sign in to SYSPRO with a username and password. They access certain programs and functions to perform specific tasks.

For example:

the __SRS service operator is used by the SYSPRO 8 Reporting Host Service to obtain information about the companies in an environment, but it isn't used by the business object to retrieve the data for a report, as that would be the specific normal operator that submits the request for the report.

Referencing

You should only update this file for temporary debugging purposes (i.e. not as a method to update values for the service).

Any temporary changes made to the configuration files are reset to their original installation values when this application is next updated. Because these temporary changes are not carried forward, forgetting that you made them could hamper troubleshooting efforts if unexpected issues arise.

Any configuration changes made using the DFM Service Maintenance program only takes effect when next the service polls for a change in configuration information.

The following settings can be maintained using the DFM Service Maintenance program within SYSPRO:

  • Configuration polling interval

  • Polling interval

  • Pause polling
Key Description
WCFAddress This indicates the URL for the SYSPRO 8 e.net Communications Load Balancer service.
InstanceKey This indicates the base dir instance on the SYSPRO application server.
LanguageCode This indicates the SYSPRO language code.
ConfigPollInterval

This indicates how often the service will poll for changes made to the configuration information.

If the service can't reach the SYSPRO 8 e.net Communications Load Balancer or business object, it will retry once this interval has lapsed.

This is measured in the unit of time specified at the ConfigPollType flag.
ConfigPollType

This lets you indicate the unit of time (i.e. ss - seconds, mm - minutes and hh - hours) the service will use to poll for changes in the configuration information.

You can't use the DFM Service Maintenance program to maintain this flag.

FolderPollInterval

This indicates how often the service will poll for new files in configured contract folders.

This is measured in the unit of time specified at the FolderPollType flag.

This defaults to 30 seconds.
FolderPollType

This lets you specify the unit of time (i.e. ss - seconds, mm - minutes and hh - hours) the service will use to poll for new files in configured contract folders.

This can only be changed in the configuration file and defaults to seconds in the DFM Service Maintenance program.
zeroFileSizeDeleteTime

Specifies the length of time (in seconds) that a zero sized file will remain in a polling folder, before it is deleted.

This can only be set in the configuration file and not in the DFM Service Maintenance program.
DebugService

This enables service debug logging.

This outputs the debug messages to the active trace log, which can be viewed using an application like DbgView.

Although debug messages are not written to file anywhere, exception messages are shown in the debug stream, as well as in the event log.

We recommend you set this to true before starting the service.
PausePolling

This enables or pauses folder polling.

Before starting the service you can set this to false to start the service but pause folder polling.