Initial setup

9.3.5/ac_accessibility_features_for_designers.md

@@ -0,0 +1,52 @@
+# Accessibility features for application designers {#accessibilityfeaturesforapplicationdesigners .concept}
+
+HCL Leap contains accessibility features so users with disabilities can create forms and applications.
+
+To make designing forms and applications easier for users with disabilities, Leap has the following keyboard shortcuts:
+
+Adding items to your form
+:   To add items to your form from the Palette, set focus on the form item with the Tab key and press Enter. The item appears on the form where indicated by a blue line.
+
+Focus indicator
+:   When a form item has focus the background changes color, and the area that is occupied by the form item is defined by a colored line.
+
+Item triggers
+:   When an item has focus, you can trigger it by pressing the Enter key or space bar. The browser that you use determines whether you must press the Enter key or space bar.
+
+Tab key
+:   You can navigate to any visible form item, link, or menu by pressing the **Tab** key.
+
+Tab navigation
+:   The Properties side panel contains multiple tabs. To navigate between tabs, use the arrow keys.
+
+Tab order of form items
+:   When you place items on a form, the tab order is set based on item placement. If you insert a form item before existing items, the tab order is automatically reset. You do not have to manually configure tab order when you insert additional items into a form.
+
+Navigating between Palettes
+:   You can navigate between the Common, and Specialized palettes. When the focus is on one Palette use any arrow key to collapse the open Palette and expand another one. If you want to switch palettes while focus is on a form item, you must use the Tab key to move to the palette name, then navigate with the arrow keys. You cannot navigate between palettes when a form item has focus.
+
+Keyboard commands for common items
+:   Leap has three menu items: **Save**, **Preview**, and **Cancel**. The following keyboard commands are available so you do not have to navigate away from your form.
+
+Save
+:   Ctrl+s
+
+Preview
+:   Ctrl+e
+
+Cancel
+:   Ctrl+q
+
+When designing forms the Properties side panel contains a box titled “Accessibility - Alternative text ID”. Use this box to provide a text description that is used by accessibility tools to describe the item.
+
+The following [WAI ARIA](http://www.w3.org/TR/wai-aria/) attributes are automatically added to form items when you design forms:
+
+-   aria-labelledby and Aria-label are added to fields to associate the correct label with each field.
+-   aria-describedby are added to fields where more description is needed to describe the function of a field.
+-   aria-required is added to inform a user that the field is mandatory.
+-   aria-invalid is added to fields when the value is not valid.
+-   aria-alert is used with Aria-invalid in error messages. Screen readers read the Aria-alert text to the user.
+-   aria-valuemin and aria-valuemax are used to denote if the file has an acceptable value range. If the value is outside the range, the aria-invalid attribute is set.
+
+**Parent topic:**[Accessibility overview](ac_experience_builder_accessibility.md)
+

9.3.5/ac_accessibility_features_for_users.md

@@ -0,0 +1,14 @@
+# Accessibility features for application users {#accessibilityfeaturesforapplicationusers .concept}
+
+When given the link to an HCL Leap application, a user is provided with many built in accessibility features.
+
+To make using forms and applications easier for users with disabilities, Leap has the following accessibility features and keyboard shortcuts:
+
+Screen reader compatibility
+:   Leap is compatible with screen readers that comply with WCAG 2.0 and WAI-ARIA. Some screen readers perform a read through of web pages from start to finish as the default.
+
+Tab key
+:   You can navigate to any visible form item, link, or menu by pressing the **Tab** key.
+
+**Parent topic:**[Accessibility overview](ac_experience_builder_accessibility.md)
+

9.3.5/ac_creating_accessible_application.md

@@ -0,0 +1,20 @@
+# Creating an accessible application {#creatinganaccessibleapplication .concept}
+
+When you create a form or application, the following information helps you design an accessible form for users with disabilities.
+
+HCL Leap is designed to make building accessible forms easy. For example, the tab order of form items is set to start at the first item on the page, and work through consecutive items. You do not have to reset the tab order if you must add items to the beginning of a form. There are several things that you can do to make your forms more accessible to users with disabilities:
+
+-   During the creation of your application, accessibility standards, such as [WCAG 2.0](http://www.w3.org/TR/WCAG20/), should be considered with regards to layout and content. Leap does not prevent authors from creating non-accessible forms.
+-   When you add items to your form, give each form item a clear description or name. Screen readers read the name that is associated with a form item. You can also use a Text item as a data label instead of the field provided. For more information, see [Using a Text item as a label](ac_using_text_item_as_label.md).
+-   Add hints to each form item by modifying the **Add hint** field. The Hint provides more information when read to the user. For example, if your form has a **Name** field, the hint tells the user your preference for how to enter their given and surnames.
+-   Text blocks are not automatically part of the tab order. Screen readers do not put focus on text blocks, and your users might miss vital information. To ensure that text information is not omitted, select the text item, in the properties side panel, select the check box for **Add to tab order**. The text is added to the tab order, and is read by screen readers.
+-   If you add images or media items to your forms, open the Properties side panel and add descriptive text to the **Alternative text** property. A screen reader uses the alternative text to describe the image or media item to the user.
+-   You can add text items to your form and have them associate with other form items. You can use this technique to create formatted titles for your form items. However, you must link the text item and the form item together. For example, you have a Select One item on your form. You want its title to be rich text so it can have a color, background, and format different from the default title. You add the title with the Text form item, which gives the formatting you want. However, the text item is not read by the screen reader, and the user might not know what the choice list represents. To ensure that the **Text** field is read by a screen reader, go to the choice list Properties side panel. Insert the name of the **Text** field into the **Accessibility – Alternative label ID** field. A screen reader reads the appropriate text for the choice list.
+-   When using the new dynamic layout, it might be necessary to group items into Sections to convey the proper meaning to users. For example, when creating a custom label via the alternative text ID option.
+-   When using **Sections**, if a label exists, it provides a navigation landmark using WAI-ARIA that is available to assistive technologies. For more information, [WAI\_ARIA roles](http://www.w3.org/WAI/PF/aria/roles).
+
+-   **[Using a Text item as a label](ac_using_text_item_as_label.md)**  
+For accessibility ease of use, users might prefer to see the title of an entry field to the side of the field, rather than above the field.
+
+**Parent topic:**[Creating and managing applications](cr_creating_and_managing_toc.md)
+

9.3.5/ac_experience_builder_accessibility.md

@@ -0,0 +1,14 @@
+# Accessibility overview {#experiencebuilderaccessibility .concept}
+
+HCL Leap contains a number of built-in accessibility features to make applications easy to create and use by people with disabilities.
+
+Leap provides the best accessibility experience when used with the newest release of the browser and the newest release of the screen reader. For more information, see the following URLs:
+
+-   [Accessible Rich Internet Applications \(WAI-ARIA\) 1.0](http://www.w3.org/TR/wai-aria/)
+-   [Web Content Accessibility Guidelines \(WCAG\) 2.0](http://www.w3.org/TR/WCAG20/)
+
+-   **[Accessibility features for application designers](ac_accessibility_features_for_designers.md)**  
+HCL Leap contains accessibility features so users with disabilities can create forms and applications.
+-   **[Accessibility features for application users](ac_accessibility_features_for_users.md)**  
+When given the link to an HCL Leap application, a user is provided with many built in accessibility features.
+

9.3.5/ac_using_text_item_as_label.md

@@ -0,0 +1,27 @@
+# Using a Text item as a label {#settingatextitemasalabel .task}
+
+For accessibility ease of use, users might prefer to see the title of an entry field to the side of the field, rather than above the field.
+
+The following instructions describe how to set a text item as the title of a field. For this example, the title is displayed to the left of the field where the user will type information. You can also use these instructions inside a Section, which allows you to format the spacing between the Text item and the Entry Field without affecting the spacing of the rest of your form.
+
+1.  Add a **Text** item to the left column of the grid.
+
+    The Edit Text Properties side panel opens.
+
+2.  Type the title you want to display to users on the form.
+
+3.  Copy the information displayed in the **ID** field.
+
+    On a new form, where the text item is the first item on the form, the default name is F\_Text1. You can change this ID to be any name you want, however each form item must have a unique ID.
+
+4.  Add a **Single Line Entry**, or **Multi-Line Entry** to the right of the **Text** item.
+
+5.  In the properties side panel, delete the text from the **Title** field.
+
+6.  Go to **Data Label** and paste the unique ID you copied from the **Text** field.
+
+
+When you save and preview the form, the text item appears as the label for the entry field.
+
+**Parent topic:**[Creating an accessible application](ac_creating_accessible_application.md)
+

9.3.5/ad_managing_db2_database.md

@@ -0,0 +1,8 @@
+# Backing up and restoring the DB2 database {#managingyourdb2database .concept}
+
+Data for HCL Leap applications is stored within a database. Ensure that you have a backup and restore strategy in place to protect your data.
+
+Backing up and restoring data in DB2® is done using the **Backup** and **Restore** commands. If you plan to restore data from a server with a different bit order than the one currently storing the data, you must use the Data Movement Tool. For more information, see [Data Movement Tool](http://www.ibm.com/developerworks/data/library/techarticle/dm-0906datamovement/).
+
+**Parent topic:**[Administering Leap](administering_leap.md)
+

9.3.5/admin_application_dashboard.md

@@ -0,0 +1,19 @@
+# Admin Application Dashboard {#admin_application_dashboard .concept}
+
+The Admin Application Dashboard is a page that is available to members of the Admin or SuperAdmin groups.
+
+An **Admin** tab will appear in the top banner for users with permission. The page provides information about all the applications on the Leap server. To manage the load on the server, the details are gathered using a timer task that runs at a regular configurable interval \(see Application Statistics collection timer in [Configuration properties](co_configuration_properties.md)\).
+
+The dashboard shows the following:
+
+-   The total number of applications.
+-   A breakdown of the applications by status \(i.e. running, undeployed\).
+-   The total number of application records across all applications.
+-   A filterable table of all the applications. Clicking on a row in the table reveals additional details about the selected application.
+
+The data may be updated by clicking **Refresh**. The data may be exported to a spreadsheet by clicking **Export to spreadsheet**.
+
+For more information, see [Application statistics REST API](app_stats_restapi.md).
+
+**Parent topic:**[Administering Leap](administering_leap.md)
+

9.3.5/administering_leap.md

@@ -0,0 +1,11 @@
+# Administering Leap {#administering_leap .concept}
+
+The following topics contain information on administering Leap.
+
+-   **[Backing up and restoring the DB2 database](ad_managing_db2_database.md)**  
+Data for HCL Leap applications is stored within a database. Ensure that you have a backup and restore strategy in place to protect your data.
+-   **[Strict CSP](leap_strict_csp.md)**  
+HCL Leap 9.3.1 has a limited capability to restrict the rendering of Leap Forms using a “Strict CSP” policy.
+-   **[Admin Application Dashboard](admin_application_dashboard.md)**  
+The Admin Application Dashboard is a page that is available to members of the Admin or SuperAdmin groups.
+

9.3.5/app_stats_restapi.md

@@ -0,0 +1,45 @@
+# Application statistics REST API {#app_stats_restapi .concept}
+
+Application statistics REST API exposes statistics data on all applications, such as an application's last updated date, record count, attachment size etc.
+
+Statistics are collected by a timer task which can be configured by an administrator using [Configuration properties](co_configuration_properties.md).
+
+-   Authentication
+
+    All REST API calls must be made as an authenticated user in Administrator or Super Administrator role. If you want to exercise the API with code, you may use basic authentication. The primary mechanism is to use basic authentication where the username and password are a Base64 encoded string.
+
+-   REST actions
+
+    The following table lists the types of actions that are available and the URLs associated with those actions.
+
+    |URL|HTTP Verb|ActionName|
+    |---|---------|----------|
+    |/apps-basic/secure/org/admin/apps|GET|list|
+    |/apps-basic/secure/org/admin/apps/\{app-uid\}|GET|app detail|
+
+    **Note:** `app-uid` is the UID of the application.
+
+
+## List {#section_p5n_2bc_kyb .section}
+
+This action retrieves a list of all apps, available query parameters:
+
+-   `forceRefresh`: executes statistics collection on all apps. Default value: `false`
+
+-   `includeForms`: whether includes app forms information in response. Default value: `false`
+
+-   `includeAdmins`: whether includes app administrators information in response. Default value: `false`
+
+-   `format`: \(case sensitive\) acceptable values: json, application/json, xlsx, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+
+-   `filename`: only used when pFormat is set to xlsx format. The file extension has to be xlsx.
+
+    **Note:** When the format is an open document and a file is downloaded, if the file name is not set, the default file name is app.xlsx.
+
+
+## App detail {#section_qwb_qbc_kyb .section}
+
+This action retrieves the details for a single app.
+
+**Parent topic:**[REST API reference](ref_rest_api_ref.md)
+

9.3.5/as_assigning_users_or_groups_to_roles.md

@@ -0,0 +1,48 @@
+# Assigning users or groups to roles 
+
+Give the users in your organization permission to work with the data relevant to them by assigning them roles.
+
+After you establish roles for the users in your organization, you can start assigning users to those roles by adding them individually, or in groups using the **Access** tab in HCL Leap. For example, you can assign users or groups as defined in your LDAP to **Roles**. You can use the search to find users and groups within your company directory, or database. There are several predefined groups from which to choose:
+
+#### All Authenticated Users
+
+Any user who is authenticated with your organization.
+
+#### Anonymous Users
+
+Any user who you want to work anonymously with the application.
+
+#### Invited Users
+
+Any anonymous user who receives a unique URL generated from within stages when an application changes from one stage to another. A user who is not normally given access to the form in that stage can use that URL to participate in the workflow in that instance.
+
+**Note:** Requires allowed anonymous access.
+
+#### Instance Creator
+
+The user who submitted a form.
+
+**Note:** You cannot add **All Authenticated Users** to any role that has application **Edit** permissions. This prevents the applications from all other users from appearing in your **Manage** tab, making your applications easier to find. This also prevents your application from appearing on the **Manage** page for every other authenticated user.
+
+To add users from predefined groups:
+
+1.  In the **Access** tab, go to the navigation tree and click the role you want to assign in the **Assign Users** menu.
+
+    The Assign Users window opens.
+
+2.  Add new usersor groups, or select from a predefined group:
+
+    -   To create new usersor groups, enter the name of an individual useror group. Select it, then click the **Add user** plus sign.
+
+        **Note:** There is a limit to the length of a single user name, or ID. The limit varies by language and character set. For example, the English limit is 256 characters. If you exceed the character limit, you are shown an error message when you attempt to save the form.
+
+    -   To use an existing group, select the group and click the **Add group** plus sign.
+    The **Role Members** window shows the members that are assigned to the role.
+
+3.  You can remove members from a role by clicking **Delete user** for the name of the member., or run a test to see whether Leap can find the member.
+
+    -   To remove a member from a group, click **Delete group** for the name of the member.
+    -   To test if Leap can find a group member, click **Validate**.
+
+**Parent topic:**[Securing](se_security_toc.md)
+

9.3.5/as_assigning_users_to_maintain_the_application.md

@@ -0,0 +1,15 @@
+# Assigning users to maintain the application {#assigninguserstomaintaintheapplication .task}
+
+To define who can edit an HCL Leap application, use the design settings in the **Access** tab.
+
+By default, only administrators can edit and maintain an application. However, you can also assign other roles to do the task. In the **Manage** tab, an administrator can grant permission for other users to edit applications.
+
+1.  To change who can edit an application, click **Design Settings** in the **Access** tab.
+
+    The Design Settings table opens, displaying roles and their access permissions.
+
+2.  To grant or remove edit permission from a user role, click the **Edit** check box next to that role.
+
+
+**Parent topic:**[Securing](se_security_toc.md)
+

9.3.5/as_define_security_roles.md

@@ -0,0 +1,39 @@
+# Defining basic security roles for users {#definesecurityroles .task}
+
+Create roles for users in your organization so they can work with data that is relevant to them.
+
+HCL Leap uses a customizable role-based model to define who can access data and who can modify the application. Roles allow the assignment of data access, and application maintenance permissions.Individuals or groups are then assigned to the roles with the access component, or programmatically through web services. There are three predefined roles:
+
+Administrator
+:   A role that includes users, or groups, with administrator privileges for an application.
+
+Initiator
+:   A role that includes any user, or group, who can submit a form or initiate an application. For example, if the application was for Vacation Requests, you can allow all users in your organization to initiate, or submit, a Vacation Request.
+
+Record Owner
+:   A role that contains the user, or group, who submitted the form dynamically at run time.
+
+Each role can be Open \(dynamic\) or Closed \(static\).
+
+-   Open roles – where assignments are done either statically, or dynamically with a web service call defined on a stage action within stages. Users are assigned based on data that is gathered during the form submission. For example, a web service looks up a manager for each user who submits a form, and assigns the manager a role.
+-   Closed roles – where assignments of users and groups to the roles must be done explicitly from within the Access tab. Closed roles do not assign users dynamically with a web service.
+
+To add a role:
+
+1.  In the design environment, click the **Access** tab.
+
+    The **Define Roles** window opens.
+
+2.  Click the **Add role** green plus sign to add a role.
+
+    For example, you can name the new role, “Manager”.
+
+3.  Click the **Add role** plus sign to define another role.
+
+    For example, your form also requires a “Shift Supervisor”.
+
+4.  Use the radio buttons to select whether the role is **Open** or **Closed**.
+
+
+**Parent topic:**[Securing](se_security_toc.md)
+