decimal App Documentation

User Tools

Site Tools

Trace: • planning_versions • instructions_for_use
direct:userguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
direct:userguide [2022/09/09 16:10] – [Processing Agreement] dpatenaudedirect:userguide [2022/11/23 13:47] (current) – [Inviting users to your site] dpatenaude
Line 71: Line 71:
   -  Select the "**Order**" button.<imgcaption direct_user_guide_3|The Order buttons>{{ :direct:order.png?direct&600 |}}</imgcaption>   -  Select the "**Order**" button.<imgcaption direct_user_guide_3|The Order buttons>{{ :direct:order.png?direct&600 |}}</imgcaption>
   -  Select the "**Upload**" button to browse for your file(s).<imgcaption direct_user_guide_4|The ordering page>{{ :direct:upload.png?direct&600 |}}</imgcaption>   -  Select the "**Upload**" button to browse for your file(s).<imgcaption direct_user_guide_4|The ordering page>{{ :direct:upload.png?direct&600 |}}</imgcaption>
-  -  Select the file(s) for upload (**NOTE:** //you may select multiple files at the same time to upload//)+  -  Select the file(s) for upload(**NOTE:** //ONLY ".dec" or ".dat" files are allowed to be uploaded for ordering, you may select multiple files at the same time to upload//)
   -  Select the "**Upload**" button on the file selector to send the selected files to the "File Holding Queue" (**NOTE:** //your order is not yet ordered, see the Ordering Files section//)   -  Select the "**Upload**" button on the file selector to send the selected files to the "File Holding Queue" (**NOTE:** //your order is not yet ordered, see the Ordering Files section//)
 ==== Ordering Files ==== ==== Ordering Files ====
Line 82: Line 82:
  
   - Verify that all files uploaded are displayed. If this is not the case, please contact .decimal customer support for further assistance. It may take a few seconds for your files to appear as they are processed.   - Verify that all files uploaded are displayed. If this is not the case, please contact .decimal customer support for further assistance. It may take a few seconds for your files to appear as they are processed.
-  - Select the file(s) you wish to order.   **NOTE:** //Files must have a status of "**Ready to Order**" in order to finalize and place the order. If this is not the case, follow the guideline of the error status or contact .decimal customer support for further assistance.//+  - Select the file(s) you wish to order.   **NOTE:** //Files must have a status of "**Ready to Order**" in order to finalize and place the order. If this is not the case, follow the guideline of the [[direct:userguide#order_error_statuses|error status below]] or contact .decimal customer support for further assistance.//
   - Read the Terms and Conditions (By placing an order you are acknowledging your agreement to the terms and conditions).   - Read the Terms and Conditions (By placing an order you are acknowledging your agreement to the terms and conditions).
   - Click the "**Place Order**" button.<imgcaption direct_user_guide_6|Placing an order>{{ :direct:place_order.png?direct&500 |}}</imgcaption>   - Click the "**Place Order**" button.<imgcaption direct_user_guide_6|Placing an order>{{ :direct:place_order.png?direct&500 |}}</imgcaption>
   - A progress UI will be displayed until the order has been finalized.   - A progress UI will be displayed until the order has been finalized.
 +
 +
 +=== Order Error Statuses ===
 +
 +Devices uploaded to Direct for ordering can sometimes hit an error. Typically this is the result of a configuration change or an issue .decimal staff must address. See below for a list of each status and a description and solution for how to resolve the error status:
 +
 +  - **Ready to Order**: This status is not an error status and means the device is able to be ordered as uploaded
 +  - **Order Placed / Ordering**: This is an internal status for .decimal order processing and should not be seen for more than a second or two. If you see your order stuck with this status there may be an internal issue on .decimal's side.
 +    * Solution: If you see your order stuck with this status for more than 10 seconds please contact .decimal customer support.
 +  - **Duplicate of Record in Holding Queue**: There are multiple copies of the same device uploaded in Direct
 +    * Solution: Remove the duplicate device and click the 'Refresh' button to re-process your orders in the holding queue.
 +  - **Duplicate of Job #<serial number>**: The device uploaded has already been ordered.
 +    * Solution: Delete the uploaded duplicate device or contact .decimal to allow ordering of the duplicate order if you need the duplicate device ordered
 +  - **Unknown Machine Name**: The treatment machine selected when generating this order does not exist in the machine setups .decimal maintains for your site. This is normally due to a incomplete new customer setup or a change within your facility in machine name. .decimal keeps your machine setups synchronized with your physical site to ensure there are no configuration issues that would lead to a delay of your device being used for treatment.
 +    * Solution: Contact .decimal customer support to address the missing machine from your machine setups.
 +  - **Unknown Machine Setup**: The treatment machine selected when generating this order does not match the machine setups .decimal maintains for your site. .decimal keeps your machine setups synchronized with your physical site to ensure there are no configuration issues that would lead to a delay of your device being used for treatment.
 +    * Solution: Contact .decimal customer support to address the incorrect machine setup
 +  - **Machine type mismatch**: The manufacture (e.g.: Varian, Siemens, or Elekta) of the treatment machine selected when generating your order does not match the manufacturer of the machine within the machine setups .decimal maintains for your site. This could cause the ordered device to be manufactured incorrectly.
 +    * Solution: Contact .decimal customer support to address the incorrect machine setup
 +  - **Error: Invalid p.d version for Electron Apertures**: The Electron Aperture was ordered using a p.d version prior to p.d 5.
 +    * Solution: Use p.d 5 or later to generate and place the order or contact .decimal customer support to update your p.d version.
 +  - **Error: <error> -- Line <#>**: This is a generic error to catch problems with the device order file meta data. The <error> and <#> will be populated with the exact error and line number of the order meta data causing a problem.
 +    * Solution: You can attempt to address the issue with your order file if you are aware of the problem, but in most circumstances contacting .decimal customer support will be necessary. 
 +
 ===== Viewing Job Status and Tracking an Order ===== ===== Viewing Job Status and Tracking an Order =====
  
Line 224: Line 248:
 These fields are required for all new users and you will be unable to continue adding the new user until they are filled out. These fields are required for all new users and you will be unable to continue adding the new user until they are filled out.
  
 +<WRAP center round info 60%>
 **NOTE:** //Site managers should only invite and add users to their .decimal site for employees of their treatment facility that intended to use .decimal software. This limits the number of user that potentially have access to order history data and .decimal applications that may contain patient data. Abusing the user invitation system is a violation of the .decimal Terms of Service and could result in account suspension.// **NOTE:** //Site managers should only invite and add users to their .decimal site for employees of their treatment facility that intended to use .decimal software. This limits the number of user that potentially have access to order history data and .decimal applications that may contain patient data. Abusing the user invitation system is a violation of the .decimal Terms of Service and could result in account suspension.//
 +</WRAP>
  
-Newly invited users will be sent an invitation email. If the email needs to be resent for any reason, the invitation can be reset from the edit user dialog.+Newly invited users will be sent an invitation email. If the email needs to be resent for any reason, the invitation can be reset from the edit user dialog. If users are not receiving the email invitation: 
 +  - Ensure the email address for the user is correct 
 +  - Ensure the email is not being sent to the user's spam folder 
 +  - Refer to the [[direct:userguide#site_management_issues|Site Management Troubleshooting]] guide for users not receiving decimal direct email invitations
  
 <imgcaption direct_user_guide_22|User Invite>{{ :direct:user_management_invite_new_user.png?direct&400 |}}</imgcaption> <imgcaption direct_user_guide_22|User Invite>{{ :direct:user_management_invite_new_user.png?direct&400 |}}</imgcaption>
Line 233: Line 262:
 You can also use this page to manage your existing users, for example if you wish to update the user information for any of your users you can simply select the "**Edit**" option for that user. You can also use this page to manage your existing users, for example if you wish to update the user information for any of your users you can simply select the "**Edit**" option for that user.
 You will see the fields you are available to update for this user displayed, and when you are finished updating the user simply "**save**" your changes and you will be taken back to the manage page. You will see the fields you are available to update for this user displayed, and when you are finished updating the user simply "**save**" your changes and you will be taken back to the manage page.
 +
 +=== User Permission Levels ===
 +
 You can also edit the permissions granted to this user from the following options: You can also edit the permissions granted to this user from the following options:
-  * **Physics:**The highest level of user permissions, generally allows for managing site configurations, access to sandbox versions, plan approvals ect... +  * **Elevated:**The highest level of user permissions, generally allows for managing machines, site configurations, access to sandbox versions, plan approvals ect... 
-  * **Research:** Allows the usage of additionally functions in .decimal applications that are not restricted to physics level users. +  * **General:** The lowest level and most commonly used of the user permissions allows for standard usage of .decimal applications. 
-  * **Default:** The lowest level and most commonly used of the user permissions allows for standard usage of .decimal applications.+
 More app specific definitions of what these permissions mean can me found in the application's help documents: More app specific definitions of what these permissions mean can me found in the application's help documents:
-  * decimal Electron RT: [[https://apps.dotdecimal.com/doku.php?id=electronrt:instructions_for_use:instructions_for_use#account_permissions|ElectronRT user guide]] +  * **p.d**: Refer to the local p.d client user guide installed with your application. 
-  * decimal Launcher: [[https://apps.dotdecimal.com/doku.php?id=decimalauncher:decimallauncher#sandbox_modes|Launcher user guide]] +  * **decimal Electron RT**: [[https://apps.dotdecimal.com/doku.php?id=electronrt:instructions_for_use:instructions_for_use#account_permissions|ElectronRT user guide]] 
-  * decimal3D: [[https://apps.dotdecimal.com/doku.php?id=decimal3d:userguide:userguide|decimal3D user guide]]+  * **decimal Launcher**: [[https://apps.dotdecimal.com/doku.php?id=decimalauncher:decimallauncher#sandbox_modes|Launcher user guide]] 
 +  * **decimal3D**: [[https://apps.dotdecimal.com/doku.php?id=decimal3d:userguide:userguide|decimal3D user guide]]
 **NOTE:** //Users can only have one level of permission granted to them at one time.// **NOTE:** //Users can only have one level of permission granted to them at one time.//
  
Line 269: Line 302:
 ==== App Specific Permissions ==== ==== App Specific Permissions ====
  
-Some decimal applications have permissions that can be changed, either site wide, or on a user-by-user basis. These permissions can be seen in the "**App Permissions**" tab. Site wide permissions are shown at the top, and user permissions are underneath. Clicking on a user will show or hide the permissions applied to them. The checkbox to the right indicates whether a permission is enabled.+Some .decimal applications have permissions that can be changed, either site wide for all users, or on a single user-by-user basis. These permissions can be seen in the "**App Permissions**" tab. Site wide permissions are shown at the top, and user permissions are underneath. Clicking on a user will show or hide the permissions applied to them. The checkbox to the right indicates whether a permission is enabled. Permissions noted as "*managed by .decimal" can not be changed by users and must be changed by .decimal staff (e.g.: this is a separate purchased license). 
 + 
 +The .decimal Applications with app specific permissions include: 
 +  * **p.d**:  
 +    * For p.d's available application permissions please refer to the p.d user guide installed with your p.d software for your specific version of p.d. Note: the available permissions are also dependent on the application version of p.d you are using. 
 +  * **decimal eRT**:  
 +    * eRT's application permissions can be found on the [[electronrt:instructions_for_use:instructions_for_use#account_permissions|Account Permission's user guide page]]. Note: the available permissions are also dependent on the application version of decimal eRT you are using. 
 + 
 +An example of the application permissions are shown below (note, these permissions may differ from what you see in Direct and have available in your local version of your applications).
  
 <imgcaption direct_user_guide_26|App permissions>{{ :direct:app_permissions.png?direct&600 |}}</imgcaption> <imgcaption direct_user_guide_26|App permissions>{{ :direct:app_permissions.png?direct&600 |}}</imgcaption>
Line 275: Line 316:
 To modify the permissions, click the edit button. This will allow the permission boxes to be checked and unchecked, with the exception of permissions managed by .decimal. Remember to click "**Save**" when your changes are complete, or "**Cancel**" to discard them. To modify the permissions, click the edit button. This will allow the permission boxes to be checked and unchecked, with the exception of permissions managed by .decimal. Remember to click "**Save**" when your changes are complete, or "**Cancel**" to discard them.
  
-<imgcaption direct_user_guide_27|App permissions (editting))>{{ :direct:app_permissions.png?direct&600 |}}</imgcaption>+==== Site Wide Email Notifications ==== 
 + 
 +While each individual user can manage their own email notification settings as described in the section above, as a site manager you can also control a secondary list of email addresses to receive notifications regardless of which user in your site orders a part. 
 + 
 +<imgcaption direct_user_guide_30|Site Wide Emails>{{ :direct:site_emails_managment.png?direct&600 |}}</imgcaption> 
 + 
 +As stated a user's personal email settings still apply regardless of what is listed here when they order a part. Meaning, if the Site Emails list is empty but they choose to receive email notifications when their part ships then they will still receive their desired email. 
 + 
 +If you wish to edit this list simply press the "Edit" button and this will open the editing interface. 
 + 
 +<imgcaption direct_user_guide_31|Editing Site Wide Emails>{{ :direct:site_emails_managment_edit.png?direct&600 |}}</imgcaption>  
 + 
 +Pressing the plus icon labeled "Add Email" will allow you to add any number of emails to this list. When adding a new email to the list you will see the following:  
 + 
 +<imgcaption direct_user_guide_32|Site Wide Emails>{{ :direct:site_emails_managment_edit2.png?direct&600 |}}</imgcaption> 
 + 
 + 
 +  - Email Address textbox: where you can enter the email address you will be adding 
 +  - "Send on Order" Check box: If checked this email address will receive a notification when any user in your site submits an order for a part.  
 +  - "Send on Shipped" Check box: If checked this email address will receive a notification when a part that was ordered by a user in your site gets shipped from our facility 
 +  - "Save changes" button: Saves all the emails and their settings then disables the editing interface. 
 +  - "Delete" icon: Removes this email from the list
  
 ---- ----
Line 308: Line 370:
 ===== Troubleshooting ===== ===== Troubleshooting =====
  
-==== Unable to Upload a File: ==== +Common issues that users may encounter and ways to resolve the issue. 
- +==== Ordering Issues ====
-If you are having trouble uploading a file to the Direct Holding Queue please step through the following troubleshooting steps:+
  
 +^  Ordering Issues  ^^
 +| Unable to Upload a File | If you are having trouble uploading a file to the Direct Holding Queue please step through the following troubleshooting steps:<WRAP>
   - Check your browser settings to make sure javascript is enabled.   - Check your browser settings to make sure javascript is enabled.
   - Try changing the browser you're using (e.g.: use Microsoft Edge instead of Chrome).   - Try changing the browser you're using (e.g.: use Microsoft Edge instead of Chrome).
-If after trying the above troubleshooting steps you are unable to resolve your issue, please contact .decimal Customer Support at 1-800-255-1613.+If after trying the above troubleshooting steps you are unable to resolve your issue, please contact .decimal Customer Support at 1-800-255-1613.</WRAP>| 
 + 
 +==== Site Management Issues ==== 
 + 
 +^  Site Management Issues  ^^ 
 +| Users not receiving account invitation email | IT security protocols may include filters that block invitation emails. Please ensure the domain ''dotdecimal.com'' is added as an allowed sender to bypass your spam/inbox filtering rules. | 
 + 
 + 
 +----
  
 ===== Terms and Conditions ===== ===== Terms and Conditions =====
direct/userguide.1662739858.txt.gz · Last modified: 2022/09/09 16:10 by dpatenaude