Wrap administration

The ExcelWraps pages on the Wrapsite define each Wrap and the Wrapgroups. This is where you download the Wrapsite properties for WrapCreator and design wraps that you then upload on the same page. Two job queues show you the status of tasks that run in the background.

Screenshot of the ExcelWraps group in the ExcelWraps administrative dashboard

  • Wrap Definitions – When you click on ExcelWraps in the sidebar of the Administration dashboard, you get to the Wrap Definitions page where all your Wraps live. Every time you make changes to a Wrap template with WrapCreator you must upload the new definition here to make it active. You can edit all the data instances of a Wrap and change or remove incorrect wraps.
  • Wrap Groups – In the permissions model, Wraps belong to Wrapgroups that specify the rights that the various user roles have. You define the Wrapgroup names here and assign Wraps to them.
  • Wrapsite properties – To design and edit Wraps, you use a special add-in for Excel called WrapCreator. You need to regularly download a summary file with the Wrapsite properties to WrapCreator, so that it has the information it needs about the currently defined Users, Workgroups, Wraps and Wrapgroups on the Wrapsite.
  • Server Recalculation Queue – Sometimes, the Wrapsite needs to recalculate some or all live instances of a Wrap. This can be a time-consuming and resource-intensive operation, and so it is serialized to avoid overloading the server. Wraps pending recalculation are visible on the Server Recalculation Queue.
  • Server Queue – Most work on the wrapsite is performed immediately, to provide rapid response times to Wrap users. A few types of work need to be run only one at a time, to ensure that the server isn’t overloaded. As an example, administrators can use WrapStack to prepare a lot of Wraps for an incoming train. Such serialized units of work are called Wrap jobs. The Server Queue is a job queue for the wrap jobs that are awaiting execution.
  • Use the Wrap Exports page to download content that you have requested to be exported. A download file appears for each background export job that has finished.
  • The Wrap-related Wrapsite settings are described at the end of this document and control things such as wrap locking and what Roles to use for the Wrap.

The Audit Trail

Many system events related to Wraps can be logged in the Audit Trail, e.g. when Wraps are created, updated, or deleted.

The Audit Trail can also register every time Wraps are created, viewed, updated, deleted, signed, or unsigned.

Wrap Definitions

The Wrap Definitions page is the home for all the Wraps in your Wrapsite. Use the Wrap Definitions page to import new or updated Wraps. You can set various properties of each Wrap template and manipulate its instances.

Page header

Screenshot of the Wrap Definitions on the ExcelWraps tab of the Administration dashboard

The Apply button performs the action selected in the Actions menu for the selected Wraps. For this Action menu, you can only select Delete. The Wrap templates that you have selected and all their wraps are queued for deletion after which you are taken to the server queue where you can follow the job that was created. If you delete a Wrap, you must upload the definition again if you want to regain access to it. Deleting Wraps is a very rare operation that you would normally do only during development and testing.

The Filter setting allows you to show all Wrap definitions or only the ones that are locked (disabled). The Sort by setting allows you to order the Wraps by Name, Last Updated time or Wrap Groups. Press the Filter button to apply the filter and sorting settings and refresh the list of Wraps.

Import Wrap Definitions and Wraps

You design and edit Wraps with an add-in for Excel called WrapCreator. When the source spreadsheet is converted to a Wrap template, you get a .zip file that needs to be imported to the server.

You can also import existing wraps that have been exported as .xml or .xlsx files using the export functions under Wrap instances below. The import operation also supports a .zip file containing a .xml file. Media files that have been uploaded to wraps are not included in the exported file and cannot be imported. For security reasons, existing signatures in the exported file are ignored and will not be imported.

Click on the Import button to add new and update existing Wraps. If the import file contains instances, these will be imported, too. If a wrap in the import file already exists in the database, it is updated with the values in the import files.

Screenshot of the Import Wrap Definition window

Click Choose File and navigate to the folder where the file you want to import is located. Select the file and click OK.

During testing, you may want to Delete any existing instances when you upload a new version of the Wrap in order to start testing from scratch.

