Steps for Running the System Diagnostic Wizard
To run the System Diagnostic Wizard, complete the following steps:
- Select the System Diagnostic Wizard icon from the Actions section>System card.
The first screen of the wizard is shown.
- Indicate Yes or No to the question Has a Troubleshooting Checklist been completed for this issue?
Indicates whether the Troubleshooting Checklist has been completed for this issue (Yes/No). The checklist can be accessed from the Informational Message box at the top of the screen.
- If the answer is No, click on the link in the Informational Messages box to access and complete this checklist.
- If the answer is Yes, click on the Next button in the left pane.
- Enter a Code to identify this issue. This code is included in the name of the file created (see step 16).
Short, alphanumeric description of the issue, used to identify the issue when referencing the xml file and other elements of the process.
- Select Yes or No to answer the question Does a Case exist for this issue?
Indicates whether there is an existing Customer Service case created for this issue (Yes/No). If this field is set to Yes, the Case Number field is enabled.
- If the answer to step 4 is Yes, the Case Number field is enabled. Enter the case number given by the API Healthcare customer service representative.
The Customer Service case number relating to this issue. This field is only enabled when the "Does a Case exist for this issue?" field is set to Yes.
- From the Field Look Up Values, select the File Share Name where the file created by this wizard should be located. Note: If there is only one file share designated as System Diagnostic, this field is not visible.
The name of an existing File Share location, where this record should be created. This field defaults to the first file share with a category as System Diagnostic, but can be changed. Note: This box is only displayed when more than one File Share exists with a category of System Diagnostic.
More About File Patterns
The following Reserved Characters are used with Regular Expression Searches:
.
|
This symbol indicates a single character preceding the value entered in the field. When using other regular expressions indicating preceding characters, this symbol must also be used.
|
*
|
This symbol indicates a wild card for any number of previous characters. For example, .*RN would display all records that contain RN within the field value.
|
$
|
This symbol is used to indicate the ending value of a string, or an EXACT MATCH. When the symbol is placed after a value, there cannot be any other characters after the field value. For example, D$ indicates the value must end with D. Since there are no wild card symbols in front of D, this indicates an exact match.
|
^
|
This symbol is used to indicate the beginning value of a string. This can be used with a search string combining other reserved characters.
|
|
|
This symbol works like an OR operator. For example, hi|hello matches a string that has either "hi" or "hello" in it.
|
Combining Multiple Symbols in an Advanced Search Expression:
Multiple symbols can be combined to indicate a regular expression with different variables. For example, entering *.Manager$ will display all records that begin with any characters, but must end with Manager. The previous character symbol (.) and wild card symbol (*) at the beginning of the expression indicate any number of characters can be in front of the word Manager. The ending symbol ($) in the expression indicates the value must end with the word Manager.
Sample file patterns for the examples above:
Example #1
Files found in Download File Share:
OrgUnit.txt
JobClass.txt
Position.txt
Employee.txt
File Pattern:
Branch Org Unit Download = ^Org (will match OrgUnit.txt)
Job Class Download = ^Job (will match JobClass.txt)
Position Download = ^Pos (will match Position.txt)
Employee Download = ^Emp (will match Employee.txt)
Example #2
Files found in Download File Share:
OrgUnit.txt
EmpNorthFac.txt
EmpSouthFac.api
File Patterns:
Branch Org Unit Download = ^Org (OrgUnit.txt)
Employee Download = ^Emp (will match EmpNorthFac.txt & EmpSouthFac.api)
- Select Yes or No to answer the question Is this issue related to a recent Work Order?
Indicates whether this issue is related to a previously installed Work Order (Yes/No). If this field is set to Yes, the Work Order Number field is enabled.
- If the answer to step 7 is Yes, the Work Order Number field is enabled. Enter the number of the related work order.
The Work Order number relating to this issue. This field is only enabled when the "Is this issue related to a recent Work Order?" field is set to Yes.
- Select the level of Urgency of this issue from the drop down menu (i.e. Low, Normal, or High).
Indicates the level of urgency of this issue (i.e. Low, Normal, or High).
- Click on the Next button.
- In the first free-form text field, enter information in the field; Please enter a detailed description of the problem. Be sure to include all details of the issue.
Free-form text field to enter a detailed explanation of the issue.
- In the second free-form text field, enter information in the field; Please enter a detailed description of the expected results. Include details as to what the user thought should have happened, but did not.
Free-form text field to indicate the results that the user was expecting.
- Click on the Next button. A basic Employee Search screen is displayed.
- Enter criteria to search for the employee record which is causing the issue. If more than one employee record is involved, rerun the search to create a sample set of employee records. Note: Not all employee records involved in the issue need to be forwarded to API Healthcare, only a sampling.
- When finished selecting the employee records, click on the Finish button.
- If the Event Subscriptions for this wizard have been configured, a message is sent to you indicating whether the file was successfully created. Depending on the notification method selected, this notification is by email or is displayed on the My Unread Messages section of the Home page in the portal (or both).
- With a successful entry, a Request Object Message is sent to the Application Server for the diagnostic request. The message is routed to the agent and a calculations diagnostic process is run.
The process results in the following files being created and placed in the Repository:
- CalculationsDiagnostic.dmp
- TaskReceiptReport.pdg
- Time Card Report PDF for each employee selected in the System Diagnostics Wizard
- A request is then sent to the File Share Server to Transfer the files in the Repository to a File Share Location.
- The directory is File Share Path\ClientCode\Date (in YYYYMMDD format)\IssueIdentifierDescription. For example when the client with a Client Code of ABCD123 reports a problem on February 12, 2017 with an Issue Identifier Description of “ENelsonError”, the directory used on the FTP site is Root Path\ ABCD123\20041110\ENelsonError.
- The File Share Path should point to the SystemDiagnostic folder on the API Healthcare FTP site.
The following fields are available when running the System Diagnostic Wizard:
Has a Troubleshooting Checklist been completed for this issue?*
Indicates whether the Troubleshooting Checklist has been completed for this issue (Yes/No). The checklist can be accessed from the Informational Message box at the top of the screen.
Code
Short, alphanumeric description of the issue, used to identify the issue when referencing the xml file and other elements of the process.
Does a Case exist for this issue?
Indicates whether there is an existing Customer Service case created for this issue (Yes/No). If this field is set to Yes, the Case Number field is enabled.
Case Number
The Customer Service case number relating to this issue. This field is only enabled when the "Does a Case exist for this issue?" field is set to Yes.
File Share Name
The name of an existing File Share location, where this record should be created. This field defaults to the first file share with a category as System Diagnostic, but can be changed. Note: This box is only displayed when more than one File Share exists with a category of System Diagnostic.
More About File Patterns
The following Reserved Characters are used with Regular Expression Searches:
.
|
This symbol indicates a single character preceding the value entered in the field. When using other regular expressions indicating preceding characters, this symbol must also be used.
|
*
|
This symbol indicates a wild card for any number of previous characters. For example, .*RN would display all records that contain RN within the field value.
|
$
|
This symbol is used to indicate the ending value of a string, or an EXACT MATCH. When the symbol is placed after a value, there cannot be any other characters after the field value. For example, D$ indicates the value must end with D. Since there are no wild card symbols in front of D, this indicates an exact match.
|
^
|
This symbol is used to indicate the beginning value of a string. This can be used with a search string combining other reserved characters.
|
|
|
This symbol works like an OR operator. For example, hi|hello matches a string that has either "hi" or "hello" in it.
|
Combining Multiple Symbols in an Advanced Search Expression:
Multiple symbols can be combined to indicate a regular expression with different variables. For example, entering *.Manager$ will display all records that begin with any characters, but must end with Manager. The previous character symbol (.) and wild card symbol (*) at the beginning of the expression indicate any number of characters can be in front of the word Manager. The ending symbol ($) in the expression indicates the value must end with the word Manager.
Sample file patterns for the examples above:
Example #1
Files found in Download File Share:
OrgUnit.txt
JobClass.txt
Position.txt
Employee.txt
File Pattern:
Branch Org Unit Download = ^Org (will match OrgUnit.txt)
Job Class Download = ^Job (will match JobClass.txt)
Position Download = ^Pos (will match Position.txt)
Employee Download = ^Emp (will match Employee.txt)
Example #2
Files found in Download File Share:
OrgUnit.txt
EmpNorthFac.txt
EmpSouthFac.api
File Patterns:
Branch Org Unit Download = ^Org (OrgUnit.txt)
Employee Download = ^Emp (will match EmpNorthFac.txt & EmpSouthFac.api)
Is this issue related to a recent Work Order?
Indicates whether this issue is related to a previously installed Work Order (Yes/No). If this field is set to Yes, the Work Order Number field is enabled.
Work Order Number
The Work Order number relating to this issue. This field is only enabled when the "Is this issue related to a recent Work Order?" field is set to Yes.
Importance
Indicates the level of urgency of this issue (i.e. Low, Normal, or High).
Please enter a detailed description of the problem
Free-form text field to enter a detailed explanation of the issue.
Please enter a detailed description of the expected results
Free-form text field to indicate the results that the user was expecting.