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.
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 Wrap instances are created, viewed, updated, deleted, signed, or unsigned.
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 and manipulate its instances.
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 Wraps that you have selected and all their instances 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 search box is used to find Wraps by name – just enter a part of the name and press Enter. 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.
You design and edit Wraps with an add-in for Excel called WrapCreator. When the source spreadsheet is converted to a Wrap, you get a ZIP file that needs to be imported at the server. Click on the Import button to add new and update existing Wraps.
Click Browse… and navigate to the folder where the ZIP file from WrapCreator is located. Select the ZIP 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, its instances are automatically recalculated to ensure that all the values in all the instances are calculated using the most recent formulas and static values in the Wrap. If you have only made layout changes, or if you plan to recalculate the affected instances manually, you may skip this step by ticking Unmark instances for recalculation.
When you import a new version of a Wrap and it no longer contains all the fields that were in the previous version, you get a warning message. This is because existing Wrap instances still have content for this field in the database but when you open them there is no place to show the missing field on the screen. When you save the instance in the new format, the old contents for the omitted field will be lost. By ticking Ignore warning for missing cells, the file will be imported without any checking for this.
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 simplify this, ExcelWraps maintains an import history containing all previous versions of the Wrap that have been imported to the Wrapstie. Use the History link for the Wrap to download the ZIP for a former version and upload it again.
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.
The down arrow selects all Wrap definitions.
The Name column contains the name of the Wrap.
The Groups column contains the names of the Wrapgroups that the Wrap belongs to.
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.
If you click on the name of a Wrap, you get to a list of its instances. If you click on an instance, it opens for editing.
If you click on the name of a Wrap, a list of its instances appears.
The Apply button performs the action selected in the Actions menu for the selected Wrap instances. The possible actions are:
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.
Press the Filter button to select only the instances that are in the Live or Frozen state, are awaiting your signature or have previously been signed by you.
The down arrow selects all the Wrap’s instances.
The id column contains an internal identification of the instance. It is assigned automatically, it is unique and it cannot be changed.
The subid and yourname columns are the Unique Keys for the Wrap in this example. All the Unique Keys for a Wrap are included in its list of instances 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 instance, and thus owns it as part of the ExcelWraps permissions model.
The lastmodified column contains a timestamp from when the instance 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 instances. Read more about column filtering in the help page for MyWraps.
Each instance 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 instance.
Use Request Restore to request that the instance is reverted back to any previous version. When the restore job has been run, the contents of the instance will correspond to the version you selected to revert to.
Example: The instance 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 instance that was saved 10:21:24. After the restore job is completed, the modifications from 10:22:18 have been reverted.
If you click on an instance, it opens for editing.
Clicking on the Edit link for a Wrap Definition allows you to modify some of its properties.
ExcelWraps is a multi-user system. There is always a risk that two or more users access the same Wrap instance simultaneously. For read-only access, this happens naturally and without conflicts, but if two users need to modify the Wrap instance and their requests overlap, a synchronization issue may occur.
Consider the following scenario:
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.
To prevent this, ExcelWraps uses a locking system that alerts Secondo that the wrap instance has been modified since he/she opened it. When this happens, Secondo has two options:
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.
Optimistic locking is perfectly safe and there is no risk of overwriting a previous change to the wrap instance. 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 instance 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 instance, 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.
The Wrapsite Settings contain an Edit Locking setting that sets the default lock type for an entire wrapsite.
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.
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.
The Wrapgroups are defined on the Groups tab, see below. Read more about Wrapgroups and permissions on the Wrapgroups and workgroups help page.
You can have each Wrap instance printed as a PDF file when it is signed off. This makes it easy to confirm a completed process by e-mailing a “receipt”. Tick the Print to PDF on Signed/Unsigned checkbox to enable the feature. You can have the PDF file generated in landscape mode (longest side up) and zoomed to 0-100% of its normal size. The PDF file is stored with the instance.
This is where you enable a Wrap for automatic recalculation, including periodically creating new instances, e.g. when saving KPIs automatically.
The KPIs in a WrapMap instance document the performance indicators for a given period. You select the length of the period that best fits your business needs.
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 instance of the WrapMap, the random “start” date if you will. The first instance 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 instances will cover full periods, starting and ending as defined by the period length, counting from the anchor date.
When triggered by the frequency setting, the ExcelWraps server automatically starts the recalculation of the current WrapMap instance 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.
In most cases, you’ll want the current WrapMap instance 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 instances of 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 Wrap instances 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.
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.
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.
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.
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 Wrap instances. If too many instances are recalculated at the same time, it may overload the server. This is why there is a Server Recalculation Queue on which all instances 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 instance 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 instance 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.
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:
Use the Filter dropdown and the Filter button to select what type of instances you want to work with on the dashboard.
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. 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.
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:
Use the Filter dropdown and the Filter button to select what type of jobs you want to work with on the dashboard.
There is a group of settings on the Administration dashboard > Settings > ExcelWraps that control Wrap administration.