When you update a Wrap template, you may want to recalculate its instances to ensure that all the values in all the Wraps are calculated using the most recent formulas and static values in the Wrap template. In this case, tick Mark instances for recalculation. If you have only made layout changes, or if you plan to recalculate the affected wraps manually, you may skip this step.

Missing cells

When you import a new version of a wrap template and it is missing cells that were in the previous version, you may get a warning message. This is because existing frozen Wraps have content for this field saved in the database. Please contact client services if you need help rectifying this situation.

Unmatching cell references

When you import a new version of a wrap template with unnamed WrapLink cells, you risk losing data. You may get a warning message because existing frozen Wraps have content for this field saved under a different name. Please contact client services if you need help rectifying this situation.

Restoring previous versions of a Wrap from the import history

If you upload a new version of a Wrap and it doesn’t work as you intended, you may need to revert to a previous version.

To restore a previous version, first locate the History link for the Wrap.

Screenshot of the History link for a wrap definition

This opens the Wrap Import History which contains all previously imported versions of the wrap. Screenshot of the Wrap Import History window

Click on the date for any version in the list to download the ZIP for this version to your local workstation. You can then import it again, as it is, reverting back to this version.

Note: There are many reasons for an old version of a Wrap to be incompatible with the current version, as described on the Making changes to your wrap page. You should exclude any risk of incompatibility before you attempt to revert to a previous version.

List header

The down arrow selects all Wrap definitions.

The Name column contains the name of the Wrap. The search box is used to find Wraps by name – just enter a part of the name and press Enter.

The Groups column contains the names of the Wrapgroups that the Wrap belongs to. The search box is used to find Wraps by wrapgroup name – just enter a part of the wrapgroup name and press Enter.

The Action column allows you to download the source for the Wrap in xlsx format, edit the Wrap properties described below, Lock the Wrap to prevent Users from using it, or display the history of imported versions.

The Last Modified column contains a timestamp for the most recent update to the Wrap definition.

List entries

If you click on the name of a Wrap template, you get to a list of its wraps. If you click on a wrap, it opens for editing.

List footer

The number of items per page is controlled by the Show parameter at the bottom of the list. If the number of items exceeds this setting, a page navigation control appears to the right of it, allowing you to navigate directly to the page you want.

Screenshot of the pagination options at the bottom of a list of items

Wrap Instances

If you click on the name of a Wrap template, a list of its wraps appears.

Screenshot of the list of instances for a Wrap

Page header

Actions menu and Apply button

The Apply button performs the action selected in the Actions menu for the selected Wraps. To free you from having to wait for the more time-consuming Actions, they will initially just create a background job on either the Server Recalculation Queue or the Server Queue and then allow you to continue with other work. You need to visit the appropriate queue if you want to verify the status of the background job.

