onespan sign accessibility user's guide · 2020-06-02 · consortium (w3c). currently, onespan...
TRANSCRIPT
NOTE: This PDF is no longer being maintained. For the latest updates, please refer to our Community Portal.
OneSpan Sign Accessibility User's Guide Date: January 28, 2020
Version: OneSpan Sign 7.2
Copyright Notices
Copyright © 2019 OneSpan North America, Inc. All rights reserved.
Trademarks
OneSpan™, DIGIPASS® and CRONTO® are registered or unregistered trademarks of OneSpan North America Inc. and/or OneSpan International GmbH (collectively "OneSpan") in the U.S. and other countries.
OneSpan reserves all rights to the trademarks, service marks and logos of OneSpan and its subsidiaries.
All other trademarks or trade names are the property of their respective owners.
Intellectual Property
OneSpan Software, documents and related materials (“Materials”) contain proprietary and confidential information. All title, rights and interest in OneSpan Software and Materials, updates and upgrades thereof, including software rights, copyrights, patent rights, industrial design rights, trade secret rights, sui generis database rights, and all other intellectual and industrial property rights, vest exclusively in OneSpan or its licensors. No OneSpan Software or Materials may be downloaded, copied, transferred, disclosed, reproduced, redistributed, or transmitted in any form or by any means, elec-tronic, mechanical or otherwise, for any commercial or production purpose, except as otherwise marked or when expressly permitted by OneSpan in writing.
Disclaimer
OneSpan accepts no liability for the accuracy, completeness, or timeliness of content, or for the reliability of links to and content of external or third party websites or materials.
OneSpan shall have no liability under any circumstances for any loss, damage, or expense incurred by you, your com-pany, or any third party arising from the use or inability to use OneSpan Software or Materials, or any third party mater-ial made available or downloadable. OneSpan will not be liable in relation to any loss/damage caused by modification of these Legal Notices or content.
Reservation
OneSpan reserves the right to modify these Notices and the content at any time. OneSpan likewise reserves the right to withdraw or revoke consent or otherwise prohibit use of the OneSpan Software or Materials if such use does not con-form to the terms of any written agreement between OneSpan and you, or other applicable terms that OneSpan pub-lishes from time to time.
Contact us
Phone: 1-855-MYESIGNe-Mail: [email protected] Support: https://www.esignlive.com/customer-supportResource center: https://www.esignlive.com/resource-centerCompany Website: https://www.onespan.com
Date: January 28, 2020
CONTENTS
1 About This Document 1
1.1 Accessibility Support for Senders 1
1.2 Accessibility Support While Using the Signing Ceremony 2
2 OneSpan Sign and Accessibility 3
2.1 General Accessibility Features Available in OneSpan Sign 4
2.2 Screen Readers 5
2.3 Using the Signing Ceremony with a Screen Reader 6
2.4 Supported Languages 7
3 Keyboard Drag and Drop 8
3.1 Tabbing on Links using a Mac 9
4 Creating an Accessible PDF 10
4.1 Introduction 11
4.2 A Sample Tagged PDF 12
4.3 Best Practices for Tagging PDFs 19
5 Creating an Accessible Transaction 22
5.1 Creating an Accessible Transaction via the UI 23
5.2 Creating an Accessible Transaction via the API 28
Accessibility User's Guide
iii
6 Signing Accessibly 32
7 Known Limitations 33
7.1 Limitations for Senders 34
Accessibility User's Guide
iv
1 About This Document
1.1 Accessibility Support for SendersAccessibility Support for Senders has been implemented throughout OneSpan Sign using the stratgegies, standards, and resources developed by the World Wide Web Consortium (W3C). However, there are still some limitations that will be resolved in the near future.
While OneSpan Sign follows the general principles of universal accessibility there are some features that require certain configurations to be made to enable full accessibility (for example, to use the Signing Ceremony on screen readers, or to enable drag and drop without a mouse). Please refer to these sections to enable those features.
TIP: Creating and sending transactions works best with the New User's Exper-ience.
1 About This DocumentAccessibility User's Guide
1
1.2 Accessibility Support While Using the Signing Ceremony
The Accessibility Support component enables people with disabilities to use OneSpan Sign with a screen reader, in accordance with the Americans with Dis-abilities Act of 1990 (ADA) and other global accessibility requirements.
This Accessibility User's Guide contains the following information which will help you enable and use Accessibility Support:
l Introducing Accessibility Support
l Keyboard Drag and Drop on page 8
l Creating an Accessible PDF on page 10
l Creating an Accessible Transaction on page 22
l Signing Accessibly
l Known Limitations
1 About This DocumentAccessibility User's Guide
2
2 OneSpan Sign and Accessibility
Accessibility Support for Senders has been implemented throughout OneSpan Sign using the stratgegies, standards, and resources developed by the World Wide Web Consortium (W3C). Currently, OneSpan Sign adheres to the accessibility standards recommended by the 2.0 AA version of Web Content Accessibility Guidelines (WCAG), but in the near future we will meet the AAA standards, as well as the stand-ards outlined by the 2.1 version of the WCAG.
2 OneSpan Sign and AccessibilityAccessibility User's Guide
3
2.1 General Accessibility Features Available in OneSpan Sign
The following lists some of the features we have implemented to make OneSpan Sign accessible:
l All OneSpan Sign features and actions are available through the use of key-board (no need to use a mouse).
l User interface pages are structured with hierarchical headers.
l Informative images are also accompanied by descriptive text.
l In forms, labels are explicitly associated with form fields.
l In data tables, header cells and data cells are linked to each other.
l Links have explicit titles, which clearly describe the content of the link.
l Links that open in a new window are tagged. This means that when a new win-dow is opened the reader is explicitly told so.
l User interface pages can be magnified, up to 200% of the original size.
l The contrast between text colors and background colors are compliant with accessibility standards.
2 OneSpan Sign and AccessibilityAccessibility User's Guide
4
2.2 Screen ReadersThe following (screen-reader, browser) combinations are supported on desktop and laptop computers:
l JAWS with Chrome
l NVDA with Firefox
l NVDA with Chrome
l JAWS with Internet Explorer
l VoiceOver with Safari
The following (screen-reader. mobile-device) combinations are supported:
l VoiceOver with iOS
l TalkBack with Android
2 OneSpan Sign and AccessibilityAccessibility User's Guide
5
2.3 Using the Signing Ceremony with a Screen Reader
To sign a transaction using a screen reader note the following:
l The transaction must first be made accessible. Accessible transactions must be created using either the New User Experience or via integration.
l An accessible transaction can only contain PDF files that have been tagged in conformity with ISO 14289-1:2012. These PDFs must be tagged outside of OneSpan Sign.
l The signer must enable accessibility from within the Signing Ceremony.
NOTE: The HTML representation for screen readers preserves the structure and the con-tent of the original PDF, but not its appearance.
2 OneSpan Sign and AccessibilityAccessibility User's Guide
6
2.4 Supported LanguagesScreen readers can vocalize the content of OneSpan Sign in all Supported Lan-guages (though some text is currently available only in English and French).
2 OneSpan Sign and AccessibilityAccessibility User's Guide
7
3 Keyboard Drag and Drop
When using the Designer to add fields and signatures to a transaction you must drag and drop them to their proper location within a document. To do so without the use of a mouse you must first configure your operating system to allow your key-board to control your mouse. Here are two tutorials that explain how to do so:
l Use Mouse Keys to move the mouse pointer (Windows)
l Change Alternate Control Methods preferences for accessibility on Mac
NOTE: To use this feature you will need a keyboard with a number pad.
3 Keyboard Drag and DropAccessibility User's Guide
8
3.1 Tabbing on Links using a MacIn Mac operating systems by default only Buttons and Inputs are brought into focus while tabbing through the user interface. However, focusing on Links can be useful for users who are unable to use a mouse.
Begining with OS X Mountain Lion Mac users can now do so by configuring their Safari preferences.
To configure Safari to allow tabbing on links:
1. Open Safari preferences and navigate to the Advanced Panel.
2. In the Accessibility section select Press tab to highlight each item on a webpage.
This will allow navigation to all controls and links on the page by pressing the tab key.
TIP: By default, tabbing through a Windows operating system will focus on Links, Buttons, and Inputs.
3 Keyboard Drag and DropAccessibility User's Guide
9
4 Creating an Accessible PDF
The following sections describe how to create an accessible PDF document:
l Introduction on page 11
l A Sample Tagged PDF on page 12
l Best Practices for Tagging PDFs on page 19
4 Creating an Accessible PDFAccessibility User's Guide
10
4.1 IntroductionThe concept of a "tagged PDF" is central to OneSpan Sign's accessibility solution, since only tagged PDF elements are included in its WCAG HTML representation. Thus all elements intended for accessible content and signing must be tagged (including Signature Fields and those "automatic fields" whose content is triggered by signing).
A tagged PDF can be created automatically from a text editor like Microsoft Word or Adobe FrameMaker. However, such automatic tagging creates only a basic tagged PDF. Such PDFs must subsequently be inspected and possibly changed to ensure that they meet the standards described in the rest of this chapter (see, e.g., Distrust Automatically Tagged PDFs on page 20).
The recommended way to add, modify, delete, or drag tags is by using Adobe Acrobat's Tags tool, located in its Navigation Pane (see here).
CAUTION: Full accessibility compliance requires even more than a suitably tagged PDF. For a complete checklist, click here.
4 Creating an Accessible PDFAccessibility User's Guide
11
4.2 A Sample Tagged PDFThe following figure shows the contents of a sample tagged PDF whose filename is Tagging Features.pdf.
4 Creating an Accessible PDFAccessibility User's Guide
12
The following figure shows the Tags tab for that PDF.
4 Creating an Accessible PDFAccessibility User's Guide
13
The structure tags on the preceding tab are organized in a hierarchical tree. The doc-ument starts with the root called Tags at the top. Inside the root is a set of tags iden-tified by their type (e.g., Part, H1, H2, P, Table). Each tag may contain other tags or leafs.
TIP: A "leaf" can be a Form Field, an image, or some text. In the above tab, each leaf is identified by a box icon.
If you right-click a tag on the Tags tab, the following dialog box appears:
4 Creating an Accessible PDFAccessibility User's Guide
14
That box's fields are:
l Type — The structure tag's type. You can specify it from the associated drop-down list (e.g., Paragraph, Heading Level 1). The accessibility solution uses this type when it converts the PDF tag to an HTML tag.
l Title (optional) — Name for the tag that appears in the PDF Tags view. This field exists only to help the tagging author identify the tags in that view. This inform-ation is not read by screen readers.
l Actual Text (optional) — This is replacement text for text that is represented in a non-standard way, especially regarding typography. For example: (1) a glyph for a ligature (ae, oe,, etc.); (2) a math equation. All PDF elements over which this tag is applied will be replaced by the content of Actual Text (see the example in the preceding figure).
l Alternate Text (optional) — This is human-readable alternate text provided for images and other items that do not translate naturally to text. For example, for
4 Creating an Accessible PDFAccessibility User's Guide
15
the image in our sample PDF, the value of this field could be: This is a rainbow happy face.
TIP: It may not be useful to tag a background picture for the visu-ally impaired. If the image is not tagged, the screen reader will not mention it. Nonetheless, some images are important sources of information, so it is usually a good practice to tell the “listener” what an image represents.
l ID (optional) — An identifier for the structure tag (e.g., figure1). The PDF format requires that all such IDs be unique (though they can remain empty). These IDs are exported to HTML. To comply with the identifier rules for HTML5, these IDs cannot contain spaces. Spaces will be removed before the export to HTML.
lNOTE: In a PDF document:, IDs are derived from two sources: (1) the IDs of structure tags; (2) the names of Form Fields. The PDF format requires that each of these be unique in its own “domain”, though the ID of a structure tag can be the same as the name of a Form Field.
l Language (optional) — The language (ISO 639-1) associated with the tag. The TTS engine will use the value of this property to better pronounce the text con-tained in the tag.
If you click the Content tab on the preceding dialog box, the following screen appears:
4 Creating an Accessible PDFAccessibility User's Guide
16
The Content tab enables you to specify additional properties of tags. One of the most useful is this:
l Expansion Text (optional) — The TTS engine can have problems with abbre-viations and acronyms. It is often better for the engine to pronounce an entire word instead of its abbreviation (e.g., boulevard instead of blvd., or Doctor instead of Dr.). This field enables the TTS engine to do that (see, for example, the value of the Expansion Text in the preceding figure).
Occasionally, a visually impaired person may find it easier to navigate a document if some parts are spoken in an order different from the document's visual order. The logical structure created by the tagging process makes it easy to reorder tags for that situation. Using Acrobat's Tags tool, one need only drag a given line to its desired new location in the displayed tree. The accessibility process will present spoken PDF information in a temporal order that descends sequentially from the tree's root (on top) to its bottom branch. In the following figure, the line “This line is visually below” in the tag tree appears above “This line is visually on top”. Yet they appear in the reverse order on the PDF. The screen reader will follow the order in the tag tree.
4 Creating an Accessible PDFAccessibility User's Guide
17
4 Creating an Accessible PDFAccessibility User's Guide
18
4.3 Best Practices for Tagging PDFsThe following sections describe various best practices:
l A Longer Page Is Preferable to Multiple Pages on page 19
l A Longer Page Is Preferable to Multiple Pages on page 19
l Distrust Automatically Tagged PDFs on page 20
l Give Users Clear Instructions on page 21
4.3.1 A Longer Page Is Preferable to Multiple PagesTo avoid needless navigation, it is better to have one long page than multiple pages. If a document is well-structured with meaningful PDF tags, it will be easily nav-igated by a visually impaired person. And if instructions are clear, having multiple pages is unnecessary.
4.3.2 Customize Instructions for Form FieldsWhen a page contains Form Fields that must be filled, a disabled person will usually switch their screen reader to form mode. In this mode, a user can type text which will not be interpreted as screen-reader shortcuts. The user will move from one field to the next using the TAB key. Each time the screen reader enters an input field, it will read the text of the <label> associated with that field, along with information about the field (e.g., checkbox — unchecked).
If the page contains free text between two Form Fields, it will not be read by the screen reader. In other words, if a description of what to do with a Form Field is in clear text, it will likely be skipped by the screen reader when it’s in form mode.
The correct way to address this problem is to add the required instruction to the Tooltip field of the Form Field's properties dialog box. OneSpan Sign will extract this information from the PDF document, and will make it available to screen readers.
The following figure illustrates how to add a tooltip to a Form Field:
4 Creating an Accessible PDFAccessibility User's Guide
19
And this next figure illustrates how the tooltip in the preceding figure appears on the PDF. That tooltip will be spoken by a screen reader:
4.3.3 Distrust Automatically Tagged PDFsBeware of PDF documents that have been tagged automatically. Unless the source document is extremely well structured, automatic tagging will not create a PDF that can be easily navigated by the visually impaired.
For example, the tag tree below was created after a Microsoft Word document was converted to PDF format with automatic tagging. The document's visual appear-ance (on the right of the figure) would lead one to expect that text 1 would appear first in the tag tree, followed by text 2 .However, the automatic tagging (on the left of the figure) reversed that order.
4 Creating an Accessible PDFAccessibility User's Guide
20
4.3.4 Give Users Clear InstructionsIt is important to tell users clearly what a page contains, which action is imme-diately required, and which action has just occurred.
When a page is displayed in a browser, the screen reader starts reading it from the top. At that point, it may be unclear to a visually impaired user why the page is being displayed, or what they have to do.
It is critical that a document contain Heading levels (h1 … h6) because they will be a visually impaired person’s main source of information about how the document is structured, and how to navigate through it. This can be achieved by appropriately tagging the PDF document.
If a field has been added automatically to a document’s currently viewed page, it is good to mention that fact at the top of the page. For example:
1. Add the statement “A text field containing the signing date was added to this document at this location”.
2. Over the words “at this location”, insert a hyperlink that links to the new text field.
4 Creating an Accessible PDFAccessibility User's Guide
21
5 Creating an Accessible Transaction
After an accessible PDF is created, it must be uploaded to an accessible trans-action.
Transactions are not accessible by default. Senders must therefore manually flag a transaction as accessible.
NOTE: The above default behavior can be changed, so transactions are accessible by default. To arrange this, contact our Support Team.
An accessible transaction can be created in the following alternate ways:
l Creating an Accessible Transaction via the UI on page 23
l Creating an Accessible Transaction via the API on page 28
5 Creating an Accessible TransactionAccessibility User's Guide
22
5.1 Creating an Accessible Transaction via the UITo create an accessible transaction or accessible template via the New User Exper-ience, senders must map the Form Fields in added documents to recipients' OneSpan Sign fields. The following procedure does that.
To create an accessible transaction or accessible template via the New User Exper-ience:
1. Create a transaction or create a template. Ensure that in the SETTINGS section, the Enable accessibility toggle key is on.
2. Click ADD DOCUMENT. In the dialog box that appears, select a document to be added to the transaction or template. Then click Open. Provided the document contains Form Fields, the Field Import dialog box appears.
3. Click START IMPORT. The Define Recipients page appears.
5 Creating an Accessible TransactionAccessibility User's Guide
23
4. Add a recipient. When done, click NEXT. The Import & Link Signatures page appears.
5. Click ADD SIGNATURE. A Signature drop-down menu appears, containing a list of all the document's signatures.
6. From the Signature drop-down menu, select a signature. That signature will be linked to the recipient.
NOTE: If optional signatures are enabled on your account, you may spe-cify the selected signature as Optional. If that flag is set, the recipient is
5 Creating an Accessible TransactionAccessibility User's Guide
24
not obliged to sign all of their signatures inside the transaction's doc-uments before completing the transaction.
7. A Signature Type drop-down menu appears. Use it to select one of the fol-lowing signature types for your selected signature:
l Click-to-Sign: The recipient's name is stamped on the signature field at the time of signing. This is the default signature type. We recommend it for signers who are blind, and for signers who have physical disabilities.
l Capture signature: The signer draws their signature using their mouse or another input device. The drawing of the signature is stamped on the sig-nature field at the time of signing.
l Click-to-Initial: To sign this type, a signer simply clicks the block. The signer's initials are then stamped on the block.
NOTE: Once the signer enables Accessibility Mode (as they must to sign accessibly), OneSpan Sign's software will offer verbal guidance on cursor placement. This could be especially helpful for the Capture signature method.
8. Click NEXT. The Import & Link Fields page appears. This is where you can spe-cify your mappings.
5 Creating an Accessible TransactionAccessibility User's Guide
25
9. To begin mapping, click ADD FIELD. A Field drop-down menu appears, con-taining a list of all available Form Fields in your document.
10. Select a Form Field from the Field menu. A Field type drop-down menu appears, containing a list of all available OneSpan Sign fields.
NOTE: The following OneSpan Sign fields are not available:
l Custom fields
l Notary fields
l List
l Date Picker
l Label fields
11. Select a OneSpan Sign field from the Field type drop-down menu.
12. Repeat the previous three steps for each Form Field you want to map.
13. Click NEXT. A new page provides an overview of the mappings you have cre-ated.
5 Creating an Accessible TransactionAccessibility User's Guide
26
14. Review your mappings. When you are satisfied with them, click DONE.
5 Creating an Accessible TransactionAccessibility User's Guide
27
5.2 Creating an Accessible Transaction via the API
5.2.1 POST /packages
Description
Creates an "accessible" package with document binaries. Disabled signers will be able to review and sign the documents in this package.
CAUTION: The package' documents must be suitably tagged PDFs. To learn how to cre-ate them , see Accessibility Support. If the PDFs are not tagged, your request will not suc-ceed.
NOTE: This section describes how to create an accessible package with attached doc-uments. If you wish, you can create an accessible package without any documents, then add the documents later.
Resource Information
HTTP Method POSTResource Family packagesAuthentication Authentication TokensContent Type multipart/form-dataAccept application/json
Example Request
POST https://sandbox.e-signlive.com/api/packages/
Request Payload
CAUTION: The Request Payload must: (1) specify fields and signatures using the same types as those given to the fields and signatures inside the package's tagged PDFs; (2) specify fields and signatures using the same names and IDs as those given to the names of the fields and signatures inside the package's tagged PDFs; (3) specify each
5 Creating an Accessible TransactionAccessibility User's Guide
28
approval's name and ID using the same name and ID of the associated signature; (4) set the extract flag to true for all relevant documents and fields.
------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="file"; filename="Unsigned Document.doc" Content-Type: application/msword ------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="payload" { "settings": { "ceremony": { "ada": true } }, "type": "PACKAGE", "language": "en", "name": "<Package Name>", "documents": [ { "approvals": [ { "role": "Customer", "name": "CustomerSignature", "id": "CustomerSignature", "fields": [ { "name": "APR", "id": "APR", "extract": true, "type": "INPUT", "subtype": "TEXTFIELD" }, { "name": "CustomerSignature", "id": "CustomerSignature", "extract": true, "type": "SIGNATURE", "subtype": "FULLNAME" } ] },
5 Creating an Accessible TransactionAccessibility User's Guide
29
{ "role": "Customer", "name": "Agent", "id": "Agent", "fields": [ { "name": "Agent", "id": "Agent", "extract": true, "type": "SIGNATURE", "subtype": "FULLNAME" } ] } ], "extract": true, "index": 0, "name": "Doc 1" } ], "roles": [ { "type": "SIGNER", "id": "Customer", "signers": [ { "signature": null, "firstName": "role", "lastName": "one", "email": "<email address>", "id": "Customer" } ], "name": "Customer" } ] } ------WebKitFormBoundary1bNO60n7FqP5WO4t--
Response Payload
{ "id": "4d09f2a8-4f0d-477b-8735-4b42ecf5ed0a" }
5 Creating an Accessible TransactionAccessibility User's Guide
30
Error Responses
The following error is created if you try to upload a PDF that is not tagged:
{ "messageKey": "error.validation.ada.notTaggedDocument", "message": "Documents uploaded to accessible transactions must be accessibility enabled.", "code": 400, "name": "Validation Error" }
The following error is created if you try to upload a PDF whose tags are not struc-tured correctly:
{ "messageKey": "error.validation.ada.documentNotTaggedProperly", "message": "Documents uploaded to accessible transactions must be tagged properly.", "code": 400, "name": "Validation Error" }
The following error is created if you try to change the ada flag for a package that already contains documents. This error therefore occurs not when you create a pack-age, but only when you update a package.
{ "messageKey": "error.validation.ada.documentsExist", "message": "The ADA flag cannot be updated once documents are uploaded", "code": 400, "name": "Validation Error" }
5 Creating an Accessible TransactionAccessibility User's Guide
31
6 Signing Accessibly
To sign accessible PDFs within an accessible transaction, signers must first click the Enable accessibility mode button within the Signing Ceremony.
NOTE: This button is available only if the transaction is accessible.
On desktops and laptops, the Enable accessibility mode button is at the top right of the signing page, and can be accessed using the keyboard or mouse. On a mobile device, this button is at the top of the signing page, and can be accessed by touch or by gesture navigation if a screen reader is enabled on the device.
Once accessiblity mode is enabled, the page will refresh and present the trans-action's documents in a format that is consumable by screen-reader technology — including navigating all documents and completing the entire signing process.
NOTE: l The Signing Ceremony of an accessible transaction supports content mag-
nification via the web browser (up to 200% zoom).
l The Signing Ceremony of an accessible transaction supports the navigation of fields via the keyboard's TAB key.
l Signers of an accessible HTML document use both the keyboard and mouse. Accessible HTML provides them with audio notifications via a screen reader.
l Some known limitations for signers are described here.
6 Signing AccessiblyAccessibility User's Guide
32
7 Known Limitations
OneSpan has recently been extending its Accessibility Support's WCAG compliance to additional use cases for senders and signers. And the company plans to do more.
The following sections describe known limitations whose removal is on OneSpan's roadmap:
l Limitations for Senders on page 34
TIP: Keep an eye on our Release Notes, as we will be gradually removing these lim-itations.
7 Known LimitationsAccessibility User's Guide
33
7.1 Limitations for Senders l Document formats other than PDF are not yet supported.
l Some text read by screen readers is currently available only in English and French.
l Drop-down lists, label fields, and date-picker fields are not yet supported in accessible transactions.
l The Reports page available to account owners is not yet accessible.
l Certain e-Notary features (e.g., Journals) are not yet accessible.
l Fast Track sending is only partly supported for accessibility. Some messaging is not available to screen readers.
l The only extraction type that accessible transactions can use is Position Extrac-tion.
l Our First Time Use Walkthough of the New User Experience has images and content that are not yet accessible (that Walkthrough is launched from the drop-down menu associated with your name on the top right of the Dashboard).
7 Known LimitationsAccessibility User's Guide
34