To generate a package, select a Package and Effective Date on the Assignment Packages screen, and click
The user will see the status as the package is being built, along with the total number of items (Cost Estimates, Cost Estimate Reports, Compensation Calculations, Compensation Calculation Reports, and/or Merge Documents) included. Once built, the package contents will be shown. The user can download reports and merge documents, navigate to the created Cost Estimates or Compensation Calculations, or remove or rebuild a document as needed.
Note, an assignment package that is built successfully may still contain errors. To resolve assignment package issues, you may click the
to rebuild the whole package or check each component individually.
If an Assignment Package is built without errors, and the 'Auto Request Signature' is enabled on an e-sign document in the Assignment Package Template, an automatic process will issue the request for signing to specific documents that are part of that Assignment Package.
The Assignment Package can also be deleted by clicking the delete button. Deleting an Assignment Package built with e-sign Documents will cancel automatically any outgoing request for signature on those documents.
Cost Estimates
Cost Estimates – The name of the generated cost estimate (the Cost Estimate template + the date the estimate was created) is displayed as a hyperlink to the estimate.
Calculation Errors – If there were errors generating the Cost Estimate, an orange label will appear stating there were Calculation Errors. The user can manually navigate to the Cost Estimate to see more details of the error(s) and make corrections as needed. Associated reports may be regenerated in the package.
Cost Estimate Reports – Any reports configured for the template will be included below the corresponding Cost Estimate. The report Name is a hyperlink allowing the user to view or download the report.
Last Update Date – the date and time the component was last generated is displayed.
Report Actions ( ) – Clicking this will show additional actions available for a report; including [Rebuild Report], [Edit Details], and [Remove Report]
Rebuild Report – If changes have been made to a cost estimate and a report(s) within the package needs to be update, the user can click the [Report Actions] button ( ) and choose [Rebuild Report]. This will regenerate the individual report. If all reports for a given estimate need to be rebuilt, they need to be done individually. When report(s) have been rebuilt after delivery to the Employee Portal, they will not be updated and should be re-delivered.
Edit Details – Click to rename the report, or change the <Document Type> associated with the generated report.
Remove Report – If the user wishes to remove a report, the user can click the [Report Actions] button ( ) and select [Remove Report]. If a report is accidentally removed a new assignment package must be generated; else the user may run the report from the cost estimate and then manually attach it to the package. If report(s) are currently available in the Portal, the delivery must be reversed before the report(s) may be removed. Note: Documents can be manually added to the Documents section; not the Cost Estimate section.
Compensation Calculations
Compensation Calculations – the name of the generated Compensation Calculation (the Compensation Template + the date the Compensation Calculation was created) is displayed as a hyperlink to the calculation.
Calculation Errors – If there were errors generating the Compensation Calculation, an orange label will appear stating there were Calculation Errors. The user can manually navigate to the Compensation Calculation to see more details of the error(s) and make corrections as needed. Associated reports may be regenerated in the package.
Compensation Reports – Any reports configured for the template will be included below the corresponding Compensation Calculation. The report Name is a hyperlink allowing the user to view or save the report.
Last Update Date – the date and time the component was last generated is displayed.
Report Actions ( ) – Clicking this button will show additional actions available for a report; including [Rebuild Report], [Edit Details], and [Remove Report]
Rebuild Report – If changes have been made to a compensation calculation and a report(s) within the package needs to be update, the user can click the [Report Actions] button ( ) and choose [Rebuild Report]. This will regenerate the individual report. If all reports for a given calculation need to be rebuilt, they need to be done individually. When report(s) have been rebuilt after delivery to the Employee Portal, they will not be updated and should be re-delivered.
Edit Details – Click to rename the report, or change the <Document Type> associated with the generated report.
Remove Report – If the user wishes to remove a report, the user can click the [Report Actions] button ( ) and select [Remove Report]. If a report is accidentally removed a new assignment package must be generated; else the user may run the report from the compensation calculation and then manually attach it to the package. If report(s) are currently available in the Portal, the delivery must be reversed before the report(s) may be removed. Note: Documents can be manually added to the Documents section; not the Compensation Calculations section.
Documents
Documents – The Name of the generated document is displayed. If the user clicks the Name, the report can be viewed or downloaded.
Failed – If a document did not generate, a red Failed label will be shown. If an e-sign document, the document will not be sent if this encounters a failed status.
Last Update Date – the date and time the component was last generated is displayed.
Document Actions ( ) – Clicking this button will show additional actions available for a document; including [Rebuild Document], [Edit Details], and [Remove Document]. For e-sign documents, a [View Signature(s)] action is available and will redirect the user to the E-Signature Request Details Screen.
Rebuild Document – If changes have been made to an assignment or any corresponding screens that feed information to a merge document, the document will need to be refreshed. The user can click the [Document Actions] button ( ) and select [Rebuild Document]. This will rebuild only the selected merge document. If a user needs to rebuild all documents for an Assignment Package, each will need to be done one at a time. When document(s) have been rebuilt after delivery to the Employee Portal, they will not be updated and should be re-delivered.
When rebuilding an e-sign document in an assignment package, outgoing signature requests will be canceled and a new document will be created. A fully signed e-sign document will not be canceled but will only be removed from the Assignment Package.
Edit Details – Click to rename the document, or change the <Document Type> associated with the generated document.
Remove Document – If the user wishes to remove a document, the user can click the [Report Actions] button ( ) and select [Remove Document]. If a merge document is accidentally removed, a new assignment package must be generated; else the user may run the merge document on the assignment and save the file and attach it to the package manually. If document(s) are currently available in the Portal, the delivery must be reversed before the report(s) may be removed.
When an e-sign Document is removed while being part of an Assignment Package, if any signing request was already done, it will be canceled automatically.
Note, e-sign documents that are part of an Assignment Package cannot be deleted through the Assignment Documents screen.
Dynamic Labels - Dynamic labels visible on the e-sign document record that will shift information between errors found during the build, to options to request signatures from specific signers.
+ Add Document – Click to add additional documents to the generated Assignment Package.
Note, Assignment Packages with e-Sign Documents will only be allowed to initiate delivery if all the documents are fully signed.
Rebuilding an Assignment Package
Security Rights
In order to rebuild Assignment Packages, the user’s role must have Edit rights to Assignment Package and Assignment Package Details screens. No screen section rights are required. If users only need to have access to add a package, then edit and delete rights will not be needed.
In order to access the Assignment Packages screen within an assignment, the associated Service (Assignment Packages) must be authorized. If more information is needed on this process, see the Service Management User Manual.
Rebuilding
To rebuild an entire package, the
button can be clicked to completely recalculate and rerun all reports which replace the existing reports in the package. Rebuilding will take into account any changes that were made at the Cost Estimate, Compensation Calculation or Merge Document levels. Clicking the
button without making changes to those elements will result in a refreshed package with no difference from before. All elements of the Assignment Package will be run in the same order as originally run. This ensures any values or calculations that utilize cascading from one cost estimate or compensation calculation to another will be impacted correctly.
When some or all Assignment Package contents have been delivered to the Employee Portal and the entire package is rebuilt, the report(s) and/or document(s) that were previously delivered will not be updated with the refreshed contents. Creating a new delivery to the Employee Portal with the updated items will update what is currently available in the Employee Portal.
Rebuilding an assignment Package with e-sign documents on the other hand will cancel any outgoing requests for signature.