The possible actions are:

  • Create New Wrap – Opens an empty instance of the Wrap template in your browser. If you save it, it is added as a new wrap.
  • Export Wrap Definition – Wraps are defined in Excel, as spreadsheets, using the WrapCreator add-in for Excel. When you export a Wrap Definition, you download both the spreadsheet that was used to define the Wrap and the WrapCreator output from the conversion to a Wrap. Note that you can download both the current version and any previously imported version also from the History link for the Wrap – read more under Restoring previous versions of a Wrap above. Exported Wraps can be imported again using the Import button on the Wrap definitions page described above.
  • Request Export All Wraps – All the Wraps are queued for copying into a file for export. To see all the wraps that the export file will contain, set State to Any. Uploaded media files are not included in the exported file. Any newly exported files appear at the top of the Wrap Exports screen as soon as they are available. Click on the Download button to download each file. You can open the exported file directly in Excel; read more about exporting wrap data to Excel. Exported wraps can be imported again using the Import button on the Wrap definitions page. Signatures and uploaded media files will not be imported.
  • Request Export Selected PDFs – Enqueues the selected wraps to have their most recent PDF file exported from the database to the user’s file system. When the queued job is complete, an e-mail is sent to the Wrapsite Admin reporting if any PDF files were missing. The filename for a PDF is automatically created using the Wrap name, the Unique Keys, and the last modified date of the top-level wrap. End users can create and download PDFs directly from the PDF Log in the wrap.
  • Export Xlsx file – This only exports the source spreadsheet, without any instances or the output from the conversion to a Wrap.
  • Initialise Instances – We previously used this function to pre-fill the Unique Keys for a group of new wraps. This method of adding many new wraps has been superseded by the WrapStack widget.
  • Delete Selected Instances – The wraps that you have selected are queued for deletion after which you are taken to the server queue where you can follow the job that was created. Note: Deleting Wrap templates and wraps is a very rare operation that you would normally do only during development and testing. If you delete a wrap by mistake, you can restore it again using the option below. Note: Media files cannot be restored. When you delete wraps with media files, you may want to save the media files first, to be on the safe side if you need them later.
  • Purge All Instances – All the wraps are queued for purging after which you are taken to the server queue where you can follow the job that was created. In addition to the work performed by a Delete, Purge also removes any wrap history information. If you purge a wrap, you cannot restore it again.
  • Restore Deleted Instances – If you delete wraps by mistake, you can restore them again. This option shows the Deleted Wrap Instance History that contains a log of all the available versions of deleted wraps. Locate the wrap you want to restore and click Request Restore. When the restore job s completed, the selected wrap is again available. If media files were uploaded to the wrap and then deleted with it, they will not be restored.
  • Request Print to PDF – Enqueues the selected wraps to be printed to PDF using the print-to-PDF settings. Manual PDF generation is available for Wraps generated with WrapCreator 10.8 or later. If you have any issues with PDF generation. you may want to convert the Wrap with the latest version of WrapCreator and test printing with the new version of the Wrap. End users can create and download PDFs directly from the PDF Log in the wrap.
  • Request Live Instances for Recalculation – If you have made changes to the Wrap template, you may want to apply these changes also to existing wraps that have not yet been signed off. This operation selects all the live wraps (the ones that have not been frozen by a final signature) and enqueues them for recalculation.
  • Request Selected Instances for Recalculation – If you have manually selected one or more wraps that you need to have recalculated using the most recent Wrap template, use this option to enqueue them for recalculation.
Deprecated Actions

These actions have been replaced by new and better options that we suggest you explore first. The Actions below are likely to be removed from the menu in the future.

  • Export Wrap Definition with all instances – This includes an XML file with all the data instances for the Wrap. You can use this to import large amounts of data into an analysis tool. You can open the exported file directly in Excel; read more about exporting wrap data to Excel. Instead of this deprecated Action, we recommend that you use the Export Wrap Definition or Export Xlsx file Actions to export the Wrap source spreadsheet with or without the conversion results. Then use the Request Export All Instances Action to export the wraps. Exported Wrap templates and their wraps can be imported again using the Import button on the Wrap definitions page described above.
  • Export Wrap Definition and Selected Instances – This only exports the wraps that you have selected in the list to an XML file. You can open the exported file directly in Excel; read more about exporting wrap data to Excel. Instead of this deprecated Action, we recommend that you use the Export Wrap Definition or Export Xlsx file Actions to export the Wrap source spreadsheet with or without the conversion results. Then use the Request Export All Instances Action to export all the wraps. Exported Wrap templates and wraps can be imported again using the Import button on the Wrap definitions page described above.
  • Export Selected Instances – Exports the selected wraps to an XML file, without the Wrap definition spreadsheet. You can open the exported file directly in Excel; read more about exporting wrap data to Excel. Instead of this deprecated Action, we recommend that you use the Request Export All Instances Action to export all the wraps. Exported wraps can be imported again using the Import button on the Wrap definitions page described above.
  • Recalculate All Marked Instances – Places all the marked wraps on the Server Recalculation Queue.

State menu and Filter button

Press the Filter button to select only the wraps that are in the Live or Frozen state, are awaiting your signature or have previously been signed by you.

  • Live – Show all wraps that are not yet frozen, i.e. work in progress. Wraps freeze when the last signature has been made to indicate the completion of a process.
  • Frozen – Show wraps that are frozen by a final signature and cannot be modified further.
  • AwaitingSignature – Show wraps that are waiting for your signature.
  • SignedByMe – Show wraps that you have signed.
  • Any – Shows you all wraps.

