...
From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.
Enter Reporting in the Start Search text box.
Click the Reporting Center link to access the Reporting Center component.
You see the Client Reporting workspace.Open the Client Reporting folder, and double-click the Administrative folder to see the Client Reporting options.
Double-click Custom Distributions.
You see the Custom Distributions window.
Create a Custom Distribution Method
To add a custom distribution method:
Click Add on the Custom Distribution window.
You see the Add Custom Distribution dialog box.Complete the options on the Custom Distribution dialog box as described in the following table.
...
Option
...
Description
...
Distribution Name
...
Enter a name for the custom distribution method.
...
Short Distribution Name
...
Distribution Type
...
Select a Distribution Type:
Windows Client
ePACE Client
Eagle Portal
COM Interface. Enter the appropriate arguments in the Parameters setting.
Dot NET Interface. Enter the appropriate arguments in the Parameters setting and the file path of the executable to be used.
E-Mail. Use the Subject field to store the text of the message sent with the output file. The batch name is part of the email message by default when a client’s contact is the email recipient.
PERL Script. Enter the appropriate arguments in the Parameters setting and the file path of the script to be used.
Printer. Select the printer driver to use for distribution from the Device Name drop down list.
Archive. Saves the output file to the file system. Select the Custom Archive Rule to specify the location and naming convention for the distribution process.
...
Output Type
...
These options specify the file type sent by the distribution method. It is only necessary if you selected a method other than PACE Client or Printer from the Distribution Type drop down list.
When the Distribution Type is set to Eagle Portal, COM interface, email, external application, PERL script, or Archive, you can configure the output type as an HTML document.
...
Hints
...
Displays a list of valid arguments.
...
Compressed
...
Compresses the distributed file. You must select the Compressed check box for distributions using the Eagle Portal method.
Table 29: Fields - The Custom Distributions Dialog Box
Click Save.
...
To add a custom distribution method:
Click Add on the Custom Distribution window.
You see the Add Custom Distribution dialog box.Complete the options on the Custom Distribution dialog box.
Click Save.
You can now assign the custom distribution you created to the clients. See the following section Connect to PACE Clients for details.
Connect to PACE Clients
To connect to PACE clients:
From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.
Enter Clients in the Start Search text box.
Click the Clients (System Management Center) link to access the System Management component.
You see the System Management Clients window.Select a client, and click Edit.
...
You see the Clients dialog box appears.
...
Complete the options on this dialog box, including maintaining the list of parties who will receive a copy of a particular client’s reports. You can also designate the preferred method and format for reports, specify the number of copies, and add address information.
...
Each address record records contains a set of communication types, such as email, archive, mobile, and phone. You can assign a value to each communication type so that a client’s email address or phone number is stored. Information related to how a client receives their client reporting packages is stored on the Distribution tab. You can set up this information on a date sensitive basis, so that the client receives their packages using different methods during different times of the year, or as the default distribution directive.
...
Click Distribution.
You see the Distribution tab.Create a distribution directive using the settings on the Distribution tab. You can select the address type and contact method (communication type) for the distribution.
Communication types are stored in the CLIENT_COMMUNICATION table in the RULES database. There is also a default communication type stored in the RULESDBO.CLIENT table. This value is stored in the DEFAULT_COMM._INST column
...
.
Select
...
an optional distribution category from the Category drop down list. Use distribution categories to maintain one set of clients and run separate batches for distribution to different places.
For example, if a client has one set of reports distributed via email and another set distributed via the Eagle Portal, they can be managed through a single client using multiple distribution categories, regardless of the frequency of the reports.
...
To establish a distribution directive,
...
select the category under which a directive falls by clicking the Category dropdown.
...
If a client contains a distribution directive with no associated category, all batches are run for clients that call that distribution directive.
...
Additionally, when selecting a report package via the Reports tab on the Create New/Edit Batch dialog box, the Client Reporting prompts you to specify a distribution category for each Advanced Report Profile. If the Categories setting is left blank, the batch is sent to all valid distribution methods, regardless of the value you select for the Category on the Clients dialog box.
...
You can reduce the number of potential recipients of client reporting packages using the CR_FLAG field, which is stored in the RULESDBO.CLIENT_RELATIONSHIPS table in the Clients module.
...
To access the CR_FLAG field, click the Relationships tab on the Clients dialog box. Click Edit Relationship.
...
You see the Select Relationship dialog box
...
.
...
Click the More Fields link to display the More Relationship Fields dialog box.
...
You see the More Relationship Fields
...
dialog box.
...
If you do not see the CR_Flag field on the More Relationship Fields dialog box, make sure that the Inventory of Fields record for that column has the Show this field in all editing windows setting enabled.
...
More Relationship Fields Dialog Box
The CR_FLAG field allows client records to be ignored by the distribution engine, allowing the engine to run more quickly when there are exceptions to the distribution.
...
You can change the CR_FLAG value to Ignore (0) so that the distribution engine does not recognize the relationship record. When a relationship is added to a client that is missing an address, communication, or distribution record, the CR_FLAG value will default to Ignore (0).
Store Distribution Status Information
...
The following columns are also part of the CR_DISTRIBUTIONS table:
CODE_VALUE
SCHED_DEF_INST
STATUS
END_DATE
The CODE_VALUE column stores the short description of the communication value used to distribute the package. The SCHED_DEF_INST column stores the INSTANCE value from the related SCHEDULE_DEF record. The STATUS column stores the current status value of the distribution request, and the END_DATE column stores the time that the distribution process completed.
...
If you select Eagle Portal as the Distribution Type when defining a distribution method, Client Reporting allows distributions to the Portal at the business group and user level .
...
as shown in the Custom Distribution Dialog Box dialog box - Portal Distribution Type.
...
Additionally, the Subtype field is displayed, allowing you to further define how batches that use the distribution method are distributed. The Subtype you select determines the communication types and values that are available for selection on the Address tab of the Clients dialog box. Options include:
None. The Portal communication value on the Clients dialog box displays a text field.
Pace User. The Portal User communication value on the Client’s dialog box displays a drop down list of PACE users.
Pace Group. The Portal BG communication value on the Client’s dialog box displays a drop down list of PACE business groups.
...
Distribute to Business Groups and Users
...
Insert your functional code to create approval or distribution functionality. Alternatively, if you right-click in the project explorer window, you can add both of these classes using the popup menu.
...
Technical Design
The Auto Approval and Custom Distribution functions handle volume processing. To remove the negative impact of Windows hooks, COM processing in the approval and distribution engines is externalized. This prevents the generation of enough Windows hooks to hang individual engine instances.
...
Client Reporting allows you to change rejected auto approvals to a status of Pending. In the event that If the approval process rejects an auto approval, you can set the approval to a Pending status, which allows the auto approval to be processed again. This feature is only available for auto approvals and only for auto approvals with a status of Rejected.
...
Auto Approval Internal Tables for Batch Overrides
...
In the Client Reporting workspace, you can specify a Custom Archive location for the completed images in a batch. Complete the following procedure to view or select an archive folder.
To view or select an archive folder:
Type Maintain Batches in the Eagle Navigator.
You see the Maintain Batches window.Select a batch and click Edit Batch.
Click Next twice to access the Reports tab.
View the Archive Folder column to see the archive location.
...
Click Finish.
Maintain Custom Archive Rules
You maintain the list of archive folders in the Custom Archive Rules window.
To maintain custom archive rules:
...
Type Custom Archive Rules in the Eagle Navigator.
You see the Custom Archive Rules window.Select a rule and click Edit.
You see the Edit Archive Rule dialog box.
...
Each Archive Rule contains a Directory Rule and a File Rule. The Directory Rule specifies the directory or folder structure to be generated and used by the archive process. The File Rule determines the naming convention of the archived image files.
Make any changes to the Archive Rule folders, and click Save.
Batch Distributions Window
The Batch Distributions window displays detail on all batch distributions, including the name of the batch, Advanced Report Profile, client/contact, distribution category, communication value, status, communication type, and distribution time.
...
Recall One or More Distributions to the Portal
The Recall Distributions link on the Batch Distributions window allows you to recall one or more reports that were distributed to the Portal. This involves deleting the physical file that was distributed, and deleting the database records that indicate an Inbox item in the Portal. This functionality automates file retrieval if a package is distributed in error.
You can recall the distribution if at least one package in a batch status record has moved past the distribution stage and the Portal is the destination.
To recall one or more reports that have been distributed to the Portal:
Select one or more clients on the Batch Distributions window.
Click the Recall Distribution link.
The reports that have been distributed for the selected clients are deleted from the Portal.
Once the distribution is recalled, the status column on the Batch Distributions window displays Recalled. The related records are deleted from the following tables:
XML_
...
PACKAGE_LOG
XML_
...
REPORTS_LOG
XML_REPORT_INFO
XML_REPORTS_LOG_DETAIL
XML_REPORT_STATUS
If a batch was cancelled and some of the packages were distributed, the Recall Distribution link is still available.
Recall All Distributions to the Portal
To recall all reports that have been distributed to the Portal, click the Recall All Distributions link on the Batch Distributions window.
Filter Batch Distributions
You can filter the batches on the Batch Distributions window by distribution type, status, and distribution time. Right-click on the Batch Distributions window and select Filter Batches from the popup menu. The You see the Filter Batch Distributions dialog box appears.
...
View Event Details
The Event Details link displays the Event Details dialog box, which provides information on the Schedule Def Id, Schedule Queue Id, Start Time, Stop Time, and Duration. There is also a link to the App Server Log.
...
Use the Engine Locations Link
...
To test an approval or distribution dll, retrieve a client reporting mdb that contains the data you are looking for in the dll.
To test a PACE Approval DLL:
Double-click the NetApprDistrTester.exe to open it.
...
You see the .Net Approval and Distribution DLL Tester dialog box
...
.
...
In the Report File field, enter the location of the .mdb file. Click ... to locate the file.
In the Select DLL Type To Test section, select Test IPACEApproval DLL.
Click the ... button to select a DLL.
...
After selecting an approval DLL, the Run and Save and Exit buttons are enabled.
Click Test to verify that you have entered a valid approval DLL.
Enter any additional entity or client information.
Click Run.
Test a PACE Distribution DLL
To test a PACE Distribution DLL:
Double-click the NetApprDistrTester.exe to open it.
...
You see the .Net Approval and Distribution DLL Tester dialog box
...
.
...
In the Report File field, enter the location of the .mdb file. Click ... to locate the file.
In the Select DLL Type To Test section, select Test IPACEDistribution DLL.
Click the ... button to select a DLL.
...
After selecting an approval DLL, the Run and Save and Exit buttons are enabled.
Click Test to verify that you have entered a valid distribution DLL.
Enter any additional parameter values in the Enter Parameter Values section.
Click Run.