This command is used to enable the “Save Local” feature in the browser interview.
Use Google to find help fast. For example, search on "xpressdox choosefromlist".
It may be that all, or at least some, of the data set to be used to assemble a document comes from some place other than the interview. For example, it might be that the data are in a data base, or retrieved from a web service or some other data source. Often data sets like this can contain data elements which are wrongly formatted or which in some other way do not conform to the business rules for the template that is being run. In this case it might cause a dangerously inaccurate document to be assembled from the data and template.
The ApplyRulesToDataset command will cause all the Rule commands to be executed against the data set, regardless of whether there is an interview or not.
The Rules will be evaluated just before the data set is passed to the assembly engine where the data set is merged into the template. If any of the rules fail, then an error message will be displayed and the assembly terminated.
The ApplyRulesToDataset takes one argument, with the following meanings:
ApplyRulesToDataset(Yes)»: the command will be applied.
ApplyRulesToDataset(IgnoreSoftRules)»: any “soft” rules (see Tips and Hints using the Rule Command) will be ignored.
ApplyRulesToDataset(No)»: the command is ignored completely.
AppendPDF enables the user, and also the template author, to choose one or more PDF files which will be appended to the document assembled by the template in which the command appears. The SaveAsPDF(Yes) command is issued implicitly. In other words, PDF files can only be appended to other PDF files.
Example – user supplies the file name
will present the user, in the interview, with a place to enter the name of the PDF file to be appended.
Example – template author supplies the file names
AppendPdf(‘.\ClauseFiles\Pdf File.pdf|.\ClauseFiles\Test Proposal.pdf’)»
will cause the two files Pdf File.pdf and Test Proposal.pdf to be appended to the assembled document. Note that the “pipe” symbol is used to separate files in the list of files to be appended.
When you have a system of templates and have run them a number of times, say for a number of your customers, the saved data set files become a source of valuable information. It would be nice to be able to access those data files as though they were a database.
That’s what the XpressDox Data Set Data Source will do for you.
You configure the data set data source in much the same way as any other data source – via the XpressDox configuration.
Choose the New Data Source button and you will be presented with a list of choices. Towards the end, on the right, is the radio button with the caption “XpressDox Data Set Data Source”.
Choose that and press “Finish”.
After that, you will need to give the data source a name, press Tab and then press the Use Data Source’s Editor button to edit the Definition String.
Once you’ve pressed that button, then the really exciting work starts. You will see a form like this:
Pressing the little “?” on the top right of the form will give you some help on the different options.
In the end, a picture is worth a thousand words, and the best way to find out what this data source does is to try out various options and test the result (with the “test data source” button, or just double-click the data source name) and see what XML structure is created. Thereafter you will probably know quite well how to address the data inside a template.
Values in databases can be changed by the user in the interview using the various “Save” options as described in Control how the user can change data source data.
The template author can also instruct XpressDox to modify values in a data base, using the SetDataSourceData function.
As an example, suppose there is a data source defined in the configuration called Customer which addresses a CustomerDetails table in a database. The following fillpoint would cause the values in the database to be changed:
SetDataSourceData('Customer',CustomerID,'Fullnames',concat(FirstNames, ' ', LastName),'PreferredLanguage',IIf((Lang = ''),'English',Lang))»
This fillpoint will cause the following actions:
- The row in the CustomerDetails table with a key whose value is in the CustomerID data element will be retrieved, and the values of the Fullnames and PreferredLanguage columns in that row will be modified as below.
- The value of the Fullnames column will be built up from the values of the FirstNames and LastName data elements, with a space between them.
- The value of the PreferredLanguage column will be set to the value of the Lang data element, if it has a value, otherwise the PreferredLanguage column will be set to ‘English’.
Up to 10 pairs of ColumnName,Value pairs can be specified in one call to SetDataSourceData.
Some of the sample templates which are delivered with XpressDox make use of one of the early instances of the Microsoft AdventureWorks SQL Server database. This database can no longer be obtained from any Microsoft web site, and so a backup is made available here.
You can download either the .bak file itself, by clicking on the following
or, if preferred,
Once this has been downloaded, you can use the Microsoft SQL Server Management Studio, or any other suitable application, to install the database on a test system.
This Cookbook article refers to the AdventureWorks database which needs to be installed at a location available to your development environment. If you have not already done so, you can download the database from Download the AdventureWorks Database.
It is assumed that you already know how to configure a datasource for a SQL Server database. If not, it is strongly recommended that you do so. You can follow the process by looking at the Cookbook articles Use a SQL Server Data Source to include Customer information on a template and/or Configure A Data Source for an Elite Database.
The process of defining a stored procedure as a data source is almost the same as that for defining a normal table or view as a data source, with the following differences:
- Where the configuration wizard presents a choice of tables and views, it will now also include the stored procedures in that list.
- Once a stored procedure is chosen, then configuration wizard will end, and give you the opportunity to modify the Definition String, using the Use Data Source’s Editor button for that.
Some concepts to bear in mind are (these concepts are all illustrated in the sample template Using a Stored Procedure as a Data Source.xdtpx which is delivered into the My Documents\XpressDox\Samples folder by the XpressDox desktop installer):
- All data sources require that an “ID” be defined, by which unique items can be retrieved from a data source. For a table or view, the ID is typically the primary key, or some other unique identifier such as an account number, or person number. In the case of a stored procedure, the ID consists at least of the arguments to the stored procedure, but may have more components. For example, in the case of the AdventureWorks database, the stored procedure dbo.uspGetManagerEmployees will get all the employees for a given manager. In this case the ManagerID is the single argument which needs to be sent to the stored procedure, but since this stored procedure returns a collection of Employee objects, an extra item, viz. the EmployeeID, is necessary as part of the ID of this data source. This is to make sure that the system knows how to distinguish between the multiple Employee objects returned by this stored procedure, which will have the same ManagerID.
- The usual data source retrieval commands can be used to get the data returned by a stored procedure. The above-mentioned sample template uses the LinkToDataSource Command and this is arguably the command which suits stored procedures best.
- As template author, you should have knowledge of what kind of information a stored procedure returns. If it returns a scalar value, or a number of scalar values (such as the Sales.uspGetEmployeeSalesYTD stored procedure used in the above sample), then the LinkToDataSource (or other data source command) should specify the “id=<EmployeeID>” type syntax. If, however, the stored procedure returns a collection, then the “range=…” syntax should be used. For example, if dbo.uspGetManagerEmployees is called using something like “id=<ManagerID>” in the data source command, then only the first Employee for that ManagerID will be returned. Calling the dbo.uspGetManagerEmployees stored procedure should be initiated using the “range=<ManagerID>” syntax in the data source command.
If you need to get data from a data source and have those data available in an interview (and hence in the data set), then the commands IncludeDataSourceData and ChooseFromDataSource would be what you would use.
If, while authoring the template, you come to a point where you need one or more the values of fields in a data source, and the ID of the data source is known to you, then you can use the GetDataSourceData() function to retrieve the field(s) in question.
In order to discuss these functions, imagine a scenario where you know the identity of the user who is running the template – you would use the WindowsLogonUser() function to find this. Imagine also that you have set up a data source with all of the users’ details in it (called “USERS”), where the ID of the data source is that username.
Getting the value of one field
At some point in the template you want to put the user’s first name (e.g. after “Dear”). This would be achieved like this:
This will get the row from the USERS data source where the ID is the WindowsLogonUser, and retrieve the ‘FirstName’ column from that row and put its value into the document.
Getting more than one field value
Imagine now that you would like to, say, end off a letter template with all of the user’s contact information, like full name, email address, direct phone line, etc. You could issue a GetDataSourceData for each of these fields, but each call to the function will cause a new access to the database, which can be inefficient of resource usage and time.
There is another form of the GetDataSourceData() function which omits the field name, and when this call is executed it returns, not a field/column value, but an XML representation of the data source row. Then the new function GetXMLElementValue will be used to retrieve individual field values from that XML. An example of that would be:
Email Address: «
Direct Line: «
If you are familiar with XPATH, then you can use XPATH functions to extract information from the XML string that has been retrieved. For example, in order to get the count of the number of Product elements in a retrieved XML string, this would be the code to use:
The number of products are: «
You could even get the sum of the cost price for all the Product elements like this:
The total cost price of all products is: «
Suppose you have defined a set of folders to contain clauses for insertion using the My Clauses or Shared Clauses features in the XpressDox ribbon. Normally you would group clauses together into folders containing clauses for similar uses. For example, they might be “Contracts”, “Notices”, “Letters”, etc.
In some cases the folder and sub-folder structure can get quite extensive. In particular, when choosing a clause from a folder deep in the folder structure, you might just want to be able to navigate quickly to another folder containing, maybe, more generic clauses. In case these generic clauses are not visible in the XpressDox Explorer, you, as a template author, could create shortcuts to those generic folders in the following way:
- Make a text file where each line consists of a shortcut definition.
- A shortcut definition is a description of the folder, a pipe symbol “|”, and then the folder itself.
- The folder can be a full absolute path, or else a path relative to the folder in question – e.g. ..\..\GeneralClauses
- Save the text file with the name XDShortCutFolders.txt in the folder where you want the shortcuts to show.
- The XDShortCutFolders.txt file will not be visible to template runners, only to template authors.
An example of a shortcut file would be:
English Contract Clauses|..\..\English\Contracts
French Contract Clauses|F:\Clauses\Francaise\Contrats
The shortcuts will be sequenced alphabetically in the Explorer along with the normal sub-folders. If you want the shortcuts sorted at the beginning, for instance, then start the “description” part of the definition (the part before the “|” symbol) with one or more spaces.
Although this example relates to shortcuts and clauses folders, the shortcut feature applies to any folder which is displayed by the XpressDox Explorer.
Sometimes, not in every case, when using the RemoveColumnIf command, in conjunction with The SaveAsPDF Command, it can turn out the the PDF renderer does not render the table where the column has been removed correctly.
The UpdateTableFormattingForPdf function will usually fix this table rendering.
Suppose you have a command «
RemoveColumnIf(Amount = 0,1)» inside a table in the template. If it turns out, by trial and error, that when saved as PDF the table is not rendered properly, then including the following fillpoint should fix the table format:
UpdateTableFormattingForPdf(Amount = 0)»
Note that the condition passed to the UpdateTableFormattingForPdf must result in the same value as the condition passed to the RemoveColumnIf.
If the assembled document is not to be saved as PDF, then the UpdateTableFormattingForPdf can still be included in the template, but will have no effect.