List header

The down arrow selects all the Wrap’s instances.

The id column contains an internal identification of the wrap. It is assigned automatically, it is unique and it cannot be changed.

The subid and yourname columns are the Unique Keys for the Wrap template in this example. All the Unique Keys are included in its list of wraps to help you select the instances you are looking for. The Unique Keys for a Wrap are defined on the Wrap tab in WrapCreator and cannot be changed.

The createdby column contains the userid of the user that created the wrap, and thus owns it as part of the ExcelWraps permissions model.

The lastmodified column contains a timestamp from when the wrap was last saved to the database.

You can type filter values into the text box at the top of each column to filter the list of wraps. Read more about column filtering on the help page for MyWraps.

Action column

PDF Log

There is one PDF log per wrap, containing all the PDF files that have been printed for the wrap. The link to the PDF log is in the Action column.

Screenshot of the PDF log link for an instance

The PDF log has one row for each PDF created for the wrap. Click on the link to open the PDF in the web browser, or download the file using the browser.

To remove PDF files, tick their checkbox, select Delete in the Action column, and press Apply.

Screenshot of the list of PDFs in the PDF Log for a wrap.

End users can create and download PDFs directly from the PDF Log in the wrap.

Screenshot of the PDF Log in the wrap

Using the wrap history to undo changes to a wrap

Each modified wrap in the list has a History link in the Action column that opens the Wrap Instance History page containing the version history for the selected wrap.

Use Request Restore to request that the wrap is reverted back to any previous version. When the restore job has been run, the contents of the wrap will correspond to the version you selected to revert to.

By default, only Administrators can request a restore. You can grant this ExcelWraps feature permission also to other Roles.

Example: The wrap in the version history below was modified in error at 10:22:18. To revert to the previous version, the administrator clicks on the Request Restore link for the version of the wrap that was saved 10:21:24. After the restore job is completed, the modifications from 10:22:18 have been reverted.

Screenshot of the Wrap Instance History page for an instance

The User column contains the ID of the user that last saved updates to the wrap. This is also true if a wrap is deleted – the user ID shown here has no relation to the delete operation.

List entries

If you click on a wrap, it opens for editing.

List footer

The number of items per page is controlled by the Show parameter at the bottom of the list. If the number of items exceeds this setting, a page navigation control appears to the right of it, allowing you to navigate directly to the page you want.

Screenshot of the pagination options at the bottom of a list of items

Edit Wrap Definition

Clicking on the Edit link for a Wrap Definition allows you to modify some of its properties.

Lock type

ExcelWraps is a multi-user system. There is always a risk that two or more users access the same Wrap simultaneously. For read-only access, this happens naturally and without conflicts, but if two users need to modify the Wrap and their requests overlap, a synchronization issue may occur.

Consider the following scenario:

  1. User Primo opens the wrap.
  2. User Secondo opens the wrap.
  3. Primo starts to edit the original version of the wrap.
  4. Secondo starts to edit the original version of the wrap.
  5. Primo submits an edited version of the original wrap.
  6. Secondo submits an edited version of the original wrap.

In step 6, the version saved by Secondo does not include the modifications made by Primo. The changes made by Primo will be overwritten and lost.

Optimistic locking

To prevent this, ExcelWraps uses a locking system that alerts Secondo that the wrap has been modified since he/she opened it. When this happens, Secondo has two options:

  1. Abandon the previous edit, re-open the latest version of the wrap, perform the same changes, and save.
  2. Contact Primo and resolve the situation.

This is referred to as optimistic locking and works well in most cases.

ExcelWraps is used to support workflow processes where it is unlikely that two users or workgroups would inspect the same carriage or repair the same fault. If you run into repeated conflicts like the one above, you may want to redesign the wrap, e.g. to use one wrap for the electrical checklist and one for the mechanical checklist, instead of having both checklists in the same wrap which may greatly increase the risk of conflicts.

Screenshot of the Lock type setting for a Wrap

Pessimistic locking

