MyWraps reports

MyWraps creates a filtered and sorted list of Wrap instances. You can generate charts or export data to Excel. MyWraps reports can also be used to define the scope for the WrapStack widget.

MyWraps displays field values in selected Wrap instances as charts or tables. Reports can be filtered, sorted and ordered to give you exactly the information you require. Live links between MyWraps reports and Excel data are easy to create if you are more comfortable working in Excel. Administrators can transfer data between the Wrapsite and a local device for complete control over all data collected by ExcelWraps.

MyWraps reports are limited to 500 instances by default, to ensure a reasonable response from the server. This limit may be increased or removed with the MaxRows parameter in the link to the report. Read more at the bottom of this page.

Extracting data for use in Wraps

Requesting a lot of data using many WrapLinks or WrapLinkAggregates, e.g. for a complex dashboard showing hundreds of entries, can be very time-consuming because of all the database operations required to provide the data one cell at a time. Using the MyWraps2 function, you can request a single data extract containing all the data you need by defining a single MyWraps link and having all the data returned with item separators in a single cell of the dashboard Wrap.

The Audit Trail

You can log each MyWraps request in the Audit Trail.

Using MyWraps

MyWraps is located on a separate tab on the start page of your Wrapsite.

Screenshot of the MyWraps tab on the start page of a Wrapsite

Filter the list of wraps

This tab contains a list of your Wraps.

The Creator filter allows you to view only the Wraps that have instances created by you.

The State filter lets you select only the instances that are Live or Frozen, awaiting a signature or signed by you.

  • Live – Show all wrap instances 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 instances that are frozen and cannot be modified further.
  • AwaitingSignature – Show wrap instances that are waiting for your signature.
  • SignedByMe – Show wrap instances that you have signed.
  • Any – Shows you all instances.

You can also filter the list by entering any part of the Wrap’s name in the text box and press Filter.

Select the Wrap

Click on the Wrap you want a report from.

Screenshot of all instances of a Wrap in MyWraps

Access denied vs empty table

MyWraps operates under the ExcelWraps permissions model.

  • If your Roles don’t grant you at least read access to a Wrap, you won’t be able to view reports based on the Wrap either. In this case, you will get an Access Denied error when you try to open the Wrap in MyWraps.
  • If your Roles do grant you at least read access to a Wrap, but the Wrap does not belong to your Workgroup or a Workgroup trusted by your workgroup, the list of instances may be empty.  This is because it is possible for individual instances to be trusted to your workgroup, but at the moment there aren’t any.

Filter the instances

Screenshot of the dialog used to filter instances in MyWraps

Click on the Filter button in the toolbar to filter the instances on Creator and State like in the list of Wraps. There is also an AutoNumber filter where you can explicitly select the First, Last, or LastFrozen auto number.

On top of each column is a text field where you can enter a filter for the column.

For text fields, you can enter any part of the value you wish to filter on and press Enter to hide the instances that do not contain this value in the column. Example: if you enter “y” in the text field above the month column and press Enter, only the May instance will appear. This is an example of the co (contains) operator, which is implied for string values if no explicit operator is used.

For numeric fields, you can enter any value that you wish to filter on and press Enter to hide the instances that do not have this value in the column. Example: if you enter 2020 in the text field above the year column and press Enter, no instances appear. This is an example of the eq (equal to) operator, which is implied for numeric and date values if no explicit operator is used.

The possible operators that you can use as column filters are:

  • hello – show only instances where the field contains ‘hello’, co is the default operator for string values
  • co(hello) – show only instances where the field contains ‘hello’
  • nc(hello) – show only instances where the field does not contain ‘hello’
  • eq(hello) – show only instances where the field contains only the exact string ‘hello’
  • ne(hello) – show only instances where the field does not contain only the exact string ‘hello’
  • 10 – show only instances where the field is equal to 10, eq is the default operator for numeric values
  • eq(10) – show only instances where the field is equal to 10
  • ne(10) – show only instances where the field is not equal to 10
  • gt(1) – show only instances where the field is greater than 1
  • ge(1) – show only instances where the field is greater than or equal to 1
  • lt(1) – show only instances where the field is less than 1
  • le(1) – show only instances where the field is less than or equal to 1
  • eq() – show only instances where the field is empty
  • ne() – show only instances where the field is not empty

