AX 2009, and Microsoft Dynamics AX, version 4.0, unless specifically .... All of the
Microsoft Dynamics AX administration functions for the integration.
Microsoft Dynamics AX Connector Implementation Guide
Microsoft Dynamics AX Connector Implementation Guide Version 3.1 Copyright Bottomline Technologies, Inc. 2009. All Rights Reserved Information in this document is subject to change without notice and does not represent a commitment on the part of Bottomline Technologies. Bottomline Technologies makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability or fitness for a particular purpose.
Bottomline Technologies
325 Corporate Drive Portsmouth, NH 03801 Telephone: (603) 436-0700 Fax: (603) 436-0300 Email:
[email protected] Internet: www.bottomline.com SWR-CFIMDAX31-REF
B L E
O F
C
.....
TA
O N T E N T S
Chapter 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 What is New . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2: Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Document Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Setting up a Document Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Specifying Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . Delivery Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying the XML Path . . . . . . . . . . . . . . . . . . . . . . . . . . .
16 18 25 31
Mapping Directly to a Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Printing Batch Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 3: Enhanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Print Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Document Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Enterprise Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Multi-select Preview Support . . . . . . . . . . . . . . . . . . . . . . . . 45
Appendix A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 XML File Naming Convention . . . . . . . . . . . . . . . . . . . . . . . Processing Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BT-DPA Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Microsoft Dynamics AX Connector Installation Guide
48 49 53 59 61
v
v
.....
vi
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
vi
Microsoft Dynamics AX Connector Installation Guide
C
Chapter 1: Introduction
H A P T E R
INTRODUCTION In this section, the following is discussed: •
Overview
•
What is New
•
Configuration Note The information contained in this guide applies to both Microsoft Dynamics AX 2009, and Microsoft Dynamics AX, version 4.0, unless specifically stated otherwise.
Microsoft Dynamics AX Connector Implementation Guide
7
CHAPTER 1: INTRODUCTION
.....
8
Overview
Overview This guide describes the specific configuration process to ensure seamless document process automation with Microsoft Dynamics AX. Create!form processes output from multiple source systems for either packaged software solutions or custom legacy applications. Required Create!form components include: •
Create!form Designer
•
Create!form Director
•
Create!form Server
Create!form Designer
Create!form Designer is used to design form projects, which Create!form Server merges with the output of your enterprise server. The form project allows you to reformat and enhance the output of your enterprise, incorporating logos, images and drawing objects as well as formatted text. Create!form Director
Create!form Director is used to design projects that Create!form Server splits and processes for the enterprise server which then merges, transforms, emails, faxes or archives, as necessary. The types of action that Create!form Director performs include:
8
•
Splitting the spool file into multiple spool files
•
Sending particular parts of the spool file to particular directories or queues
•
Extracting data for use in reports
•
Creating backup copies of the spool file
•
Adding job ticket templates (JTTs) that determine various parameters used in processing by other Create!form products
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 1: INTRODUCTION
Overview
Create!form Server
Create!form Server is the central processor which handles the output from the enterprise server, and applies the appropriate project designed with either Create!form Designer, Create!form Transform or Create!form Director. The output from Create!form Server can be printed, faxed, e-mailed or archived using other Create!form products. Note For a list of optional Create!form products contact a Bottomline Technologies customer service representative.
Microsoft Dynamics AX Connector Implementation Guide
9
9
CHAPTER 1: INTRODUCTION
.....
10
What is New
What is New As the interaction between Create!form and Microsoft Dynamics AX matures, enhancements are constantly streamed into the offering. Below is a list of new features and/or supported peripherals in Microsoft Dynamics AX Connector 3.1.
Attachments to Create!form E-mails You can now add documents to e-mails generated in Create!form. You may add up to 10 additional documents by browsing to the desired files. Click here for more information.
Save Create!form Generated Reports You can now save documents generated by Create!form via the Preview function. When previewing reports, click Save and you can select the location to store your file(s).
Enhanced Report Viewing There are now two different ways to view reports. You can view reports via an Adobe Acrobat Reader interface, or a Create!form customized preview interface. System Administrators can specify the end user view via the Create!form Default page.
Consistent Date Formats Microsoft Dynamics AX Connector now creates date formats that sync with Create!form Designer. The consistent date format is day-month-year.
Preview Type Dropdown A new attribute is added for the Screen type of delivery destination that allows the admin role to select the user experience for previewing (which is ""standard"" and Acrobat Reader). The option appears in the Create!form Default page and the Delivery Destination (when Delivery Method = Screen). 10
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 1: INTRODUCTION
11
What is New
If Acrobat is chosen, then the installed version of Reader will display the report. If Default is chosen, the Create!form customized preview will display.
Date Format Consistent with Create!form The AX Connector will generate the xml dates in a format consistent with what the Create!form Designer is expecting. The xml date field will be in the format day-month-year.
Enhanced Label View All labels are now shown in the XML code. Previously, some labels were hidden in the XML code, but now all labels are visible in the XML editor.
Additional BT-DPA Tags BT-DPA tags are used as a label prefix for components of the solution. A complete list is available here.
Microsoft Dynamics AX Connector Implementation Guide
11
CHAPTER 1: INTRODUCTION
.....
12
Configuration
Configuration Steps for Configuration Following, as outlined in succeeding sections, are the steps for configuration: •
Set up a document process for each Create!form Director project used in processing Dynamics AX output
•
Specify default values
•
Specify delivery destinations for Dynamics AX output
•
Enable Reports
•
Specify the XML Path for the Microsoft AX Connector Components.
All of the Microsoft Dynamics AX administration functions for the integration can be accessed via the Setup section of the Administration pane. Refer to Chapter 2, Configuration, for more information on completing the first step: setting up a document process.
12
Microsoft Dynamics AX Connector Implementation Guide
C
Chapter 2: Configuration
H A P T E R
CONFIGURATION This section outlines the steps necessary for configuring Microsoft Dynamics AX for use with Create!form software. The following topics are discussed: •
Document Processes
•
Specifying Default Values
•
Delivery Destinations
•
Enabling Reports
•
Specifying the XML Path
•
Printing Batch Jobs
Microsoft Dynamics AX Connector Implementation Guide
13
CHAPTER 2: CONFIGURATION
.....
14
Document Processes
Document Processes Note Users with AOS Service require full access to the directory where the XML output path is mapped, as well as access to the printer queue. This means that the AOS Service user must be granted all permissions to complete the required tasks. Document processes represent the distribution logic that is defined in a Create!form Director project. Before a Create!form Director project is used for processing Microsoft Dynamics AX reports, it is mapped to a document process, as described in the following section. First there must be at least one document process established as a default for reports that do not require a specific Director project. For a report that specifies the distribution logic, or document composition logic, then a unique Director project is used. For example, an invoice may have delivery rules based on customer type.
Setting up a Document Process Each document process is created with a user-friendly name and description so that the appropriate report is selected for the Create!form Director project. To set up a document process
14
1
In the Administration pane, expand Setup and then Create!form.
2
Click Document Processes.
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
15
Document Processes
3
On the Setup tab, enter the following details:
Process Name Process Description
Process Project
A user-friendly name for the process A meaningful description of the process The name of the Create!form Director project running on the Create!form server
Microsoft Dynamics AX Connector Implementation Guide
15
CHAPTER 2: CONFIGURATION
.....
16
Specifying Default Values
Specifying Default Values Default Values must be specified when they have not already been established as required values in a form. To specify default values
16
1
In the Administration pane, expand Setup and then Create!form.
2
Click Defaults.
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
17
Specifying Default Values
3
Enter details for the following default values:
XML Output Location
The path to the folder, or queue, in which the Dynamics AX XML output is placed. This is the folder from which the Create!form Director project takes files for processing. Specify the location as a UNC path in the form \\server\volume\directory or as a network file share (optional).
Screen Preview Temp Location
The path to the folder where temporary PDF files are created when the user requests a screen preview of a report. Specify the location as a UNC path in the form \\server\volume\ directory or as a network file share. Users requiring access to this folder will need the proper permissions. The user-friendly name of the document process to use for processing output when no other process is selected. The maximum time, in seconds, to allow for loading a formatted report for display in a preview screen. If the report cannot be displayed within this time, the preview screen closes with an appropriate message to the user.
Default Document Process Default Screen Preview Timeout
Microsoft Dynamics AX Connector Implementation Guide
17
CHAPTER 2: CONFIGURATION
.....
18
Delivery Destinations
Delivery Destinations Note Cheque reports will be restricted to printer destinations only. Other destination types will be filtered out when selecting delivery destinations for the report. Delivery destinations define how output can be delivered to particular users or groups. The table below shows the methods of delivery currently supported. Table 2.1
Delivery Methods
Destination
Description
Screen Printer E-Mail Fax Document Process
Writes the PDF to a temporary file and displays it on the user's screen. Sends the output to a printer. Sends the output as an e-mail attachment. Sends the output as a fax message. Processes the output by means of a Create!form Director project.
Each delivery destination is associated with a method, and with specific users and groups. This means that users can see and select only those destinations that are appropriate for their role. The attributes of a delivery method define the physical routing of the output so that, for example, the XML output file can be directed to a particular network location, according to which user or group requests the output.
Delivery Method Code Note In Microsoft Dynamics AX Connector, since labels are now localized, Field_DeliveryMethod_Code has been added to the BT prolog in order to support Director projects which may service AX clients using multiple languages. Each delivery method type will be consistently represented with an assigned code.
18
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
19
Delivery Destinations
The BT prolog was modified in the following way:
Prolog Parameter
Form
Field
Field_Path
Defaults or Delivery Destinations Defaults or Delivery Destinations
XML output path Screen Preview Temp Location Testing Parameters Document Process
Field_ScrenTempPath Field_Testing Field_ProcessName Field_DeliveryMethod and Field_DeliveryMethod_Code Field_ReportParameters Field_Destination Parameters Field_PrinterNetworkId Field_PrinterCopies Field_EmailNetworkId
Enabled Reports Defaults or Delivery Destinations (process) or Enabled Reports Printer Setup Form Enabled Reports Delivery Destinations Delivery Destinations Printer Setup Form Delivery Destinations (E_mail)
Delivery destination chosen in the Send to list Report Parameters Destination Parameters Printer Network ID Number of Copies E-Mail Network ID
Each of the delivery methods is coded as follows:
Delivery Method
Code
Screen Printer Email Fax Document Process
0 1 2 3 4
Each delivery method’s code corresponds to its enumeration values from the BT_DPA_Dest_Type base enum. Within Director_Generic_v3 these values are used to direct the output to the desired destinations.
Setting up Delivery Destinations To define a delivery destination
1
In the Administration pane, expand Setup and then Create!form.
2
Click Delivery Destinations. Microsoft Dynamics AX Connector Implementation Guide
19
CHAPTER 2: CONFIGURATION
.....
20
Delivery Destinations
3
On the Destinations tab, click in the Delivery Method field, and select a delivery method.
4
In the Destination Name field, beside the chosen Delivery Method, enter a descriptive name for the delivery destination.
5
In the XML Output Location field, enter the XML Output Location ONLY if it is a different location than the one specified during Default setup.
6
In the User Restrictions field, select the check boxes for the Delivery Methods where the User will not need access.
7
On the Setup tab, specify the following: * Fields containing an asterisk are displayed only when the appropriate delivery method is selected.
20
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
21
Delivery Destinations
XML Output Location
Restricted use
Destination description Destination Parameters Screen Preview Temp Location *Printer Network ID
*E-mail Network ID *Fax Network ID
This field is used to over-ride the default locations that is set in the Defaults form. It is the path to the folder, or queue, in which the Dynamics AX XML output is placed. Leave this field blank to use the default. Select this if the destination is to be restricted for use by particular users or groups. Clear this setting to allow all users to use the destination. A description of the destination. Specify additional parameters to the destination. If the selected delivery method is Screen, the path to the folder where temporary PDF files are created when the user requests a screen preview of a report. If the selected delivery method is Printer, the network name of a shared printer on which the output is printed, or a printer queue that is used to trigger a Create!form project. If the selected delivery method is E-mail, the email server to use for routing the output. If the selected delivery method is Fax, the fax server to use for routing the output.
Microsoft Dynamics AX Connector Implementation Guide
21
CHAPTER 2: CONFIGURATION
.....
22
Delivery Destinations
8
22
On the Groups tab, if use of the delivery destination is to be restricted to particular groups, click the left arrow to list those groups in the Restrict to groups area. If more than one group requires restrictions use the double arrow button.
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
23
Delivery Destinations
9
On the Users tab, if use of the delivery destination is to be restricted to particular users, click the left arrow to list those groups in the Restrict to Users area. If more than one group requires restrictions use the double arrow button.
Microsoft Dynamics AX Connector Implementation Guide
23
CHAPTER 2: CONFIGURATION
.....
24
Delivery Destinations
24
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
25
Enabling Reports
Enabling Reports To enable a Microsoft Dynamics AX report for processing by a Create!form Director project, you must associate the Application Object Tree (AOT) report object with the project. Use the Enabled Reports feature to do this. Note Reports enabled through the Enabled Reports form are enabled in the conventional client and the Enterprise portal. To associate a report object with a project
1
In the Administration pane, expand Setup and then Create!form.
2
Click Enabled Reports. Note AOT Reports do not automatically display when navigating to the Enabled Reports window for the first time. The AOT report will need to be chosen from the drop down list and then associated with a project.
3
On the Enabled Reports tab, select the check boxes in the Create!form Enabled field that need to be enabled.
Microsoft Dynamics AX Connector Implementation Guide
25
CHAPTER 2: CONFIGURATION
.....
26
Enabling Reports
On the Setup tab complete the following fields:
4 •
Create!form Enabled: Select this field to enable the report for processing by the Create!form Director project, or clear it to disable such processing.
•
Testing Parameters: The names of any trigger parameters in the Create!form Director project which cause processing to change to a path defined for testing purposes. For example, when using the example Director_Generic_v3 project, entering SAMPLE causes output to be created in the form of an XML file that can be used for forms design, rather than being sent to a printer.
•
Screen Preview Timeout Is when a preview screen attempts to display a formatted report, the maximum time to allow for loading the report. If the report cannot be displayed within this time, the preview screen closes. It is sometimes
26
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
27
Enabling Reports
necessary to increase the timeout period for complex projects that take a long time to process reports. •
Document Process The user-friendly name of the document process to use for processing the selected report object.
•
Report Parameters Specify additional non-testing parameters for the report. Director_Generic_v3 allows designers to use the first line of the Reporting Parameters field to specify the name of the Designer project that merges the enabled report. If there is no parameter, then the AOT Report name is used to find the Designer project. When a report is first enabled, but no Designer project has been created, the test report project AXTestReport can be used to test Create!form while samples are gathered. Note The ability to specify an explicit Create!form report name in the Reporting Parameters allows designers to select different report designs for the same report by AX Company without modifying Director_Generic_v3. Only the first lines of the Testing Parameters and Reporting Parameters fields are used to drive logic in Director_Generic_v3. This allows the designer to add additional parameters on subsequent lines if their DPA application requires it.
Microsoft Dynamics AX Connector Implementation Guide
27
CHAPTER 2: CONFIGURATION
.....
28
Enabling Reports
28
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
29
Enabling Reports
5
On the Deployment Schedule tab, specify which report design should be issued on the selected dates. (The date and time is based on the AOS Server time) Dynamics AX allows the user to create multiple designs per report. You can select a specific design to be enabled at a defined date and time. Note If the deployment date is left blank then the design becomes immediately available. If the design is left blank then the default AOT, or first design, is chosen.
6
On the Delivery Destinations tabs, list the delivery destinations to be assigned to the report object.
Microsoft Dynamics AX Connector Implementation Guide
29
CHAPTER 2: CONFIGURATION
.....
30
Enabling Reports
30
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
31
Specifying the XML Path
Specifying the XML Path Create!form Server retrieves XML files that are written directly to a shared queue. There are two places to specify XML paths within Microsoft Dynamics Connector: •
from the Defaults form, and
•
from the Setup tab in the Delivery Destinations form (Refer to Delivery Destinations for more information regarding the Defaults form and the setup tab.).
Mapping Directly to a Queue To establish an XML path mapped directly to a queue
On the Start menu, in the Printers and Faxes screen, right click the CF Director printer and select Sharing. On the CF_Director Properties screen, in the Sharing tab, Click the OK button. Note If the queue is pointed to a local port, then the folder that contains the file for the port must be enabled to allow any user access. For example, if the computer that hosted the CF Director queue is named “Server,” then the XML output location would be \\Server\CF Director as shown.
Microsoft Dynamics AX Connector Implementation Guide
31
CHAPTER 2: CONFIGURATION
.....
32
Printing Batch Jobs
Printing Batch Jobs Before printing batch jobs using Microsoft Dynamics AX Connector, the server must be configured for printing. For example: To print a report in batch mode
32
1
On the Posting Invoice screen, click Batch (d) on the bottom right hand corner of the screen. The Batch Processing form is displayed.
2
Select the Batch processing check box and click OK. The Infolog dialog box displays with a confirmation that the Order invoice job is added to the batch queue. Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
33
Printing Batch Jobs
3
Click Close. Now the batch printers need to be configured on the Microsoft Dynamics AX Server.
4
On the AX Server navigate to Control Panel >Administrative Tools > Microsoft Dynamics AX Server Configuration. The Microsoft Dynamics AX Server Configuration Utility screen appears.
5
On the Utility screen select the Allow clients to connect to printers on this server checkbox, and click OK. Microsoft Dynamics AX Connector Implementation Guide
33
CHAPTER 2: CONFIGURATION
.....
34
Printing Batch Jobs
6
34
If the Utility screen appears grayed-out like the one below, then a new configuration will need to be created.
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 2: CONFIGURATION
35
Printing Batch Jobs
To create a new configuration
1
Next to the Configuration field, click Manage > Create Configuration. The Create Configuration pop up appears.
2
On the Configuration name field, Type a configuration name (any name will do) and select OK. The Utility screen re-appears.
Microsoft Dynamics AX Connector Implementation Guide
35
CHAPTER 2: CONFIGURATION
.....
36
Printing Batch Jobs
36
3
Select the Allow clients to connect to printers on this server checkbox and click OK. The Configuration Utility dialog box appears.
4
Click Yes and wait for the service to restart.
Microsoft Dynamics AX Connector Implementation Guide
C
Chapter 3: Enhanced Features
H A P T E R
ENHANCED FEATURES There are several features that Create!form’s Dynamics AX Integration enhances in Microsoft Dynamics AX: •
Print Management
•
Enterprise Portal
•
Multi-select Preview Support
Microsoft Dynamics AX Connector Implementation Guide
37
CHAPTER 3: ENHANCED FEATURES
.....
38
Print Management
Print Management Microsoft Dynamics AX Print Management is a robust feature that provides many options for printing. Create!form’s Dynamics AX Integration enhances the existing print management feature by offering the following Create!form specific print mediums: •
document process
•
fax
•
e-mail
•
printer
•
screen preview capabilities
These modifications allow direct integration with Create!form Server for Dynamics AX reports that are Create!form enabled. Refer to the Microsoft Dynamics AX Help for more information on Print Management/Print Mediums.
Document Process Select the document process delivery destination by clicking on the Name drop down menu.
38
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 3: ENHANCED FEATURES
39
Print Management
Fax The Print Management form for Create!form Fax maps to fax delivery destinations. •
Select the fax delivery destination by clicking on the Name drop down menu.
•
Type the Fax number in the Fax number field.
•
Type any text to be included on the cover sheet in the Cover sheet text field.
Microsoft Dynamics AX Connector Implementation Guide
39
CHAPTER 3: ENHANCED FEATURES
.....
40
Print Management
E-mail The Print Management form for Create!form E-mail maps to e-mail delivery destinations.
40
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 3: ENHANCED FEATURES
41
Print Management
To create an E-mail
1
On the drop down menu, select the e-mail delivery destination.
2
Use the appropriate fields to complete the e-mail information.
3
(optional) Click Attach Files, to include up to 10 files in your email.
Print The Print Management form for Create!form Printer maps to printer delivery destinations. Select the printer delivery destination by clicking on the Name drop down menu.
Microsoft Dynamics AX Connector Implementation Guide
41
CHAPTER 3: ENHANCED FEATURES
.....
42
Print Management
Screen Preview Note The user must be granted Read access in Folder Security Permissions and Shares to view screens. The Print Management form for Create!form Screen maps to screen preview delivery destinations. Select the screen preview delivery destination by clicking on the Name drop down menu.
42
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 3: ENHANCED FEATURES
43
Print Management
Microsoft Dynamics AX Connector Implementation Guide
43
CHAPTER 3: ENHANCED FEATURES
.....
44
Enterprise Portal
Enterprise Portal Dynamics AX's Enterprise Portal client is supported in the Create!form Dynamics AX Connector. Enterprise Portal support is limited to legacy reports, i.e. reports that are also accessible in the standard AX Client. The Enterprise Portal also uses special reports called Web Reports which are NOT supported. Enterprise Portal reports are enabled in the same manner as regular reports via the Create!form Enabled Reports form.
44
Microsoft Dynamics AX Connector Implementation Guide
.....
CHAPTER 3: ENHANCED FEATURES
45
Multi-select Preview Support
Multi-select Preview Support Create!form Dynamics AX Connector allows multiple documents to be viewed in a single preview PDF when performing a multi-select. To enable the multi-select feature select the Combine into one Report checkbox.
Note Microsoft Dynamics AX Connector supports combining for the following reports: • • • • • • • • • • • • • •
SalesQuotationConfirmation WMSPickingList_OrderPick Invent PickingListJournal or InventPickingList (depending on which sales order is chosen) ProjInvoice PurchInvoice PurchPackingSlip PurchReceiptsList PurchPurchaseOrder PurchRFQSend SalesQuotation FreeTextInvoice SalesConfirm SalesInvoice SalesPackingSlip
Microsoft Dynamics AX Connector Implementation Guide
45
CHAPTER 3: ENHANCED FEATURES
.....
46
Multi-select Preview Support
46
Microsoft Dynamics AX Connector Implementation Guide
A
Appendix A
P P E N D I X
APPENDIX In this Appendix we will discuss the following: •
XML File Naming Convention
•
Processing Parameters
•
BT-DPA Tags
•
Security Keys
•
Glossary
The following table describes the categories of components that are installed by the integration installers.
Microsoft Dynamics AX Connector Implementation Guide
47
APPENDIX A
.....
48
XML File Naming Convention
XML File Naming Convention The filename of the XML files created by the integration are derived at run time based on the following:
Value
Source
Report Name Separator
Enable Reports Table
User ID Data-Time Stamp
Derived at runtime Derived at Runtime
Output Scenario Indicator
If print medium is screen, then “_P” If print medium is not screen, then “_D” If via an ad hoc request, then “_A” “.xml”
File Extension
48
Notes Semicolon used as separator
Microsoft Dynamics AX Connector Implementation Guide
Semicolon as a separator _P = Preview _D = Default _A = Ad hoc
.....
APPENDIX A
49
Processing Parameters
Processing Parameters Before a report is written to an XML file, a header section is added to the file. The purpose of the header is to pass parameters for the enabled report attributes to CF that will allow the proper process to be selected and to provide parameters that will be used for determining the presentation and delivery attributes of the output. For example, if the end-user selects a "Send to" option of printer, then the header contain a parameter indicating which printer the user selected. CF would then use this parameter to route the output to the correct printer.
XML Tag
Source
Notes
Field_BT_AX_ConnectorVersion
Internal
Field_AXVersion
Internal
Field_AX_AOSId
Internal
Field_AX_Instance_Name
Internal
The version of DAXI installed when generated The version of AX installed when generated The server name and the port that the AOS is running on The name of the AOS Instance
Field_Object Field_ReportDesign
Field_Filename
Enable Reports setting Derived at runtime from report instance Derived from Delivery Destination logic Derived at runtime
Field_UserId Field_UserName Field_GroupIds
Derived at runtime Lookup in user table User’s groups
Field_GroupNames
User’s groups
Field_UserEmail Field_CompanyId
Lookup in user table Derived at runtime
Field_Path
Microsoft Dynamics AX Connector Implementation Guide
Folder where XML file was created Name of the XML file created by AX Logged on AX user Full name AX user All group ids for which the user has memberships All group names for which the user has membership If available The company account for the current logged on AX user
49
APPENDIX A
.....
50
Processing Parameters
XML Tag
Source
Notes
Field_TestIndicator
Enable Reports Table
Field_RequestType
Derived at runtime based on how the output scenario that initiated the request
This is an indicator passed to trigger conditional logic for testing the BT-PDA process Values: Preview Default Adhoc
Field_DeliveryMethod
Field_DeliveryMethod_Code
Field_DestinationName
Field_ProcessName
50
Derived at runtime based on the delivery method selected from the Printer Setup dialog OR if the report was invoked via a preview or default scenario the delivery method is determined by the logic for the scenario The delivery method
Derived at runtime from selected Delivery Destination If Delivery Method is “Screen” then this is the “Screen Preview Process” from the Enable Reports table or Defaults table. If Delivery Method is “Process” then this is the process selected in the Printer setup dialog Otherwise this is the “Default Process” from the Enable Reports table or the Defaults table
Microsoft Dynamics AX Connector Implementation Guide
Values: Screen Printer E-mail Fax Process Contains the code for the delivery method of the report. Screen: 0, Printer: 1, E-mail: 2, Fax: 3, Document Process: 4
.....
APPENDIX A
51
Processing Parameters
XML Tag
Source
Field_ProcessProject
Corresponding “Process Project” for the selected process. Lookup form the processes table. Derived at runtime from selected Delivery Destination. If Delivery Destination field is null, then use setting from Default table Derived at runtime from XML file name Derived at runtime from selected Delivery Destination If Request Type = Adhoc, then entered in Printer setup dialog else null Derived at runtime from selected Delivery Destination If Request Type = Adhoc, then entered in Printer setup dialog else null If Request Type = Adhoc, then entered in Printer setup dialog else null If RequestType = Adhoc, then entered in Printer setup dialog else null. If Request Type = Adhoc, then entered in Printer setup dialog else null If Request Type = Adhoc, then entered in Printer setup dialog else null If Request Type = Adhoc, then entered in Printer setup dialog else null. Derived at runtime from selected Delivery Destination
Field_ScreenTempPath
Field_ScreenTempFileName Field_PrinterNetworkId
Field_PrinterCopies
Field_EmailNetworkId
Field_EmailAddressForm
Field_EmailAddressesTo
Field_EmailAddressesCC
Field_EmailAddressesBCC
Field_EmailSubject
Field_EmailBody
Field_FaxNetworkId
Microsoft Dynamics AX Connector Implementation Guide
Notes
Has data when Delivery Method = Screen
Has data when Delivery Method = Screen Has data when Delivery Method = Printer Has data when Delivery Method = Printer Has data when Delivery Method = Email Has data when Delivery Method = Email Has data when Delivery Method = Email Has data when Delivery Method = Email Has data when Delivery Method = Email Has data when Delivery Method = Email Has data when Delivery Method = Email Has data when Delivery Method = Fax
51
APPENDIX A
.....
52
Processing Parameters
XML Tag
Source
Notes
Field_FaxNumber
Has data when Delivery Method = Fax
Field_DesintationParameters
If Request Type = Adhoc, then entered in Printer setup dialog else null If Request Type = Adhoc, then entered in Printer setup dialog else null Delivery Destinations
Field_ReportParameters Field_TotalNumberInBatch
Enabled Reports Batch Processing
Field_CurrentNumberInBatch
Batch Processing
Field_FaxCoverSheetText
52
Microsoft Dynamics AX Connector Implementation Guide
Has data when Delivery Method = Fax Specify destination parameters Specify report parameters Total number of documents in the batch Document’s Order in the batch
.....
APPENDIX A
53
BT-DPA Tags
BT-DPA Tags BT-DPA tags are used as a label prefix for components of the solution. Below is a complete list. @DPA1 Microsoft Dynamics AX Connector 3.1 Support Contact: 1-800839-9029 @DPA2 Version 1.20 @DPA3 Create!form @DPA4 Report Processes @DPA5 AOT Object ID @DPA6 Document Process @DPA7 E-mail Email Destination Type @DPA8 Preview Display Options @DPA9 Preview Only @DPA10 Display Printer setup dialog after Preview @DPA11 BT_DPA @DPA12 Delivery Destinations @DPA13 Document Processes @DPA14 Enabled Reports @DPA15 Printers @DPA16 Default AOT Report Object Design @DPA17 Printer Share @DPA18 XML Output Location @DPA19 Default Document Process @DPA20 Screen Preview Temp Location @DPA21 Default Screen Preview Timeout (in seconds) @DPA22 Network ID @DPA23 Last Optimized @DPA24 Printer Description @DPA25 Process Name @DPA26 Process Project
Microsoft Dynamics AX Connector Implementation Guide
53
APPENDIX A
.....
54
BT-DPA Tags
@DPA27 User or Group @DPA28 Screen Preview Timeout (in seconds) @DPA29 User or Group Assigned @DPA30 XPO Backup Location @DPA31 BT DPA Number Sequence @DPA32 BT DPA GUID @DPA33 AOT Reports @DPA34 Create!form Enabled @DPA35 Screen Preview Process @DPA36 Default Process @DPA37 Enable Delivery Print @DPA38 Enable Email Delivery @DPA39 Enable Fax Delivery @DPA40 Enable Document Process Delivery @DPA41 Display Print Dialog after Screen Preview @DPA42 Testing Parameters @DPA43 BT_DPA_XML_Design @DPA44 Destination Id @DPA45 XML Path @DPA46 Restrictions @DPA47 Destination Type @DPA48 Print copies @DPA49 Bottomline Technologies @DPA50 This form must be called with parameters @DPA51 Email @DPA52 Cover Sheet Text @DPA53 Destinations Assigned @DPA54 Destinations Available @DPA55 Processes assigned @DPA56 Processes available @DPA57 This is not a valid UNC path @DPA58 Destinations 54
Microsoft Dynamics AX Connector Implementation Guide
.....
APPENDIX A
55
BT-DPA Tags
@DPA59 Table that hold configuration parameters @DPA60 Parameter key @DPA61 AOT Object Name @DPA62 Create!form Enabled enabled @DPA63 Optimize Report @DPA64 Default Non-Inquiry Delivery Destination @DPA65 Default Screen Preview Delivery Destination @DPA66 Fax Network ID @DPA67 Printer Network ID @DPA68 E-mail Network ID @DPA69 Restrict to Users @DPA70 Restrict to Groups @DPA71 Delivery Method @DPA72 User Restrictions @DPA73 Restricted use @DPA74 Destination Description @DPA75 For production operation, this parameter should be a network file share. @DPA76 No XML path provided for this BT enabled Report @DPA77 No PDF path provided for this BT enabled Report @DPA78 You do not have permission to process this report with Create!form. @DPA79 Please contact your administrator. @DPA80 Version 1.21 @DPA81 Version 1.23 @DPA82 FormLetter @DPA83 Version 1.24 @DPA84 Version 1.25 @DPA85 Version 2.0.26 @DPA86 BankChequePrint @DPA87 Process Description @DPA88 Destination Name
Microsoft Dynamics AX Connector Implementation Guide
55
APPENDIX A
.....
56
BT-DPA Tags
@DPA89 Version @DPA90 This report does not have a Generated Design.\n\nAlthough this report will be processed using Create!form,\nthe Administrator should generate a design for this report\nto avoid long processing time during the print process. @DPA91 No generated Design @DPA92 Not Create!form enabled @DPA93 Attempt %1 of %2\nPDF File does not exist.\nLarge files may take longer.\nSearch Again? @DPA94 Maximum number of retries attempted. File %1 still does not exist. @DPA95 File search cancelled by user. @DPA96 Date Enabled @DPA97 Date report becomes Create!form enabled @DPA98 Date Disabled @DPA99 Date report is no longer enabled for Create!form @DPA100 Warning: this report will never be enabled. The disabled date is not after the enabled date. @DPA101 Warning: this report will never be enabled. The disabled date is in the past. @DPA102 Recipient Delivery Preference @DPA103 Destination Parameters @DPA104 Report Parameters @DPA105 Recipient Delivery Preference is already installed @DPA107 Time Enabled @DPA108 Time Disabled @DPA109 Effective Time @DPA110 Design Name @DPA111 Deployment Schedule @DPA114 Date Design Enabled @DPA115 Time Design Enabled @DPA116 The name of the printer or fax queue, or the E-Mail server location. @DPA117 Create!form Screen @DPA118 Create!form Printer 56
Microsoft Dynamics AX Connector Implementation Guide
.....
APPENDIX A
57
BT-DPA Tags
@DPA119 Create!form E-Mail @DPA120 Create!form Fax @DPA121 Create!form Process @DPA122 Combine into one Report @DPA123 3.1.08 @DPA124 XML Path may be invalid @DPA125 Remaining Users @DPA126 Remaining Groups @DPA127 Temporary table that holds a report's designs @DPA128 Key to the parent table (DPA_AOT_Reports) @DPA129 Report designs that are available (used for lookup) @DPA130 Date key @DPA131 Table for holding DPA sequences @DPA132 DPA defaults @DPA133 DPA Print Settings @DPA134 Process ID @DPA135 Type of field that is in an XML file @DPA136 Warning, XML path (%1) is currently invalid on server @DPA137 Warning, screen preview path (%1) is currently invalid on server @DPA138 Warning, both the report and the default XML path is blank. @DPA139 Warning, both the report and the default screen preview path is blank. @DPA140 Number of remittance lines per page @DPA141 Error, no delivery destinations are assigned to report %1. @DPA142 Send To @DPA143 Waiting... @DPA144 Retrieving Preview for %1 @DPA145 Fit Page @DPA146 Full Page @DPA147 Zoom Out @DPA148 Zoom In
Microsoft Dynamics AX Connector Implementation Guide
57
APPENDIX A
.....
58
BT-DPA Tags
@DPA149 First Page (Microsoft Dynamics AX only) Note @DPA149 is for Microsoft Dynamics AX 4.0 only. For Microsoft Dynamics AX 2009 @DPA149 is Acrobat @DPA150 Acrobat @DPA151 Preview Type @DPA152 No non-screen destinations are assigned for report %1. @DPA153 No screen destinations are assigned for report %1. @DPA154 Error copying to %1, access was denied. @DPA155 Save a copy of this report @DPA156 DPA System Default @DPA157 Email Attachments @DPA158 Add (10 maximum) @DPA159 EMail Attachment File @DPA160 %1 attachments @DPA161 Attach files @DPA162 Error copying file %1 to %2 @DPA163 Windows error number: %1 @DPA164 Error, email attachments requires a valid default preview path @DPA165 Adobe Reader is required for previewing reports
58
Microsoft Dynamics AX Connector Implementation Guide
.....
APPENDIX A
59
Security Keys
Security Keys Security Keys are automatically installed during the Microsoft Dynamics AX Installation when the project XPO is imported. The Application Object Tree or the project can be inspected to verify that the Security Key is installed. To verify the Security Keys were installed
1
Click the Project icon on the top of the screen.
2
Expand the Shared folder.
3
Scroll down to BT_DPA _AX2009_Ver_3_0_15 and click to open the Project icon.
4
Once the Project is open, if the Security Keys are successfully installed, they appear on the Project’s Application Object Tree.
The Microsoft Dynamics AX components of the Integration include 5 security keys (1 parent key and 4 child keys).
Microsoft Dynamics AX Connector Implementation Guide
59
APPENDIX A
.....
60
Security Keys
•
The "Create!form, Setup" key can be used to restrict access to Create!form menu items on the Administration navigation pane.
•
The "Create!form, Tables" key can be used to restrict access to Create!form tables. At a minimum, all users need "View" level access to the tables, but only administrators of the Create!form configuration settings need "Create" level access.
•
The remaining keys ("Daily" and "Periodic") are not presently used.
Refer to the Microsoft Dynamics AX Help for more information on Security Keys.
60
Microsoft Dynamics AX Connector Implementation Guide
.....
APPENDIX A
61
Glossary
Glossary AX: acronym for Dynamics AX as well as Axapta. AOT: acronym for Application Object Tree. BT-DPA: This is the generic acronym which stands for "Bottomline Technologies - Document Process Automation". This is used in the integration as a label prefix for components of the solution. form: the AX AOT objects representing UI windows integration: the short name for referring to delivered solution that is installed into an existing AX implementation. report: the AX AOT objects representing AX output intended to be printed
Microsoft Dynamics AX Connector Implementation Guide
61
APPENDIX A
.....
62
Glossary
62
Microsoft Dynamics AX Connector Implementation Guide
.....
INDEX
63
INDEX
Index
A Appendix 47 Attachments 10
B BT-DPA Tags 53
C Chapter 2 Configuration 13 Consistant 10 Create!form Designer 8 Create!form Director 8 Create!form Server 9
D Date Format 11 Delivery Destinations 18 setting up 19 Document Process 38 Document Processes 14 setting up 14
E Enabling Reports 25 Enhanced Features 37 Enterprise Portal 44
G Glossary 61
I Introduction 7
Microsoft Dynamics AX Connector Implementation Guide
63
INDEX
.....
64
L Label View 11
M Multi-select Preview Support 45
P Preview 10 Print Management 38 Printing Batch Jobs 32 Processing Parameters 49
R Report Viewing 10
S Security Keys 59 Specifying Default Values 16 Specifying the XML Path 31 mapping directly to a Queue 31 Steps for Configuration 12
T To associate a report object with a project 25 To define a delivery destination 19
X XML File Naming Convention 48
64
Microsoft Dynamics AX Connector Implementation Guide