Optimistic locking is perfectly safe and there is no risk of overwriting a previous change to the wrap. However, if these conflicts happen very often, and the wrap cannot be redesigned to avoid them, ExcelWraps also offers an explicit locking model that we call pessimistic.

With pessimistic locking, users press a Request Edit Lock button to explicitly lock a wrap before they begin to edit it. When done, they use a Release Edit Lock button to allow other users to take the edit lock. Instead of having trouble when a rare conflict occurs, users now have extra steps to perform for every edit.

Unfortunately, users regularly forget to release the edit lock. Administrators can be called in to use a Seize Edit Lock button and then release the lock for others to take. Before doing this, they must verify that the lock isn’t held legitimately by a user that is performing a lengthy edit.

Pessimistic locking creates extra work for all involved. It is primarily useful when edits take a very long time because users need to perform many complicated manual operations while editing the wrap, e.g. when storing a large number of measured values. In this case, it may be more time-consuming to do all the measurements again in case of a locking conflict than to first acquire the lock explicitly. Again, consider redesigning the wrap to avoid simultaneous edits.

Default locking

The Wrapsite Settings contain an Edit Locking setting that sets the default lock type for an entire wrapsite.

Screenshot of the Settings link group on the ExcelWraps Administration dashboard  Screenshot of the Lock Type setting in the Wrapsite settings

Most users would have this set for Optimistic locking by default.

The None setting means that users will not be informed when data is lost due to locking conflicts. We recommend that you discuss your requirements with your client services team before you select this setting.

Wrapgroups

Each Wrap belongs to one or more Wrapgroups. These are part of the ExcelWraps permissions model and define what rights each user role has to the Wrap and its data.

You assign the Wrap to its Wrapgroups simply by ticking each group you want the wrap to be a member of.

Screenshot of the Wrapgroups list for a Wrap

The Wrapgroups are defined on the Groups tab, see below. Read more about Wrapgroups and permissions on the Wrapgroups and workgroups help page.

Print to PDF settings

Introduction

Wraps can be printed as PDF files. The PDF files are formatted the same way the Wrap is formatted on the screen.

Printing can be initiated manually as an Action on the Wrap Instances page, or automatically when the wrap is signed or unsigned using a setting below.

A “parent” PDF file can append all the PDF files for its “children” wraps, e.g. to produce an exam book that documents everything for a specific exam.

Read more on the help page about printing wraps to a PDF file.

PDF file options

For printed wraps, you can set various options for the PDF files.

Note that existing PDF files are unaffected by changes to these settings,. If you select to generate PDFs in Landscape mode, and a wrap already has a PDF that is current, it will be considered current even if it was generated in portrait mode. You must manually regenerate the PDF file to use the latest settings, in this example to get a landscape mode PDF.

Screenshot of the Print to PDF settings for a Wrap

Printing a wrap when it is signed makes it easy to confirm a completed process by e-mailing a “receipt” for it. Tick the Print to PDF on every signature checkbox to enable the feature. A PDF will be generated if a signature field is signed, and if a signature field is unsigned.

If you only want to print the PDF for the final freeze signature, and not the intermediate signatures, tick Print to pdf on freeze signatures only.

The default is to generate the PDF in portrait mode (shortest side up). If the Wrap is wide, you can also have it generated in landscape mode.

You can optionally add page numbers and the print file generation date to the footer of each page in the file. If child PDFs are being appended to a PDF book, you should only use these settings for the master Wrap, or two different page numbers or dates may appear on some appended pages.

Adjusting the scaling to zoom the output to 1-100% of its normal size.

Accessing the PDF files

There is one PDF log per wrap, containing all the PDF files that have been generated for the wrap. The link to the PDF log is in the Action column on the Wrap Instances page.

Screenshot of the PDF log link for an instance

End users can create and download PDFs directly from the PDF Log in the wrap.

The scheduling settings

This is where you enable a Wrap for automatic recalculation, including periodically creating new wraps, e.g. when saving KPIs automatically.

Screenshot of the scheduling settings for a Wrap

Period