For dates, the filter must be in ISO-standard yyyymmdd format , e.g. lt(20201225) means any date before Christmas Day 2020. DateTime filters must use a yyyymmddhhmmss format.

Toolbar

The buttons in the toolbar allow you to perform additional manipulations on the table:

  • Action = Brings up the list of possible actions, including Insert Wrap Instance. If instances are selected and a bulk action wrap is available, there will be a button for that too. For Wrapsite administrators, a Delete All Instances button appears that will queue all the instances in the current view for deletion after which you are taken to the server queue where you can follow the job that was created.
  • Filter = Brings up a list of filters that allow you to filter the instances according to the filters for Creator and State described above. You can also isolate the instance with the lowest and highest value for the AutoNumber, if any.
  • Download = Export the table to CSV or HTML
  • View = Toggles between the table view and chart view.

For Wrapsite administrators, additional buttons appear that are described under Customized reports below.

Interactive reports

Tabular reports

Navigating to MyWraps will present a list of the Wraps and instances available to you.

Filter controls show you Wrap instances that are Mine (created by the logged-in user) or Any (created by anyone).

The state of a Wrap instance at any time is Live or Frozen. Some live Wrap instances will be AwaitingSignature (waiting for the logged-in user to sign the instance) or SignedByMe (when the signature has already been made). The state Any lists all Wraps.

Once you’ve selected the instances to include in the source data, you can use column filtering and sorting to manipulate the report.

All this is available to any user by clicking the Wrapsite menu option.

Chart reports

From a tabular data view simply click the Chart button to visualize the data. Charts have interactive pinch-zoom controls and each data point is clickable to open the Wrap data source. It’s an amazing feeling to have your data literally at your fingertips.

The appearance of the chart can be tailored using special options available to Wrapsite administrators.

Customized reports

A Wrapsite administrator with the AdminTenant role can create custom reports for users using a few additional buttons that appear in the toolbar:

  • Setup = Define the fields in the wrap to be placed in the table columns.
  • Aggregate = Prepares a column header with column aggregates like AVERAGE, COUNT, COUNTA, MAX, MIN, PRODUCT, STDEV, STDEVP, SUM, VAR, and VARP.
  • Chart = Sets the options for the Chart view.
  • Chart Range = Sets the range for the Chart view.

Define the report

Click on the Setup button to initiate the creation of a new report.

Screenshot of the Properties tab for MyWraps report setup

On the Properties tab, you assign a Title to your report.

  • You should set Max Rows to the highest number of instances you ever expect to have included in the report (read more about The MaxRows parameter below).
  • Set Open Mode to Fast when you know that the report only includes frozen wraps, or if you want to use the most recently calculated data for each live instance in the report to speed up access considerably. If you need to recalculate live instances to include the most recent data then use Automatic (read more under Saved MyWraps links below).
  • If Aggregates Only is set to Yes, the individual data for each instance is not included in the report, typically making it much shorter. The report will only contain the combined, aggregated values for all instances, like totals, averages, max/min values, counts, product, variance, and standard deviation.

Screenshot of the Columns tab for MyWraps report setup

On the Columns tab, add all the columns you want to include in the report.

Screenshot of the Append tab for MyWraps report setup

On the Appends tab, specify the Wraps you want to append.

Publish the report

A MyWraps report is always completely defined by its link. This makes it very easy to send a complete report to another ExcelWraps user with the required access – you just send the link. The report’s Setup described above is basically a wizard that helps you prepare the link for each report.

Once you’re happy with the report you have created, just copy the link. To send the report to another user, just paste the full link into a chat or an e-mail.

If the report is useful to other users of your Wrapsite, you may want to make it available to them when they log in. Doing this is very easy.

Copy the essential part of the link

When you link to reports inside the Wrapsite, you only need the part of the link after “excelwraps.com”, i.e. starting with “MyWraps”. Copy only this part of the link, and we will then update the old link with the new parameters.

Locate the web page that contains the report link

Navigate to the page on the Wrapsite where you want the link to appear.

Open the web page in the editor

Click the Edit button that corresponds to the section of the page that contains the report link.

Screenshot of a Wrapsite web page where we want to insert a MyWraps report link

Open the link you want to modify

Click on the button or text link that you want to modify, then on the “edit link” symbol that looks like a chain.

Screenshot of the button for which the link is to be edited

Replace the link

