Correspondence Schedule

The Correspondence Schedule task executes the next step in the correspondence output process for each eligible schedule. This can mean creating correspondence that is ready to be created, or sending correspondence that was created in a previous correspondence run.

This task is typically run after other batch processes that create correspondence. See the Infor Public Sector Correspondence Administration Guide for more information.

Create correspondence:

  1. Query the CORRESPONDENCESCHEDULE table for schedules where the STATUS is 2 (CreationPending) and the SCHEDULEDDATE is today.
  2. Set each schedule’s status to 1 (Processing).
  3. For each schedule, create the correspondence report:
    1. Check the report type (Keyword, Crystal Embedded, or SSRS).
    2. For Crystal Embedded or SSRS reports, create the report.
    3. For Keyword reports, check the correspondence report type (print, attachment, body, subject, view), then create the XML output file in the specified directory.
    4. For Keyword reports, apply XSLT stylesheet to transform the report.
  4. Set the schedule’s STATUS to 3 (Created) or 9 (CreateException), depending on the result.

Send correspondence:

  1. Query the CORRESPONDENCESCHEDULE table for schedules where the STATUS is 3 (Created), the CORRSENTFLAG is not Y, and the CORRSENDDATE is today.
  2. Set each schedule’s status to 1 (Processing).
  3. For each schedule, send the correspondence:
    1. If delivery option is 2 (mail) or 0 (none), update STATUS to 5 (Sent).
    2. If delivery option is 1 (email), send the email and update STATUS to 5 (Sent).
  4. Set the schedule’s STATUS to 5 (Sent) or 9 (SendException), depending on the result.

Setup

This table describes the Configuration Editor settings that affect this task:

ConfigurationComments
CorrespondenceDefines various settings for the correspondence engine.
Hansen8 The IDM Execution Account attribute on the ATTACHMENTS node specifies the account to use if the task needs to access Infor Document Management. For example, an IDM document output report might be used for correspondence output.

Specify the Infor Federation Services ID associated with an Infor Public Sector user's Ming.le account. In Infor Public Sector this is shown in the Windows Name field in the User InfoViewer.

This table describes the Infor Public Sector setup forms that are used to configure this task:

Setup formComments
Keyword Manager (SKM)Defines the keywords that are used to select data from the database for a keyword report.
Reports Manager (SRM)Defines correspondence reports.
Lookup Correspondence Process Setups (SLCP)Associates defined correspondence reports with different correspondence processes, such as bill output or sending automated emails. Note that each correspondence process setup can have multiple reports, so you can output the same correspondence in different forms, such as email and mail.

This table lists the database tables that store setup information for this task:

TableComments
CORE_CORRESPONDENCE. CORRPROCESSSETUPStores the setup records defined in Lookup Correspondence Process Setups.

Templates and stylesheets

For keyword reports, the templates and stylesheets must be in the directories specified in the report definition.

Invocation

The Correspondence Schedule task can be scheduled and invoked manually through the Infor Public Sector Batch Manager form, and it can also be invoked through the console.

This table describes each parameter for this task:

Form Console Description
Stop on error StopOnError (bool) Indicates whether the task will stop if an error occurs.
Stop on presort failure StopOnPresortFailure (bool) Indicates whether the task will stop if there is an error in the CASS presort process.

Monitoring

In Infor Public Sector, you can use Lookup Correspondence Schedules to monitor your correspondence runs. The Status column indicates the current status of the run. The status is stored in the CORRSCHEDULE.STATUS column in the database, using these numeric codes:

CodeDescriptionComments
1ProcessingThe schedule is currently being processed by the Batch Manager.
2Creation PendingThe correspondence is ready to be created.
3CreatedThe correspondence has been created but not sent.
4Sending PendingThe correspondence is ready to be sent.
5SentThe correspondence has been sent.
6CanceledThe schedule was canceled by the user.
7ErrorAn error occurred while the schedule was being processed.
8Create ExceptionThe Batch Manger returned an exception while creating the correspondence. You can review the exception in the Exception column.
9Send ExceptionThe Batch Manger returned an exception while sending the correspondence. You can review the exception in the Exception column.

Common errors

This table lists some common errors that this task may return:

Error messageComments
Unsupported Report Type in ExecuteCorrespondenceReport().Check the report in the Reports Manager. The report type must be Keyword, Crystal Embedded, or SSRS.
CorrespondenceProcessSetup could not be loaded in ExecuteCorrespondenceReport().Check for any errors in the correspondence process setup being used for the current schedule, and in the correspondence reports for that setup.
Correspondence Report could not be loaded for ReportID = [report ID] in ExecuteCorrespondenceReport().Check the correspondence process setup being used for the schedule, and check the correspondence reports for that setup.
Scheduled date for correspondence creation is greater than today's date.The scheduled date is still in the future, so the correspondence isn’t ready to be created.
Invalid CorrespondenceProcessSetup in ExecuteCorrespondence().Check the correspondence process setup being used for the schedule.
Invalid CorrespondenceProcessSetup in SendCorrespondence().Check the correspondence process setup being used for the schedule.

Data output

The primary data output for a correspondence run is the correspondence itself. Depending on the correspondence process setup, the content of the correspondence can be stored as text or XML in the CORR table, or it can be stored in a data file on the server.

This table lists the database tables in which this task adds or updates records:

TableComments
CORE_CORRESPONDENCE. CORREach record in the CORR (Correspondence) table represents a batch of correspondence that has been created. The content of the correspondence can be stored as a string in the CORRTEXT column, as XML in the CORRXML column, or in a file specified by the CORRFILEPATH and FILENAME columns.
CORE_CORRESPONDENCE. CORRDETAILEach correspondence detail record represents a particular item of correspondence within a batch, such as one bill or one email.
CORE_CORRESPONDENCE. CORRIMAGEAssociates images with correspondence details.
CORE_CORRESPONDENCE. CORRSCHEDULEA correspondence schedule is a record indicating that a set of correspondence is ready to be generated. Each time a process that involves correspondence output is completed, Infor Public Sector adds a correspondence schedule. For example, when a delinquency run is completed, Infor Public Sector adds a schedule indicating the delinquency run number and the correspondence process setup to be used for the delinquency notice output.

This table lists the Infor Public Sector forms that you can use to review the results of this task:

FormComments
Lookup Correspondence Schedules (SLCS)Used to look up and review correspondence schedules. You can also use this form to resend or cancel correspondence.

Resend

When you resend correspondence, Infor Public Sector will repeat the last step completed in the output process, either creating or sending the correspondence. To resend, look up the correct correspondence schedule in Lookup Correspondence Schedules, select the schedule in the gird, and click Resend.

Cancel

To cancel a correspondence schedule, look up the correct schedule in Lookup Correspondence Schedules, select the schedule in the gird, and click Cancel Notice. Infor Public Sector then changes the schedule’s status to Canceled.