The KPIs in a WrapMap document the performance indicators for a given period. You select the length of the period that best fits your business needs.

  • Daily – KPIs are calculated separately for each day.
  • Weekly – KPIs are calculated for periods of seven days. If the Anchor Date falls on a Wednesday, every wrap in the WrapMap will cover a seven-day period starting with a Wednesday and ending with the following Tuesday.
  • Every two weeks – KPIs are calculated for periods of fourteen days. If the Anchor Date falls on a Wednesday, each wrap in the WrapMap will cover a period starting with a Wednesday and ending with the Tuesday almost two weeks later.
  • Every four weeks – KPIs are calculated for periods of twenty-eight days. If the Anchor Date falls on a Wednesday, each wrap in the WrapMap will cover a period starting with a Wednesday and ending with the Tuesday almost four weeks later.
  • Monthly – KPIs are calculated across calendar months. If the Anchor Date is June 7, the first period that starts after the New Year covers January 7-February 6.
  • Quarterly – KPIs are calculated across calendar quarters. If the Anchor Date is June 7, the first period that starts after the New Year covers March 7-June 6.
  • Half Yearly – KPIs are calculated across half calendar years. If the Anchor Date is June 7, the first period that starts after the New Year covers June 7-December 6.
  • Yearly – The KPIs are calculated across calendar years. If the Anchor Date is June 7, the first period that starts after the New Year covers June 7-June 6.
  • Network Rail – This option offers support for the Network Rail Control Period used in Great Britain. Network Rail breaks a year into 13 periods all 28 days long apart from the first and the last which may be of a different length. The first period for the year always starts on April 1 and this will also be the starting date for the first saved KPI wrap for the control period. The last wrap for a year always provides KPI data for a period that ends on March 31. Since this schedule is slightly irregular, please set the Anchor Date to April 1.
  • Infinite – A single wrap in the WrapMap is reused indefinitely. This is not practically useful for standard KPIs that are based on averages since the period becomes too long after a while. It is mainly useful for measurements that are only incremented, like usage time for appliances or accumulated distance for vehicles.

Anchor Date

We count the days of each period based on an Anchor Date, which can be any date in the past that would have been day 1 of the intended cycle.

The anchor date is only an abstract point of reference and does not imply that KPIs have been saved from that specific date. Performance data is not saved until you create the first wrap in the WrapMap, the random “start” date if you will. The first wrap contains the KPIs for the (possibly incomplete) first period, from the arbitrary start date to the end of the period as defined by the anchor date. Latter wraps will cover full periods, starting and ending as defined by the period length, counting from the anchor date.

  • If you start collecting daily KPIs, you can set the anchor date to any past date.
  • If it’s Wednesday, July 15, and you start collecting KPIs for weekly periods running from Mondays to Sundays, you must set the anchor date to July 13 or any other past Monday.
  • If it’s Wednesday, July 15, and you start collecting KPIs for two-week or four-week periods running from Mondays to Sundays, you must set the anchor date to July 13 or any other past Monday that would have been day 1 of the intended cycle.
  • If it’s July 15 and you start collecting KPIs for full calendar months, quarters, half years, or years, you can set the anchor date to the first of any past month, quarter, half year or year, respectively.
  • There is no quarter Aug 31-Nov 31 and no half year May 31-Nov 31. You cannot start periods on day 29, 30, or 31 if the period is months, quarters, or half years, since these days don’t appear in all months.

Time

When triggered by the frequency setting, the ExcelWraps server automatically starts the recalculation of the current WrapMap at or slightly after the designated time, which is expressed relative to the UTC (Greenwich meridian) timezone.

Many businesses operate around the clock, like in transportation. In these cases, one often sees operating hours starting with the morning traffic, e.g. a business day can run from 04:30:00 to 04:29:59 the next calendar day and it is for this period the KPIs are collected. In this case, you probably don’t want the KPIs for the previous full day to be calculated until after 04:30, converted from your timezone to UTC.

Other businesses work across timezones. A company in Germany with most of its business on the US west coast may not want to recalculate “this week so far” KPIs until after 8:00 UTC the next day to occur after midnight in San Francisco.

Frequency

