Cloverleaf Education Webinar Debugging your translations with the Cloverleaf Translate Debugger

Transcription

1 Cloverleaf Education Webinar Debugging your translations with the Cloverleaf Translate Debugger 1

2 Speaker Rick Carruth Education Program Manager, Infor Rick Carruth is an Education Product Manager for the Infor Global Education team. Over the past 18 years, Rick has held a variety of positions in professional education from technical writer and technical trainer to education manager and now education product manager. Rick is responsible for guiding education strategy from inception through delivery for multiple Infor products. His goal is to meet the needs of education stakeholders whether customers, employees, or partners. 2 2

3 Before we start 3 3

4 Upcoming Cloverleaf Courses Cloverleaf: Developing Cloverleaf Networks - Advanced Dates: May Cloverleaf: Developing Cloverleaf Networks - Basics Dates: May Cloverleaf: Programming with Tool Command Language (Tcl) Dates: June 4 8 Cloverleaf: Developing Cloverleaf Networks - Basics Dates: June

5 New Cloverleaf track at Infor TechEd covering: Web Services FHIR APIs New Distributed Transaction Controller Larger interoperability strategy April 10-12, 2018 Las Vegas 5

6 Speaker James Danley Learning Consultant, Infor James Danley is a Learning Consultant, Principal with more than 20 years of experience in the healthcare industry, including 20 years in the healthcare information technology industry. James has worked in Cloverleaf support, implementation, and education. James has additional experience in telecommunications, network, server, and desktop administration and support. 6 6

7 Scenario For users who require detailed information when developing and troubleshooting translations, giving the ability to observe the run-time behavior of the translation process and to locate logic errors and addresses. 7

8 Topics for Translation Debugger Debug controls Continue, Pause, Stop, Restart, Step, Run to Action Modes Configuration, Debug Breakpoints actions Set, Remove, Enable, Disable Debug panel Breakpoints, Variables, Expressions, Input Values, Console Source Message, Target Message 8

9 Translation Debugger example A user is developing an interface for a new downstream system. The downstream is not receiving the data in a specific field of an HL7 v2 message. The translation has several IF and ITERATE conditions. To debug, the user sets breakpoints in key areas in the translation to step through his logic and correct the issue. Translation files are stored in HCISITEDIR/Xlate 9

10 Translation Toolbar Open Debug Test Cut Paste Before Delete New Save Debug with Configuration Copy Paste Append Paste After Switch Mode 10

11 Three ways to go through Debugger Place break points into the translation Step through each action in the translation Run to Action in the translation Use continue to step through each break point Use step to step through translation Use RUN to Action to step through translation 11

12 Translation Debug controls Debug control buttons are located on the Translation Action bar and the Debug menu. CONCAT ITERATE STRING BULK COPY CALL DATE COPY OPT SEND BREAK Continue Stop Step COPY TABLE MATH COMMENT PATH COPY CONTINUE IF SUPPRESS INCLUDE Pause Restart Run to Action 12

13 Debug control buttons Button Name Continue Pause Stop Restart Step Run to Action Description Makes the debugger continue to run and break at the next breakpoint. Once the debugger breaks at the next breakpoint, the Pause icon will move to that breakpoint. Makes the debugger break from the current message translation. Since the debugger will not stop at the point it receives the Pause signal, but halt at the next valid action (a top level translation action, if the current action does not have any sub-actions, or the next sub-action that is inside a current translation action), the debugger will move the Pause icon to that next valid action. Terminates the debugger. Once the debugger is terminated, all debug control buttons are disabled. Stops the debugging and restarts from the beginning. Executes the current action and breaks at the next action. Causes the debugger to run to the first selected action. If there is any breakpoint before that selected action, the breakpoint will be bypassed. 13

14 Debug control buttons, continued Button Name Set Breakpoint Remove Breakpoint Enable Breakpoint Disable Breakpoint Description Breakpoint to the selected action Remove the breakpoint Enable Breakpoint that was disabled. Disable Breakpoint of the selected 14

15 Breakpoints 15

16 Debug panel The Debug panel displays debugging information For example, input values, user-defined temporary variables, iterate variable values. The panel contains these views that are shown as tabs: Breakpoints Variables Expressions Input Values Console Source Message Target Message 16

17 Debug views 17

18 Breakpoints view Lists all breakpoints in the current debugging session In this view you can: Remove the marked breakpoints Enable all breakpoints Disable all breakpoints 18