The field that contains the link is called URL. Select the entire URL field and press the Del and/or Backspace keys until you are sure it is completely empty, then paste the link beginning with “MyWraps” that you copied earlier into the URL field.

The Text to display will appear on the button if there is one, or as the anchor text for a standard text link. The button or anchor text should clearly indicate what the user can expect to see when they click on the link.

The Open link in field allows you to open the report in a new window, in case you want the old window to remain on the screen. Many users find it confusing to have more than one window open, in particular on phones, and prefer to use the Back button in their browser to return to previous locations. Please consult your local user interface guidelines if you are uncertain.

Press Save to update the link.

Screenshot of the Insert/Edit Link dialog

Publish the updated web page

Locate the Publish Now button at the bottom of the web page editor and click on it to save the updated web page. The changes you made are usually immediately available to your users.

Screenshot of the Publish Now button in the webpage editor

Saved MyWraps links

Any MyWraps report can be saved as a single link that can be stored as a browser bookmark, added as a hyperlink on a webpage, or added to the Wrapsite menu. Your Wrapsite includes a MyWrapsGenerator Wrap that can create the reports you need in the form of MyWraps links.

Basic MyWraps link

https://guide.live.excelwraps.com/MyWraps/WrapOne?Options.Creator=Any&Options.State=Live&Filter.yourname=Rachel

If we decompose a MyWraps link into its components, we find:

  • The link to the live or staged Wrapsite.
  • The path to /MyWraps/.
  • The filters Options.Creator and Options.State described above.
  • The column filters in the form “Filter.column”, e.g. Filter.yourname sets a condition for the yourname field in the Wrap. The condition is expressed as described under Filter the instances above, eg ne%280%29 means “not equal to zero” with %28 and %29 being percent-encoded parentheses.

Advanced MyWraps link

If you sort your report, in this example on the lastmodified column, a number of additional options appear:

https://guide.live.excelwraps.com/MyWraps/WrapOne?Options.Columns=yourname%2Csubid%2Ccreatedby%2Clastmodified.datetime&Options.Series=lastmodified.spline.dt.datetime&Options.SortBy=lastmodified&Options.Inverted=False&Options.Stacked=False&Options.Cumulative=False&Options.MaxRows=500&Options.OpenMode=Automatic&Filter.yourname=Rachel&Options.Creator=Any&Options.State=Live&Options.AutoNumberFilter=None
  • Options.Columns lists the visible columns in the order that you want them to appear in the report. You can use filters also on hidden columns, e.g. Filter.yourname also if yourname is not in Options.Columns. Each column is defined as field.datatype, e.g. lastmodified.datetime. The default datatype is string, see below for a complete list of data types. Separate columns with %2C which is a percentage-encoded comma. If you forget to name a field, you can use the cell coordinates from the source spreadsheet instead. The format for such a cell reference is [Column name](sheet[sheetno][cell coordinates]).datatype, e.g. Birthday(sheet2c3).date would refer to cell C3 in the second worksheet (regardless of its actual sheet name) with an alias column name of Birthday and a data type of Date. Note that the cell reference must be entirely in lowercase, e.g. “sheet2c3”.
  • Options.Series is a chart option that selects the data series to appear in the chart view of the report.
  • Options.SortBy specifies the sort order for a tabular report. The format is field.sortorder, e.g. Days.Asc
  • Options.Inverted is a chart option. If the Inverted setting is true it shows a chart rotated 90 degrees, e.g. a column chart becomes a bar chart.
  • Options.Stacked is a chart option. In a stacked column chart, data series are stacked one on top of the other in vertical columns. A stacked chart can show change over time because it’s easy to compare total column or bar lengths. They also allow for part-to-whole comparisons over time, or across categories.
  • Options.Cumulative is a chart option. By adding all of the data in each of your columns and then creating a chart from the totals of each column, you can generate a cumulative chart. Cumulative charts are useful for displaying the current totals of several different series of data in one comparative visual model.
  • Options.MaxRows limits the number of Wrap instances in the report. Read more at the bottom of this page.
  • Options.OpenMode allows MyWraps to create Wraplinks to the source instances for the report in enhanced ways. Select one of the following:
    • Options.OpenMode=Automatic is the default choice for normal read/write mode. For most reports, we recommend that you use OpenMode=Fast instead.
    • Options.OpenMode=Fast opens the instances requested for the report in read-only mode, which is faster and consumes less resources than a full open.
    • Options.OpenMode=PDF directly opens the most recent PDF file saved for an instance. This option can only be used when you provide a unique key that matches exactly one instance. If a PDF does not exist, ExcelWraps will automatically queue a background job to generate a PDF file for the instance. To avoid creating a PDF file, use Options.OpenMode=CheckPDF instead.
  • Options.AutoNumberFilter lets you filter by AutoNumber to only include the First, Last, or LastFrozen records in the report. Example: “Options.AutoNumberFilter=Last”. In interactive reports, you can use the “Filter” popup form at the top of MyWraps.
  • Options.Title=The+Title+goes+here sets the top heading for the report.
  • Options.Description=Tasks+not+on+hold defines the description of the Mywraps report.
  • Options.aggregates=Days.sum. get a sum of the values of Days in the report. There are many other aggregates like min, max, average, absmin, absmax, count, counta, countblank, stddev and rms.
  • pageSize=10 causes the report to show ten instances per page. MaxRows is still in effect, read more in The MaxRows Parameter below.
  • page=2 includes only the second page of instances in the report, beginning with instance number pageSize+1. An incorrect page setting designating a non-existent page returns an empty report, read more in The MaxRows Parameter below.