In most cases, you’ll want the current WrapMap to be recalculated daily, so that your analysts have up-to-date KPIs every day also for the current period. WrapMap recalculation is usually light work for the server. All the wraps in the WrapMap that contain historical data were frozen at the end of their respective period, so recalculation only affects the single current WrapMap instance which in turn only aggregates data from the Wraps that provide performance indicators for the same specific timespan.

There is no technical reason to set this to any other value than 1 for daily recalculation. If your business needs dictate that some monthly KPIs are recalculated only every 7 days, you should set this value to 7.

You can only enter positive integers that are less than the period length. The frequency is reset when a new period starts. If the period is monthly and the frequency is 28 there will be only one interim recalculation, on day 28 of each period. If the period is monthly and you set the frequency to 32, interim recalculations will never occur and each WrapMap instance will only be recalculated at the beginning and end of its period.

Wrap Groups

The Wrap Groups tab is where you define and manage your Wrapgroups. Each Wrap belongs to one or more Wrapgroups.

A Wrapgroup may be owned by a Workgroup, or be available for all Users. For each Wrapgroup you define the level of access per User Role.

Read more about Wrapgroups and permissions on the Wrapgroups and workgroups help page.

 

Wrapsite properties

Designing Wraps in WrapCreator requires that the Excel add-in knows some basics about the Wrapsite, e.g. the Users, Roles, and Workgroups when adding widgets such as UserSelector. When you add a WrapLink, the add-in needs to know about your Wraps and Wrapgroups.

Screenshot of the Wrapsite Properties page of the Administration dashboard

When you press the Download button on the Wrapsite properties tab, a ZIP file is downloaded with all the details about the Wrapsite that WrapCreator needs to know. You load this file into WrapCreator on the Account tab of the task pane.

For WrapCreator to keep up with changes to the Wrapsite, you may need to update the Wrapsite properties in the add-in now and then. WrapCreator will function correctly without the most recent Wrapsite properties, but will be unable to create WrapLinks to Wraps it doesn’t know about or use Roles that were not included in the most recent set of Wrapsite properties.

Learn more on the help page for the Account tab on the WrapCreator task pane.

Server Recalculation Queue

When a Wrap definition is changed, existing live Wraps may require recalculation to be brought up-to-date on the most recent formulas and defaults as defined in the Wrap. A recalculation operation can involve a lot of Wraps. If too many wraps are recalculated at the same time, it may overload the server. This is why there is a Server Recalculation Queue on which all wraps with a pending recalculation are placed, waiting for their turn to be recalculated.

You can follow the serialized processes by monitoring the Server Recalculation Queue on the Wrapsite. A new wrap will enter the queue as Recalculation pending, get selected for recalculation when it is at the top of the queue, and then ticked off as Recalculated. If an error occurs, the wrap is instead flagged as Recalculation failed.

To monitor the server recalculation queue, click on the ExcelWraps link in the left-hand sidebar of your Wrapsite Administration dashboard, then select the Server Recalculation Queue tab.

Screenshot of the Server Recalculation Queue for a Wrapsite

Page header

To manage wrap jobs on the queue, you tick one or more of their checkboxes in the list and then press Apply to perform one of the following Actions:

  • Retry – Try to recalculate a wrap again.
  • Mark as recalculated – Removes the wrap from the list of wraps marked for recalculation.

Use the Filter dropdown and the Filter button to select what type of wraps you want to work with on the dashboard.

  • Initialisation Failed – Initialisation was a predecessor to the WrapStack widget.
  • Initialisation Pending – The Initilisation functions are rarely used anymore.
  • Recalculation Failed – An error occurred during recalculation.
  • Recalculation Pending – The wrap has been marked for recalculation.

Server Queue

Most work on the wrapsite is performed immediately, to provide rapid response times to Wrap users. A few types of work need to be run in the background, to avoid that the user has to wait for the system, and run only a few at a time to ensure that the server isn’t overloaded. Such serialized units of work are called Wrap jobs. The ExcelWraps job queue contains the Wrap jobs that are waiting to be run.

