decimal App Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== decimal Launcher User Guide ======

{{:decimalauncher:icon.png?nolink&100 |}} The decimal Launcher is an application that allows users to authenticate securely and view many software applications that are available from .decimal. Users are then able to securely open (launch), install, and update various .decimal applications to their local computer. The decimal Launcher also allows users to install different versions of each application per site, for users that perform work for multiple sites/locations.

Access and permissions for the decimal Launcher and apps are managed through decimal Direct or by .decimal staff.

The decimal Launcher User Guide provides an overview of the decimal Launcher software as well as guides to perform common tasks using the software.

===== Overview =====

The decimal Launcher is the lightweight hub for all your new .decimal applications. It serves as a platform to easily apply updates and download new applications while allowing you as the user to only have to log in to a single platform.
The Launcher will provide the following features:
  * Allow users to log in with one account to access many .decimal applications
  * Allow installation and updates of applications
  * Verify the authenticity of all applications before opening

==== Version History ====

Please refer to the [[decimalauncher:versions|decimal Launcher version history]] for the complete listing of all versions and release notes.

===== Installation =====

==== Per User Installation (Default and Recommended) ====


The decimal Launcher can be downloaded from [[https://direct.dotdecimal.com]]. Note: You will have to login using your decimal Direct credentials to be able to download the software.

{{ :decimalauncher:launcher_download.png?800 |}}

By default, the decimal Launcher installs for the current logged in user in their local app directory (e.g.: C:\Users\<User>\AppData\Local\Programs\decimal Launcher) and shortcuts are created in the start menu and desktop only for this user. As such, it typically does not require administrator permissions to install on local computers.

Due to the decimal Launcher being a lightweight, simple application, there are no steps necessary when installing the decimal Launcher application other than running the installer (e.g.: no configuration files, no custom options, etc). However, the Launcher allows access to other .decimal Apps that may require additional setup steps, please so refer to each app's individual User Guide for setup details.

==== All User Installation ====

If it's desired to install the application for all users, IT departments may install the software to a folder accessible by all users (e.g. C:\dotdecimal\) and then create desktop/start menu shortcuts for the "Public User" so that all users have access to a single installation.

<WRAP center round important 70%>
**Permission Note for All User Installation:** \\
The decimal Launcher application may require occasional updates. These updates will typically be optional for a 30 day period, but then will be mandatory. Mandatory updates will prevent the user from accessing the Launcher and any software it manages until the update is performed. Therefore, it is strongly recommended to install Launcher to a folder that end users have write access to so that updates can be automatically performed without requiring IT intervention and delaying user software access.
</WRAP>

=== Notes Regarding All User Installation ===

  - Launcher maintains an individual AppData folder for each Windows user. As such, each user will have a separate directory where their Launcher application data is stored. Application downloads should be small and fast from .decimal's servers. Additionally, most of .decimal's customer applications (e.g.: p.d) allow editing the application's settings to point to a shared centralized patient database so that users can share application data even though Launcher separates their settings.
  - In the event the decimal Launcher needs to pull and install a new update, the update will be installed to the current Launcher installation folder. Any manually created application shortcuts in the start menu or desktop will not be altered, however, the user performing the update may see an extra shortcut created on their desktop if they do not disable that option during the upgrade.


==== Software Installation Updates ====

The decimal Launcher software can be updated by either running a new installation package (follow instructions above) or by an automated in-place update that is managed directly through the Launcher software. The automated (in-place) updates are used only when the currently running version of Launcher has reached End-of-Life (EOL) and can no longer be used. Since not all users will have the necessary permissions to perform a software update, .decimal will generally provide a minimum of 30 days notice for new releases, such that users have a fair amount of time to request assistance from their IT/IS team in updating the software. After the 30 day grace period is reached, the EOL Launcher version will require the in-place update to be completed before allowing access to any .decimal applications.


===== Authentication =====

==== Logging in====

Authentication is done through your .decimal Auth0 account. If you do not have an Auth0 account please contact your site’s .decimal admin or .decimal customer service at 1-800-255-1613.
Once you have your Auth0 account, open the launcher and you should be directed to the login page:

<imgcaption login_page|Main Login Page>{{ :decimalauncher:decimal_launcher_login_page.png?direct&200 |}}</imgcaption>

Type in your username and password and you will be logged in.

==== Lost or Forgotten password ====

If you have forgotten your Auth0 password or want to reset it you can do so from the Launcher’s log in page.

<imgcaption password_management_1|Password Reset Request>{{ :decimalauncher:decimal_launcher_login_page_zoomed.png?direct&200 |}}</imgcaption>

<imgcaption password_management_2|Password Email Input>{{ :decimalauncher:decimal_launcher_reset_password_zoomed.png?direct&200 |}}</imgcaption>

Select the “Don’t remember your password?” link and enter your email that is associated with your Auth0 account. You will receive a link in your email and instructions on resetting your .decimal Auth0 password.

<imgcaption password_management_3|Password Reset Email Example>{{ 2022-04-04_10_45_00-.decimal_password_reset_-_cmontoya_dotdecimal.com_-_dotdecimal.com_mail.png?direct&400 |}}</imgcaption>

<imgcaption password_management_4|New Password>{{ decimalauncher:decimal_launcher_reset_password_change_zoomed.png?direct&200 |}}</imgcaption>

----
===== Installing Applications =====
==== Downloading applications ====
The primary function of the Launcher is to download .decimal applications. After logging into the Launcher and selecting a site you will be presented with the applications available for that site. After selecting an app if you do not have it installed then the Launcher will have a "Download" button available.

Pressing the “download” button will download the version of the app that is listed. After downloading or if you have the app already installed the button will change to a “Launch” button. The application is now ready to be opened and used as normal.

<imgcaption downloading_apps|Downloading Applications>
{{:decimalauncher:decimal_launcher_app_page_download.png?direct&400 |}}
</imgcaption>

<imgcaption launching_apps|Launching Applications>
{{:decimalauncher:decimal_launcher_app_page_launch.png?direct&400 |}}
</imgcaption>

----

===== Updating applications =====

When .decimal releases a new version of an application the Launcher will
notify you by showing you a message above the “Launch” button for that
application.

<imgcaption update_warning_1|Update Available Warning>{{ :decimalauncher:decimal_launcher_outdated_app_warning.png?direct&400 |}}</imgcaption>

The Launcher it’s self will not download this update automatically. The only way to receive this new version is for your site Admin to approve this update and set it as your site’s version for this app. Instructions on how to do this can be found in the [[https://direct.dotdecimal.com/guide#site-management|decimal Direct User Guide]].

Once the application version is set in decimal Direct for your site, the decimal Launcher will enforce the download and installation of the application for all users of that site.

----
===== Sandbox Mode =====
The decimal Launcher provides a “Sandbox” area to install new versions of applications in order to test them before Clinical release. This area is separate from all of your Clinical applications so they will not affect any patient data.

NOTE: This option will only appear for users with the user level 'Elevated' (for Physics access) on their decimal account.

==== Setting the Sandbox App Version ====

The Sandbox environment requires explicit setting of the app version for each site. This is done using [[https://direct.dotdecimal.com|decimal Direct]] in the Manage -> Apps page. Refer to the [[https://direct.dotdecimal.com/guide#site-management|decimal Direct User Guide]] for more information.

Once the Sandbox app version is set, it will appear in the decimal Launcher

==== Running a Sandbox App ====

To switch the Launcher to Sandbox mode click the dropdown menu in the top bar and select “Switch to Sandbox mode”.

<imgcaption sandbox_switch|Switch to Sandbox Mode>{{ :decimalauncher:decimal_launcher_sandbox_switch_zoomed.png?direct&400 |}}</imgcaption>

When you switch over to Sandbox mode you will notice the Launcher has a different look to clearly distinguish you are not opening Clinical versions of these applications. All apps opened by the Launcher while in Sandbox mode will also open in their Sandbox modes, if the app provides support for Sandbox usage.

<imgcaption sandbox_mode|Sandbox_UI>{{ :decimalauncher:decimal_launcher_sandbox_full.png?direct&400 |}}</imgcaption>



----


===== Application Security =====
In order to maintain the safety of our users and our applications the Launcher provides the following safeguards:

==== Inactivity and Session Timeout ====

  * **Inactivity Timeout:**
    * The application inactivity timeout is set to 10 minutes by default. If the user performs no keyboard/mouse interactions within the application within that time period they will be automatically logged out and required to re-authenticate 
    * **NOTE:** This value can be changed in the [[decimalauncher:decimallauncher#app_settings|App settings]]
  * **Session Timeout:**
    * Once a user logs in using [[https://auth0.com/|Auth0]] the user's authentication session token is valid for 10 hours. After which they will be required to login and re-authenticate to the decimal Launcher. Any applications launched from the decimal Launcher that are using this token will need to be relaunched once the user has re-authenticated in the decimal Launcher

==== Release Versions ====

  * If **any** file in the application directory is added, removed, or altered in **any** way the Launcher will refuse to open the app. The Launcher will then delete and reinstall the altered app. Because of this it is suggested that you do not attempt to store any files in these directories as they will be removed.
  * If a critical bug or vulnerability if discovered in an existing release of any application .decimal will flag that version invalid. When the Launcher attempts to open an invalid application, it will notify the user and delete the application entirely.

This ensures binary file security to ensure that the application files are not tampered with on .decimal's server or on client work stations (via hashes and checksums).

----

===== Admin Options =====

All administrative actions such as setting app versions or adding users can be completed though the decimal Direct Admin page. For more information please refer to the [[https://direct.dotdecimal.com/guide#site-management|decimal Direct User Guide]]

----
===== App Settings =====

Certain app settings can be set to modify the behavior of the Launcher.

The app settings can be accessed via the Cog at the top right corner of the Launcher window:

<imgcaption app_settings|App Settings>{{ 2022-04-05_10_01_04-✎_decimalauncher_decimallauncher_decimal_app_documentation_.png?direct&400 |}}</imgcaption>

Currently the following settings can be changed:
  * **Timeout Time:** Sets the amount of time before the inactivity timer logs you out of the app. The default is 10 minutes.

Make sure to "SAVE" your changes once you are done to ensure you do not lose them.
<imgcaption app_settings|Edit App Settings>{{ 2022-04-05_10_01_37-.decimal_launcher.png?direct |}}</imgcaption>

----

===== Support =====

For questions, comments, support requests, bug reporting, or to schedule a training session, please contact our customer support team at:
 1-800-255-1613

==== Common Technical Issues ====

This section details a few very common errors and resolutions end users can experience while using the decimal Launcher. If you experience an issue not on this list or have questions please contact .decimal customer support.


=== Request Failed (401) ===

{{ :decimalauncher:2022-08-31_09_39_45-.decimal_launcher.png?400 |}}

  * **Error:** Request failed with status code 401
  * **Explanation:** The user authentication token sent to .decimal servers is incorrect. This is typically due to Web Security Appliances (WSAs) intercepting/inspecting our HTTPS traffic on the hospital's network, which can change the authentication request headers.
  * **Solution:**
    * Follow the [[support:it_troubleshooting#common_issues_and_resolutions|IT Support Common Issues and Troubleshooting Steps]] guide for WSAs and unrestricting .decimal HTTPS traffic.
    * Note: If your IT department has applied any security updates to whitelist .decimal servers, this //may// required users to logout and re-login or reboot the workstation to apply the new policy updates. This step is entirely dependent on your clinic's IT security setup and policies and how those policies have been implemented. For assistance please contact your IT department.


----

===== System Requirements =====

The following requirements are needed to be met prior to running the decimal Launcher.

==== Minimum System Requirements ====

| Operating System | 64-bit Windows 10/11 |
| Processor        | Dual Core 2.2+ GHz Intel or equivalent processor  |
| Memory           | 4 GB RAM |
| Video            | OpenGL compatible graphics card |
| Display          | 1920 x 1080 native resolution |
| Hard Disk        | 10 GB (recommended for app downloads) |
| Connectivity     | High Speed internet connection |
| Permissions      | Local user install permissions (non-admin) |

**Note: decimal Launcher is a lightweight [[https://www.electronjs.org/|ElectronJS]] application and does not require moderate hardware resources. But the applications it installs and manages could require much more substantial resources. Refer to each app's individual userguide for its specific hardware system requirements.**


==== Network Requirements ====

  - The decimal Launcher uses [[https://direct.dotdecimal.com/|decimal Direct]] to manage site, user, and application permissions. As such, the decimal direct IP address 64.128.252.104 port 443 must be whitelisted for the decimal Launcher to pull user, site, and application permissions.
  - The decimal Launcher uses [[https://auth0.com/|Auth0]] via [[https://direct.dotdecimal.com|decimal Direct's API]] for user credential management (i.e.: login authentication). As such, the Auth0 IP address(es) may need to be whitelisted in order for users to be able to login and authenticate with the secure Auth0 servers. While .decimal's applications use the decimal Direct API to authenticate, the decimal Launcher uses Auth0 connections to provide the login page and pull Auth0 tenant information. The [[https://auth0.com/docs/guides/ip-whitelist|Auth0 whitelist documentation]] provides details on the Outbound and Inbound firewall settings.
  - The decimal Launcher uses [[https://www.microsoft.com/en-us/download/details.aspx?id=56519|Azure EastUS IPs]], https://decimaldirect.blob.core.windows.net, and http://ocsp.msocsp.com to download application packages and updates. These will need to be whitelisted in order for the user to download apps within the decimal Launcher.

=== Required URLs ===

^ Server URL ^ Port  ^
| direct.dotdecimal.com (64.128.252.104) | 443 |
| auth.dotdecimal.com | 443 |
| auth0.com | 443 |
| [[https://auth0.com/docs/guides/ip-whitelist|Auth0 IPs]] (Login Authentication) | 443 |
| [[https://www.microsoft.com/en-us/download/details.aspx?id=56519|Azure EastUS IPs]] (Azure Blob Storage) | 443 |
| https://decimaldirect.blob.core.windows.net (Azure Blob Storage) | 443 |
| http://ocsp.msocsp.com (Azure Blob Storage) | 443 |

----
<WRAP center 10%>//USR-018//</WRAP>

;#;
//Copyright © 2020-2024 .decimal, LLC. 
All Rights Reserved.// \\
.decimal, LLC. 121 Central Park Place, Sanford, FL 32771. 1-800-255-1613
;#;