Data types

  • string – a text field
  • int – an integer
  • double – a floating-point number
  • percent – a multiple of 0.01
  • date
  • time
  • datetime
  • oadate – a date in Excel format, i.e. as an Excel serial number, an integer value for dates.
  • oadatetime – a time and date in Excel format, i.e. as an Excel serial number, a decimal value for time and date.
  • anchor

Signature properties

This metadata can be requested from signature fields, e.g. Signature.sig-datetime

  • sig-detail
  • sig-summary
  • sig-date
  • sig-time
  • sig-username
  • sig-firstname
  • sig-lastname
  • sig-nickname
  • sig-company
  • sig-location
  • sig-datetime

Extracting data for use in Wraps

Requesting a lot of data using many WrapLinks or WrapLinkAggregates, e.g. for a complex dashboard showing hundreds of entries, can be very time-consuming because of all the database operations required to provide the data one cell at a time. Using the MyWraps2 function, you can request a single data extract containing all the data you need by defining a single MyWraps link and having all the data returned with item separators in a single cell of the dashboard Wrap.

Working in Excel

Some users find it a powerful option to manipulate a MyWraps report as a spreadsheet in Excel.

Export reports to Excel as CSV or HTML files

The Download button in the toolbar allows you to export any MyWraps report as a CSV file that contains the bare numbers with no formatting, or as an HTML file that contains all the numbers and hyperlinks to take you back to the source information on your Wrapsite. Excel can open both filetypes as spreadsheets via File > Open.

Dynamic link to MyWraps

Excel has an embedded browser that can read a MyWraps report and pull it through to Excel for additional calculations and charting. The connection is dynamic and a Refresh button immediately updates your Excel workbook with live information from the Wrapsite.

Exporting complete Wrap instances to an XML file

Wrapsite administrators can also export the data in the Wrapsite to an XML file on the Administration dashboard > ExcelWraps > Wrap instances page. This file contains the Wrap and all the Wrap instance information and can be imported to another Wrapsite. For more information, read the help page for the Wrap instances page.

The export file is in XML format (Extensible Markup Language) and can be read by Excel. The exported file is compressed in the ZIP format.

To ease you into learning how Excel manages XML data files we have prepared some workbooks that can read any XML exported from your ExcelWraps subdomain. Our WrapReader.xlsm workbook splits the data in the XML file into Excel filtered lists and pivot tables presented on separate tabs.

  • The workbook reads the whole data set but native Excel Filter controls allow you to filter down to single items or multiple data items.
  • It is easy to determine aggregate values over the selected data items using functions like AVERAGE, COUNT, COUNTA, MAX, MIN, PRODUCT, STDEV, STDEVP, SUM, VAR and VARP.
  • Our Worksheet contains macros that will find the source URL of any data item, we even highlight the data item so it is easily identified.

Signature data has a slightly different data structure but is similarly interrogated using our WrapReaderSig.xlsm workbook.

Note: both the above .xlsm files contain Excel macros written in Visual Basic. Excel considers downloaded files with macros to be potentially harmful. If you cannot open or use the macro-enabled files as expected you may need to change your Options > Trust Center settings for Excel so that Excel allows the embedded macros to run.