You can follow the serialized processes by monitoring the Server Queue on the Wrapsite. A new job will enter the queue as Pending, get selected and run when it is at the top of the queue, and then ticked off as Complete. If an error occurs, the job is instead flagged as Failed.

To monitor the job queue, click on the ExcelWraps link in the left-hand sidebar of your wrapsite dashboard, then select the Server Queue tab.

Screenshot of a job queue in ExcelWraps

Page header

To manage wrap jobs on the queue, you tick one or more of their checkboxes in the list and then press Apply to perform one of the following Actions:

  • Retry – Try to run a pending job again.
  • Remove – Remove a job from the queue to prevent it from being executed.
  • Undo – Rollback all the changes for an incorrectly designed job, i.e. remove the wraps that were created and restore the field contents that were updated in existing wraps.

Use the Filter dropdown and the Filter button to select what type of jobs you want to work with on the dashboard.

  • Pending – The job is awaiting execution.
  • Failed – The job failed during execution.
  • Complete – The job was run without errors.
  • Removed – The job was removed from the queue before execution.
  • Undo Pending – The job has been marked for undo, i.e. reverting all changes it made to the database.
  • Undo Failed – The undo operation failed.
  • Undone – All the database changes for the job have been successfully undone.

List header

The down arrow selects all the Wrap jobs in the list.

The Handler column tells you what kind of job it is.

The Action column describes what the job is doing.

The Tracking Id is a unique identifier for the job.

List entries

If you click on the tracking ID for a Wrap job, you get to a page showing the detailed information for it.

List footer

The number of items per page is controlled by the Show parameter at the bottom of the list. If the number of items exceeds this setting, a page navigation control appears to the right of it, allowing you to navigate directly to the page you want.

Screenshot of the pagination options at the bottom of a list of items

Wrap job processing time

The backend processes are shared between all Wrapsites. If none of your Wrap Jobs are running, it may be because the server is busy with other Wrapsites. In some situations, the queue may also be quiesced, e.g. in preparation for a system restart. Please contact client services if your Server Queue appears to be clogged.

Wrap Exports

The Wrap Exports page opens when you request certain background exports of data from ExcelWraps. If you stay on the page, it is continuously refreshed every 15 seconds, to make new export files visible as they become available.

Screenshot of the Wrap Exports page containing a completed export file

In the screenshot above, the admin requested the export of all instances of a Wrap. After approximately three minutes, the resulting file appeared in the list. The Download link downloads the generated file to your device.

Exported files are automatically deleted after a fixed number of days. If you need a file that has been deleted, just request the corresponding export again.

You can wait for the corresponding Wrap job to finish, or you can do other things and return to the Wrap Exports page later. There is a link to the Wrap Exports page in the ExcelWraps group in the left-hand sidebar of the Administration dashboard. To locate the link, you may have to expand the group by clicking on the little arrow that points to the right if the group is collapsed, but down if it is expanded.

Screenshot of the Wrap Exports selection in the left-hand sidebar of the ExcelWraps Administration dashboard

Settings related to Wrap administration

There is a group of settings on the Administration dashboard > Settings > ExcelWraps that control Wrap administration.

  • Edit locking – Two Users cannot edit the same wrap at the same time. The default locking method is Optimistic which means that the Wrapsite detects collisions during Save and protects the first User’s changes from being overwritten by the changes made by the second User.  Read more under Edit Wrap Definition above.
  • Wrap Header – A block of separately defined common content appears above the Wraps when they are shown in web browsers. You can select what content block to use here.
  • Printing – You can disable all printing from the Wrapsite, e.g. for security reasons.
  • Settings Dictionary – These settings customize the logo, header background color, and QR code color for the Wrapsite. Contact Client Services if you need help with these technical settings.
  • Displayed Roles – Wraps inherit Role permissions from their Wrapgroups. Tick the box for each Role you want to be selectable for Wrapgroups.
  • Assignable Roles Pool – If you delegate administration of a Workgroup to a local administrator, you have the option of delegating administration also of the User Roles that you select here. To delegate administration of a Role to the local admin of a particular Workgroup, you must make the Role assignable in this global setting and also select it in the Assignable Roles list for the particular Workgroup.