 |
The Organizations, Policy, and Product Setup Application (OPPSA) and OPPSA Webservices are now available for use with Document Generation Services.
In a previous release we had introduced enhancements to the Management Tool to formally remove accounts and aliases associated to a library when the library is being un-deployed (see previous Change Logs for PBI's 404166 & 382509). Prior to those changes, when un-deploying a library, aliases associated to those libraries (that were un-deployed) would become an ‘orphan’ in the database and would still show in the Account list. With this release we performed a ‘clean up’ to remove all orphaned aliases, for un-deployed libraries, from the database and the Account list.
We have added upgrade documentation for those users who have previously installed Document Generation Services and all components. For more information, see Upgrade Process Overview.
We have enhanced the Document Generation Services (Document Services) API documentation to include detailed request and response examples for each operation. For more information, see Appendix: Request and Response Samples.
This release includes a defect correction to the DGS Management Tool so that when cloning an account in Admin, the aliases pertaining to that account now clone successfully.
We have implemented an enhancement to the Document Generation Services installer in the Octopus Deploy transform through the "BusQueue" configuration appSetting. This configuration enhancement impacts the DocGenServiceHost, DocGenServices, Management, and ManagementServices configuration files.
Users can now edit the "BusQueue" configuration appSetting to set the desired RabbitMQ host server name for the following configuration files:
DocGenServiceHost, DocGenServices, and ManagementServices
<add key="BusQueue" value="rabbitmq://<your Server name goes here>"/>
Management
<add key="RabbitmqHost" value="rabbitmq:// <your Server name goes here>"/>
We have introduced a new <Sequencing/> element to the following field types in the Expere response file:
This <Sequencing/> element is implemented for the Secure Document Exchange (SDX) product for those users who sign across documents. It also makes each field unique so Document Generation Services can merge PDF documents that use signature, date, initial, and fillable text fields.
If the "MergePDF=true" in the response file, the Signature, Date, Initials, FillableCheckboxes and FillableText field types elements will contain sequencing in the <FieldName/> element using an incremental numbering system with an underscore.
Sequencing logic and format example:
<r:SignaturePointSet> <r:Signer> <r:Id>Homer</r:Id> <- Signer ID <r:Description>Borrower, Borrower</r:Description> <r:SignaturePoints> <r:Type>Initials</r:Type> <r:Sequencing>1</r:Sequencing> <r:FieldName>INI_Borrower_null_homer_false_1_SigField_1</r:FieldName> </r:SignaturePoint> <r:SignaturePoint> <r:IncludeDate>true</r:IncludeDate> <r:PageNumber>1</r:PageNumber> <r:SignatureText>Homer Simpson</r:SignatureText> <r:Type>Signature</r:Type> <r:Sequencing>2</r:Sequencing> <r:FieldName>SIG_Borrower_null_homer_false_1_SigField_2</r:FieldName> </r:SignaturePoint> <r:FillableFieldSet> <r:FillableText> <r:FieldName>FillableField_3</r:FieldName> <r:ToolTip>fill in here</r:ToolTip> <r:PageNumber>1</r:PageNumber> <r:Width>420.0</r:Width> <r:Height>72.0</r:Height> <r:XCoordinate>56.0</r:XCoordinate> <r:YCoordinate>100.0</r:YCoordinate> <r:Sequencing>3</r:Sequencing> </r:FillableText> <FillableCheckBox> <r:FieldName>FillableCheckBox_4</r:FieldName> <r:ToolTip>check here</r:ToolTip> <r:PageNumber>1</r:PageNumber> <r:Checked>false</r:Checked> <r:XCoordinate>22.0</r:XCoordinate> <r:YCoordinate>140.0</r:YCoordinate> <r:Sequencing>4</r:Sequencing> </FillableCheckBox> </r:FillableFieldSet>
Previously, when leading and trailing spaces were included in the Original Value upon adding an alias users would receive an error when using the alias at transaction time.
The Management Tool has been updated to remove any leading and trailing spaces from the Original Value when creating an alias, so users no longer receive errors at transaction time.
Previously in PBI 404166, we added a confirmation page that verifies the removal of associated accounts and aliases when undeploying a libary. In this PBI, undeploying a library now removes the aliases and account permissions upon clicking OK on the confirmation page.
For more information, see Undeploying a Library.
The Document Generation Services Tool Suite now contains a feature that allows internal users to download any customer transaction file with the non-public information (NPI) data scrubbed (removed) from it. To take advantage of this new feature users may go to the Request Details page in the Tool Suite and select the Download Transaction button.
The resulting exported transaction file will reside in TXN format that can be resubmitted through the Select, Select and Generate, and Generate actions.
For more information, see the SUPPORT - Downloading transaction data help topic.
Document Generation Services Tool Suite users can now access all available and licensed OPPSA organization and product information through the Select and Generate and Generate actions.
We have added a new <SignerEmail/> element to the <Signer/> element.
This element appears in the Expere response file when including the "eSignatureWKES" flag in the initial request. Sample code below:
<r:SignaturePointSet> <r:Signer> <r:Id>homer</r:Id> <r:SignerEmail>Joe.Doe@wolterskluwer.com</r:SignerEmail> <r:Description>Borrower, Borrower</r:Description> <r:SignaturePoints> <r:SignaturePoint> <r:IncludeDate>true</r:IncludeDate> <r:PageNumber>1</r:PageNumber> <r:PageOrder>1</r:PageOrder> <r:Height>72.0</r:Height> <r:Width>540.0</r:Width> <r:SignatureText>Homer Simpson</r:SignatureText> <r:XCoordinate>36.0</r:XCoordinate> <r:YCoordinate>396.0</r:YCoordinate> <r:Type>Initials</r:Type> <r:FieldName>INI_Borrower_null_homer_false_1_SigField_joe.doe@wolterskluwer.com</r:FieldName> </r:SignaturePoint> </r:SignaturePoints> </r:Signer> </r:SignaturePointSet>
Previously, when attempting to queue a build with an existing library prefix, the build process executed but failed. This caused the existing library to become inoperable.
The library build queue process has been enhanced; as a result, when deploying a library with an existing prefix, users now receive the following message:
The existing library will continue to operate as expected.
When undeploying a library, users are now presented with a confirmation page containing a list of associated accounts and aliases.
We have now initiated that change in PBI 382509.
For more information, see Management Tool: Undeploying a Library.
Wolters Kluwer Electronic Signature (WKES) users can now initial documents with a fillable text field (Acroform) using a new element called </eSignatureWKES>, as a child of the </ESignatureAndFieldSupport> element in the </AncillaryOutputOption>. If setting this element to "true," the initials render as a fillable text field on the document(s). By default, this element is set to "false" and renders as an eSignature field. In a future release, WKES users will be able to capture initials one time per signer and populate those initials to all the respective signer fields.
<r:AncillaryOutputOption> <r:OutputType>ESignatureAndFieldSupport</r:OutputType> <r:ESignatureAndFieldSupport> <r:eSignatureTooltip/> <r:eSignatureInitialsTooltip/> <r:eSignatureCoordinatesOnly>false</r:eSignatureCoordinatesOnly> <r:eSignatureDateSupport>true</r:eSignatureDateSupport> <r:NonSignatureFieldCoordinatesOnly>true</r:NonSignatureFieldCoordinatesOnly> <r:eSignatureWKES>false</r:eSignatureWKES> </r:ESignatureAndFieldSupport> </r:AncillaryOutputOption>
This enhancement allows Document Generation Services to return OPPSA organization and production information to OPPSA users.
We have added OPPSA Organization and OPPSA Product parameters to the following API's:
Previously, users reported SQL exceptions when persisting the Result to the database, due to <InstanceDisplayName/> and <InstanceFileName/> element values exceeding 254 characters. Our database only supports a maximum length of 255 characters.
We have increased the maximum length of the <InstanceDisplayName/> and <InstanceFileName/> elements in the ResultDocument table.
We have enhanced Document Generation Services to use MassTransit 3.3.5. This upgrade resolves internal issues that occurred with DocGenSvcHost. With this change, the target .NET verson of Document Generation Services was updated to .NET 4.6.2.
For more information, see http://masstransit-project.com/.
An issue existed in an older version of RabbitMQ which prevented viewing what is in the various Queues through the Management Console. RabbitMQ has been updated from version 3.6.3 to 3.6.5 within Document Generation Services to resolve this issue. There is no impact to the user.
Previously, Document Generation Services only returned one DocInstance when merging PDF documents. As a result, only one set of elements was returned, rather than multiple sets of elements determined by the number of DocInstances.
Document Generation Services now returns separate DocInstances when the merged PDF is set to "true" in the response file.
For more information, see the following:
The <Packet/> now contains the following attributes:
These attributes are included in the <Packet/> element so users can create packets of documents.
When previously installing the Document Generation Services .msi file to the Mortgage Continuous Integration 814 environment, users reported issues accessing the DGS Tool Suite. It was determined that connectionString="Server=localhost..." when it should have been populated with a valid server value.
This issue has been addressed: <connectionString="…" now contains a valid server value.
<connectionStrings> <add name="DocGenSvcs" connectionString="Data Source=labw6408hvm815.wkmnlab.net;Initial Catalog=docgen;Integrated Security=true;" providerName="System.Data.SqlClient"/> <add name="SecurityTokenDbContext" connectionString="Data Source=labw6408hvm815.wkmnlab.net;Initial Catalog=AppSecurityTokenCache;Integrated Security=True;" providerName="System.Data.SqlClient"/> </connectionStrings>
Previously, users were logged out of the Document Generation Services Management Tool after 25 minutes, regardless of their activity. The expected behavior is that the Management Tool only times out after 25 minutes of user inactivity.
The Management Tool has been enhanced to only time out after 25 minutes of user inactivity.
Previously, users were logged out of the Document Generation Services Management Tool after 25 minutes, regardless of their activity. The expected behavior is that the Management Tool only times out after 25 minutes of user inactivity.
The Management Tool has been enhanced to only time out after 25 minutes of user inactivity.
Previously, entering a Transaction ID from the Generate Results page would generate the corresponding .ZIP file with .PDF's; however, the Transaction ID field was editable. The expected behavior is that the Transaction ID field should disabled after generating the associated .ZIP file.
The Transaction ID is now disabled after entering an ID and generating the .ZIP file containing the appropriate .PDF files.
See Generate Results for more information on using this feature.
The Document Generation Services installation process now includes JBoss. No user action is required.
The Document Generation Services installation process now includes JBoss. No user action is required.
We have created a new eSignatureAndFieldSupport element to support returning XY coordinates for all fillable fields.
The following enhancements have been implemented for the Management Tool:
The Document Generation Services Management Tool now utilizes the latest version of the Expere Content Administration tool. This version now ensures content is deployed with content stylesheet changes required for a recent Saxon and Java 8 update.
In an effort to support returning XY coordinates for all fillable fields we have begun the development work. The first step in supporting this feature is creating a new element (eSignatureAndFieldSupport).
The Document Generation Services Management Tool now utilizes the latest version of the Expere Content Administration tool. This version now ensures content is deployed with content stylesheet changes required for a recent Saxon and Java 8 update.
In an effort to support returning XY coordinates for all fillable fields we have begun the development work. The first step in supporting this feature is creating a new element (eSignatureAndFieldSupport).
After submitting a transaction in Document Generation Services, users will now receive a response file containing the Package Documents, which contain <DocCustomData/> elements in the packages.
The new elements exist as children and grandchildren of the <r:DocDescriptor/> element. The <r:DocCustomDataItem/> elements contain the following DataItemName attribute values:
We have updated the Document Generation Service installation instructions. You can access the installation instructions here: Document Generation Services Installation Overview
The previous version of AutoMapper was not thread-safe and caused problems when multiple threads ran.
AutoMapper 4.2.1 has been optimized to repair thread-related issues, when multiple requests are process simultaneously. Document Generation Services has been updated to use AutoMapper 4.2.1.
For more information, see http://automapper.org/.
Users can now create and maintain the ContentID for a specific account in the Management Tool. For more information, see Manage Accounts.
Previously, Masstransit enhanced its consumer functionality to use tasks and asynchronous messaging. As a result, the consumer shared session resources.
An interim solution was implemented that prevented NHibernate from crashing with other shared tasks. We have now enhanced the NHibernate session object that prohibits session sharing.
In a previous release, we had released First Page Barcode functionality, albeit in limited functionality.
First Page Barcode is now fully functional in Document Generation Services for SelectAndGenerate and Generate methods.
Users can now pass eSignature and Acroform values in the AncillaryOutput of a SelectAndGenerate or Generate request. For detailed information on enabling or disabling eSignature or Acroforms, see Using eSignature and Acroform fields.Select And Generate, and Generate.
The Management Tool has been updated with a new Manage Accounts tab. This new area that allows users to access those view/search accounts based on licensed product. Users can search by Account Name or Customer Number. For more information, see Manage Accounts.
The GetActiveAccountsByProduct API has been created to associate the Content ID with the Account ID in the Administration tool; this allows the Management Tool to call the Administration API by line of business. Administration then returns values for the following fields:
The effective date for all products within the scope of this document for this release is April 14, 2016 for the CT environment and April 21, 2016 for the Production environment.
The latest version of Document Generation Services uses the Expere Engine version 2015.4. See the Expere Engine and Tools Change Log for detailed information on the 2015.4 release.
The following installation enhancements have been implemented:
The Expere ListDocuments API is now available through DGS.
The ListDocuments option calls a base or custom package of documents defined by the customer. The list of documents in the base or custom package is displayed for the end user to select and use for a given transaction.
Performance has been enhanced to improve request processing and minimize any deadlock errors.
Previously, the Document Generation Services installation process was updated from Network Service to Machine Identity. Due to some configuration issues, the installation process has been reverted from Machine Identity back to Network Identity.
The following sections in the Installation Overview have been reverted to their previous iteration:
SQL scripts used with the Document Generation Services tables have been enhanced to remove any records older than seven (7) days. The scripts now remove the records on a nightly basis.
Summary: Users can now apply a barcode to the first or only page of a document. For detailed information on using this feature within the Document Generation Services Tool Suite, see the Select And Generate and Generate webhelp sections within the SERVICE PageUsing First Page Only Barcodes webhelp page.
Previously, when adding a new alias to an existing library that began with expere://, the following message appeared:
This issue has been addressed; users can now add a new alias to an existing library.
Previously, the version number and copyright appeared on the middle of the page when scrolling through the library list.
This issue has been resolved; the copyright and version number now appear on the footer of all pages in the Management Tool. We also updated the stylesheet used with the Management Tool.
Previously the Copy Library function only copied the permissions and aliases if the library name was unique. Additionally, the Copy Library function would add new aliases to an account when the account only had permission to the library but did not have an existing alias pointing to the library.
The Copy Library function has been enhanced so that permissions and aliases are copied for a duplicate library name and aliases are no longer created when an account only had permissions to the existing (old) library.
See Copying Libraries for detailed information on this functionality.
Previously, the Select API performed a retry five (5) times with every call, even when no errors had occurred in the call. The unnecessary retries may have resulted in performance delays.
This issue has been resolved; the Select API now only performs a retry when an error occurs during the API call, with a maximum retry limit of 5.
Additionally, Document Generation Service callbacks have been updated to only retry a maximum of 8 times; previously we allowed up to 15 retries.
The amount of memory dedicated to the Expere Engine has been increased to prevent out of memory errors. The following values in Web.config have been modified:
The file is located at: $/DocGenServices/Dev/src/DocGenServices/ExpereNetZip/ModifiedFiles/Web.Config.
No user is action is required.
The Document Generation Services and Expere version numbers now appear on all footers in the Tool Suite and Management Tool.
The installation process now requires the user to run a CreateSecurityTokenCacheDBDGS.sql script with SQL Management Tools before using Document Generation Services. For more information, see Running the CreateSecurityTokenCacheDBDGS.sql script.
A SUPPORT page enhancement has been implemented when using the Tool Suite in Internet Explorer.
Previously, entering the Account ID and clicking Enter resulted in the Tool Suite immediately loading the transactions for that account. However, the transaction list did not appear for the specified account. Conversely, entering the Account ID and clicking View resulted in the Tool Suite displaying the transaction list for that account.
Now, either clicking View or Enter loads the transaction list for the specified account.
Additionally, users can now add over 400 aliases to a single account.
For more information, see Importing New Aliases.
Document Generation Services now utilizes a certificate when calling the callback service. The callback object now includes an authentication object, which consists of a username, password, and client certificate name.
Integrators should consult SelectAndGenerate Request, Callback, and CallbackAuthentication for detailed information on using certificates.
The Document Generation Services Tool Suite has been enhanced to reduce transaction loading time.
The following enhancments have been implemented on the SUPPORT, Select and Generate, and Generate, Select, and Select-Synchronous pages of the Document Generation Services Tool Suite:
The SUPPORT, Select and Generate, Generate, Select, and Select-Synchronous pages contains detailed information on using this functionality.
A new Management Services checkAliasesinAccount API is now available that determines whether custom content from a source account should be applied to a new account when using the Copy Aliases function in the Document Generation Services Management Tool.
For detailed information, see checkAliasesinAccount.
The Copy Aliases functionality was introduced in a recent sprint iteration; when originally implemented, users could not overwrite duplicate account aliases between source and new accounts. An enhancement has been introduced to allow users to overwrite duplicate account aliases; when overwriting, Document Generation Services replaces the aliases with the new account with those of the source account.
For detailed information on using the Copy Aliases functionality, see Copying aliases and account information.
Document Generation Services now automatically allows access to base content; users are now no longer required to create an alias for base content in the Management Tool.
An alias is now required only if a library is pointing to custom content. When pointing to base content, the library will incorporate "Mortgage" into the alias.
Document Generation Services now load balances without sticky sessions.A user session is no longer bound to a specific instance. The Tool Suite and Management tool function normally without sticky sessions enabled on the load balancer.
Customer support specialists can now copy aliases from one account to another account.
See Copying aliases and account information for detailed information.
Users can now simultaneously update the version number of the destination value (library path) for an alias (orig value) for a group of accounts.
See Updating the Version Number for an Alias Group for detailed information.
Users can now create multiple aliases for multiple accounts through a new Import New Aliases option on the Manage Aliases page in the Document Generation Services Management Tool. The Import New Aliases option utilizes uses a .CSV file with user-defined Account ID, Orig Value, and Destination Value/New Value values to create the alias.
See Importing New Aliases for detailed information.
The application for Document Generation Services has been updated to support SQL. All supporting components have been updated. With this upgrade, transactions will not be migrated from the old database to the new database. You will not be able to receive responses using the previous Request/Transaction ID after the upgrade has occurred.
The Document Generation Services Management Tool library deploy no longer updates content references with the Management deploy; you will now need to run the command line to update content references prior to create the library .ZIP file.
Additionally, a -nocopy switch has been enabled for the content deployment. This automatically builds the content by placing the documents at a specific organization level without copying ancestor-level documents. The Document Generation Management Tool has been udpated with a new Expere Admin .DLL that implements the -nocopy switch.
Previously, requests were not always being routed to the most available server, which caused performance issues. Only the DocGenSvcHost service that resided on the same host server receiving the API request would receive the message.
Messages are now distributed across all DocGenSvcHost services. This enhancment better manages the existing, available servers to work equally, thus optimizing message distribution and performance.
Previously, users were required to manually add account permissions when a new libary was deployed that used existing aliases.
This functionality has been enhanced; when updating an alias to point to a new version of the library, user account permissions are updated to access the new version.
Previously, users could not overwrite the Destination Value (DestValue) for an existing Original Value/Alias (OrigValue) in a .CSV file through the batch alias creation process. The Management Tool has been enhanced to allow users to overwrite the existing Destination Value for an existing Original Value/Alias in a .CSV file.
In the Management Tool, the following message appears in the Status column after changing the DestValue and uploading the modified .CSV file:
For more information, refer to Importing New Aliases section in the Document Generation Services Management Tool User Guide.
When deploying a new library, timeout errors occurred when initially requesting document assembly after the content is first loaded and or the cache is cleared.
We have increased the default memory cache sizes, resulting in improved document assembly and reduced error occurrence. The following modifications were made:
Some users experienced issues loading larger-sized libraries into 32-bit systems. The Requirements.dll file was 32-bit to integrate with Abyss and Seareach.
The following .dll files were updated to integrate with 64-bit components:
Previously, Document Generation Services application log files were stored in multiple locations. The application log files have now been consoliated into one location and are now stored in C:\Program\WKFS\DGS.
The following log files are affected:
When selecting the SelectAndGenerate API and setting the AncillaryOutput option to apply barcodes, the barcodes are placed in the Integrated Disclosure documents despite the user not defining the barcode element in the original .REQ file.
The following options have been implemented:
If currently using ancillary output options and static content, the document does not automatically display the barcode cover page. Users will need to add the UseCoverPage element to the request. Refer to the Document Generation Services Integration Guide for more implementation details.
Previously, transactions in Document Generation Services remained in a processing state despite any package errors that may have existed. An error message should have appeared explaining the issue, and the transaction should have been placed in a failed state.
This issue has been resolved; any transaction in Document Generation Services that contains package errors is now placed in a failed state and displays an error message explaining the issue.
This enhancement causes client applications to call the Document Generation Services SecuritySessionService instead of DocViewer.
The Automated API test suite has been updated for the new API. Also, the new API was added to the available APIs in Document Generation Services Testing Tool.
Libraries were getting stuck at QueuedForDeployment. A temporary solution was implemented in EDS-CT that solved the QueuedForDeployment issue but resulted in libraries always getting reported as FailedDeployment because the ManagementService would try to deploy the library twice. Checking the logs was necessary to determine if the library actually deployed successfully.
Code changes have been made that are expected to solve both the stuck at QueuedForDeployment and deploying twice issues. If a library gets reported as a FailedDeployment after tonight’s update that should always mean the library actually failed to deploy.
To plan for future growth of DGS, we’ve converted the Long and Short Term Databases from using a Raven database to use a SQL database.
This enhancement provides SQL support to the Document Generation Services ToolSuite Support Tool.
In addition to supporting SQL, modifications to the Document Generation Services ToolSuite Support Tool also include the ability to view short term storage of up to seven days. A toggle switch has been added to provide ease of switching between Long Term and Short Term storage.
This enhancement provides SQL support to the Document Generation Services ToolSuite Support Tool.
In addition to supporting SQL, modifications to the Document Generation Services ToolSuite Support Tool also include the ability to view long term storage of greater than seven days. A toggle switch has been added to provide ease of switching between Long Term and Short Term storage.
|