Skip to main content

Create an Assignment Package Template

Assignment Packages is available at the Company level, within the Company Configuration menu section.  The screen will display all configured Assignment Packages.  Per the user’s security rights, the

Updated over 2 weeks ago

Assignment Packages is available at the Company level, within the Company Configuration menu section. The screen will display all configured Assignment Packages. Per the user’s security rights, the user will be able to add, edit and/or delete packages.

New Package

A new package is created by clicking on the + icon on the Assignments Packages screen. Select <Defining A New Package> or <Copying An Existing Package> from Create New Package By. When <Copying An Existing Package>, the user must specify the Company To Copy From as well as the Package To Copy.

If the package being copied is from a different company than the one it is being created for, and the package contains company level content (Cost Estimate Templates, Compensation Templates, Production Reports, and/or Merge Documents including e-sig documents), those Company level components will not be copied over. The user will receive a warning message of such content.

When Enforce Assignment Security Rights is ticked, the Assignment Packages batches to fully respect user’s assignment rights based on the security of the user that is running the batch.

Cost Estimate Templates

Add Template – Click the

to add a new row to the section. Select the desired template from a list of company and system level Cost Estimate Templates.

*Note: Based on the Cost Estimate Template the user selects, the template can include/exclude tax calculations based on the configuration.

Mark as Primary – Once a Cost Estimate Template is added, click the down arrow to open the details of the Cost Estimate Template. Click the check box next to Mark Created Item as Primary to opt to make this template the primary cost estimate template used for assignments.

Add Report – Once a Cost Estimate Template is added, click the down arrow to open the details of the Cost Estimate Template. Click the plus sign next to Add Report to add a new row to the section. Select the desired report from a list of company level and system level Production Reports. You will be able to see all added reports when the Cost Estimate Template line is expanded. To see the details of each individual report, click the down arrow on the specific report.

Report Output Type – When a new Report is added, the output type is PDF by default. Users may change the output type by clicking on it and selecting from the list of available options. If the report is a Merge Document Report Type, then the Report Output Type field is not available; the output type is defined within the Merge Document.

Items may be sequenced by clicking on the box of the template and dragging and dropping the item to the desired list position. When generating an Assignment Package, Cost Estimates and associated Reports will be generated in the order in which these templates/reports are configured.

Report Parameters – When a Production Report is added, any necessary Report Parameters are also added. You can set the default values for each Parameter as appropriate. When the Package is generated and the report is created, these parameter values will be applied. Any required Report Parameters must contain a value; else upon generating the Package, the creation of the report will fail.

Remove a Report – Click the

button.

Remove a Cost Estimate Template – Click the

button. Any reports configured for the template being deleted will also be deleted.

Compensation Templates

Add Template – Click the

button to add a new row to the section. Select the desired template from a list of company level Compensation Templates.

Add Report – Once a Compensation Template is added, click the down arrow to open the details of the Compensation Template. Click the

button to add a new row to the section. Select the desired report from a list of company level and system level Production Reports. . You will be able to see all added reports when the Cost Estimate Template line is expanded. To see the details of each individual report, click the down arrow on the specific report.

Mark as Primary – Once a Compensation Template is added, click the down arrow to open the details of the Compensation Template. Click the check box next to Mark Created Item as Primary to opt to make this template the primary compensation template used for assignments.

Report Output Type – When a new Report is added, the output type is PDF by default. Users may change the output type by clicking on it and selecting from the list of available options. If the report is a Merge Document Report Type, then the Report Output Type field is not available; the output type is defined within the Merge Document.

Items may be sequenced by clicking on the box of the template and dragging and dropping the item to the desired list position. When generating an Assignment Package, Compensation Calculations and associated Reports will be generated in the order in which these templates/reports are configured.

Report Parameters – When a Production Report is added, any necessary Report Parameters are also added. You can set the default values for each Parameter as appropriate. When the Package is generated and the report is created, these parameter values will be applied. Any required Report Parameters must contain a value; else upon generating the Package, the creation of the report will fail.

Remove a Report – Click the

button.

Remove a Compensation Template – Click the

Button. Any reports configured for the template being deleted will also be deleted.

Merge Documents

Add Document – Click the

button to add a new row to the section. Select the desired document from a list of company and system level Merge Documents.

During the Assignment Package Lifecycle, one or multiple e-sign documents can be supported accordingly. An option to 'Auto Request Signature' can be enabled. When checked, the e-sign document will be sent to signers as soon as the Assignment Package is successfully built following Merge Documents configuration.

Items may be sequenced by clicking on the box of the template and dragging and dropping the item to the desired list position by clicking on the box of the template and dragging and dropping the item to the desired list position. When generating an Assignment Package, Documents will be generated in the order in which they are configured.

Remove a Document – Click the

button.

Delivery

One or more Delivery configurations may be set. Once configured, when a user generates a Package for an assignment, these Delivery options will be available for selection. Multiple Delivery options with different Delivery Methods can be saved to an Assignment Package.

When the Delivery Method is <Email>, by default all outputs of the Package (all generated Cost Estimate Reports, all generated Compensation Calculation Reports, and all generated Merge Documents) will be added to the email. In addition, any attachments configured in the selected Delivery <Email Template> will also be included.

When the Delivery Method is <Portal>, an Email Template can be selected to function as a notification for Employees when items from the Assignment Package are delivered to the Employee Portal. Outputs of the Package will not be attached to emails when the Delivery is configured as such, however Merge or Static Documents associated to the selected Email Template will be included.

New Delivery – Click the button to add a new row to the section

Name – This is the Name that will appear in the list of Delivery Options when an Assignment Package is being generated, for example, For Employee, Host-based outputs, etc.

Delivery Method – Select whether the Delivery Option being configured will generate an Email with all outputs of the Package as attachments, or if the outputs will be made available on the Employee Portal.

Password Protect Attachments - Select whether each component of the package included in the delivery will be protected using a password or not. If selected, the password used is according to the System Preference, Assignment Report Email Attachment PDF Document Password Source, available within the Reports category of preferences.

Note – Word documents will be converted to PDFs when using this setting. This is not available when the Delivery Method is Portal and there is no Email Template selected.

Email Template - Select from the list of Company and System level Email associated with the Assignment Package Details screen.

In order for the e-mail template to show as an option to choose from when setting up the configuration(s) for a delivering a package, the template must be made available to the Assignment Package Details screen and must be active. See the Email Templates and Merge Documents User Manual for more details.

Modify a Package

An Assignment Package Name and content may be modified. Even after one or more assignment level packages have been generated from the configured Assignment Package, reports, templates, and/or documents may be removed or added. When an assignment level package is next created, it will reflect the newly configured content, even if different than the prior generated package content.

Packages may also be made Inactive. If inactive, the package will no longer be available for selection at the assignment level to generate a package.

Did this answer your question?