These tools can be used offline to generate both simple and complex reports and they can be completely customized using Excel’s native commands.

The Export to Excel widget

When you view a Wrap instance, you can save content from it as a spreadsheet in xlsx format using the Export to Excel widget.

Bespoke reports

The ExcelWraps Client Services team use powerful database reporting tools to make any report no matter how complex. These reports can be made available through your Wrapsite. Don’t hesitate to contact Client Services if you need our help.

The MaxRows parameter

With improper filtering, a MyWraps report can become very long. To ensure that you create manageable reports, a MyWraps report stops after 500 instances by default.

When your report reaches the limit you will see the following warning at the top of the report

*** NOTE: MyWraps is capped at MaxRows = 500 ***

The instance limit can be adjusted using the MaxRows option in the MyWraps link:

...&Options.MaxRows=100...

In the example above, the report will be limited to the first 100 instances.

Use better primary filters

If you reach the row limit inadvertently, you need to reduce the number of rows through better filtering. The MaxRows limit applies to primary filters only. These are high-speed filters used in the database already when extracting the source data for the report. Primary filtering of instances is based on four things:

  • The Unique Keys for the Wrap offer a very fast way of removing instances you don’t need. Zoom in to the subset of data that you are really interested in by filtering on essential parts of the Unique Key.
  • The State of the instances, live or frozen. What is your report trying to show – work in progress or only completed work? Removing the frozen wraps often reduces the number of instances considerably.
  • The Creation properties, date, and user. Are you only interested in instances that were created during a particular period? If you’re only looking for the wrap instances created by yourself? These are very good primary filters that often remove a lot of instances.
  • The Last-modified properties, date, and user. The last-modified date for a frozen Wrap instance essentially tells you when it was frozen. The user that last modified the instance can be used as a progress indicator if you’re only looking for instances at a certain step of a process. Both these filters can reduce the number of instances in the report dramatically.

Once the designated subset of wrap instances has been extracted, secondary filtering takes place on individual field values. This is done in memory on the server and is much slower than primary filtering. Secondary filtering is unaffected by the MaxRows setting.

Increase MaxRows or turn it off

MyWraps can handle an unlimited amount of rows. If you expect your report to include more than 500 wrap instances, just increase the MaxRows parameter in the link. If you need all available data to be included, MaxRows can be completely disabled by setting it to -1 or 0.

...&Options.MaxRows=0...

A word of caution: anyone can make mistakes. With MaxRows disabled, you have no protection if an adjusted filter suddenly requests a ridiculously long report, that takes ages to generate.

If your MyWraps report is intended to be used with the WrapStack widget to manipulate a bulk of instances, we recommend that you adjust the MaxRows parameter quite precisely to your expectations, to avoid overloading the server and the database if an inadequate filter setting in MyWraps results in an enormous update job that you most certainly will want to undo later.

The relationship between MaxRows, pageSize, and page

pageSize

The pageSize setting defines the number of instances that appear on each page of the report. It has a Wrapsite default setting, see below.

You can override the default value using the pageSize=n parameter in the MyWraps link. If n exceeds the maximum value set for the Wrapsite (see below), the maximum value is used instead of n.

page

The page setting requests a particular page in the report, e.g. page=2. You cannot specify a range or a list of pages, only a single, positive integer.

The first instance on each page is (page-1)*pageSize+1, e.g. if page=2 and pageSize=10, the report will start with instance (2-1)*10+1=11.

Special cases

  • The default for page is 0, meaning “include all pages in the report”.
  • If pageSize=0, pagination is disabled and all the instances appear on page 1. If you request page 2 or later, the report will be empty.
  • If pageSize is equal to or greater than the number of instances, all the instances appear on page 1. If you request page 2 or later, the report will be empty.
  • If pageSize is equal to or greater than MaxRows, all the instances appear on page 1. If you request page 2 or later, the report will be empty.

MyWraps settings

The pageSize setting has a Wrapsite default setting on the Administration dashboard > Settings page.

Screenshot of the pageSize default setting for a Wrapsite

You can override the default value using the pageSize=n parameter in the MyWraps link. If n exceeds the maximum value set on the Administration dashboard > Settings page, the maximum value is used instead of n.

Screenshot of the Max pageSize setting for a Wrapsite