19 Breakpoints view, continued Remove the marked breakpoints Remove all breakpoints Enable all breakpoints Disable all breakpoints Selected breakpoints Unselected breakpoints 19

20 Variables view Shows the values for the current user-defined temporary variables and the ITERATE variables in a table. The Name column lists the variable names. The Value column shows the corresponding values. Right-click in a Name or Value field to open a drop-down of "@vars.a" Note: The value of system temporary variables and ITERATE variables cannot be modified. The value cell is not editable for these two types. The context menu for system temporary variables is available in the Variables view. 20

21 Variables view, continued 21

22 Expressions view For inspecting the values of specified address paths, temporary variables, or ITERATE variables. Clicking Add watch expression creates a new empty row. Double-clicking in a cell opens it for editing, where you can specify an address path, temporary variable name, or ITERATE variable name into the cell. When you press Enter, the GUI send a request to the debugger for the value of the nonempty expression. The response is displayed in Value. Add a tilde (~) before the path address to inspect the value of the address path of output message. The Value cell is the same as the Variables view, and is editable except for system temporary variables and ITERATE variables. 22

23 Expressions view, continued Dragging/Dropping tree nodes To simplify specifying an address path, add the corresponding path of the tree node as a watch expression by dragging an address and dropping it into the Expression table. Note: You must first add a new row by clicking Add watch expression, then you can drag an address into the cell. A tree node can be dropped into any editable text box. In a debugging session, if a tree node is dropped into a table, the GUI sends a request directly to the debugger and the value is shown. There is no need press Enter. If you are dropping an address node into a cell in editable mode, you must press Enter to get the value. 23

24 Expressions view, continued 24

25 Input Values view Displays the input values for the currently paused xlate action Double-clicking a Value cell makes it editable, where you can modify the value. The modification becomes effective when you press Enter. Note: The Name cell is not editable. 25

26 Console view Displays what is printed to the standard output and standard error by the command line hcixlttest. When an error is encountered, detailed information is shown in Console view. In this situation, stay in the Xlate Debugger after the debugging session has finished and check the Console view for information. To do a search, input a keyword into the text field on the toolbar and click Search. The item that matches the search string will be highlighted. Click Clear the console to clear the panel. 26

27 Console view, continued Clear the console Text field Search Console view Highlighted match 27

28 Source Message view Displays the encoded input message at the specified Detail level Although there may be multiple input messages in the translation, this view only displays the current message in execution. The user can change the configured detail level by switching the selection in Detail Level combo box. Once the detail level is changed, the displayed source message would be changed to the corresponding detail level. After launching the Xlate Debugger, the detail level used in the Source/Target Message view is the same as the setting in the Xlate Debug Configuration dialog box. By default, the detail level is 1 in the Xlate Debug Configuration dialog box. 28

29 Source Message view, continued To do a search, input a keyword into the text field on the toolbar and click Search. The item that matches the search string will be highlighted. The text field used to show the source message is not editable. Note: Search criteria are case insensitive and substring match. 29

30 Source Message view, continued Detail level Text field Search 30

31 Source Message view, continued Detail level Text field Search 31

32 Target Message view Displays the partially completed target message at the specified Detail level Click Refresh target message to retrieve the latest target message. To do a search, input a keyword into the text field on the toolbar and click Search. The item that matches the search string will be highlighted. The text field used to display the partial target message is not editable. The target message can be automatically or manually refreshed (default). Click Refresh target message to manually refresh. Note: Have the target message to auto update by changing in Client Preferences, selecting Automatically refresh the target message during xlate debugging. Also, This option is also located in client.ini: xlt_debug_auto_refresh_target_msg=true/false 32

33 Target Message view, continued Automatically refresh the target message during xlate debugging 33

34 Target Message view, continued Refresh target message Detail level Text field Search 34

35 Debug information Debug information is saved on the Client side as: <user.home>/.clide/xlate/<hostname>_<version>_<sitename>_<xlt file>.debug This file is saved as the sectioned ini: [configuration] msg_file_name= msg_file_style= msg_file_encoding= source_msg_detail_level=0/1/2/3 target_msg_detail_level=0/1/2/3 record_num=1/all show_field_name=true/false detect_leak=true/false separator_opt= save_file_name= save_file_style= pretps= posttps= [breakpoint] index= status= [expression] expression=address1 address2 temporary1 temporary2 35

36 Questions? 36 36