Screen Entity Example - Editable Lists

In this example, we will create a screen entity with a list of records that are editable.  In the Master/Detail Screen example, the CONTACTS block was also created as an editable list in the CUSTOMER_ACTIVITY screen.

1. Select the Group Information object.  Expand it, and select the group to which you wish to add the new screen entity.

2. Right click on the group and select Create->Entity.
   

3. Click on the Screen bullet.
   

4. Click on the Next button at the bottom right of the screen.

5. In the Entity Name property, type TERRITORIES as the entity name.

6. Leave the Datasource property set to (use default), since there is only one datasource for the Xephr install.

7. In the Based On property, select SCREEN_TEMPLATE, which is the template that we created earlier.

8. Leave the Default Mode property set to QBE View.   

9. Leave the Body Style, Editable Field Style, Non-Editable Field Style, Lov Style and Link Style properties set to (from parent), as these styles will be taken from the SCREEN_TEMPLATE for this screen.
   

10. Click on the Next button at the bottom of the screen.

11. In the Block Name property, enter TERRITORY as the name of the block.

12. In the Block Type property, select Standard Block.

13. Set the Query Type property to Simple Query.

14. Leave the Datasource property set to (use parent).

15. In the Table property, select the name of the table or view from which the data will be obtained.  Since our datasource is set to use the Oracle 9i database for NDS Applications, we will select the view TERRITORY_CODE_UVW.

16. Set the Create Heading checkbox to on to indicate that a heading should be created for each mode for this block.

17. In the Mode Selection section, set the QBE and List checkboxes to on..  We will be creating 2 blocks for this screen.  
    
    The first block is the query block for the QBE and List screens, which allows users to query territories.  
    The second block is the List block, which displays a list of territories based on the entries on the query block.

18. In the Scheme Selection section, leave the Form bullet set to on, since this is the main block, and we will be viewing one record at a time.
    

19. Click on the Next button at the bottom right of the screen.

20. The Adding Fields screen is displayed.  Select the columns that you wish to include on the screen.

21. Click on the Field label and the Label label at the top of the columns to select all columns:
    

22. Left click on the ORG_UNIT_ID column to set all the flags to off for this field, since we will not be displaying it on the query block.

23. A key must be selected to continue.  Set the Key checkbox to on for the ORG_UNIT_ID field and the TERRITORY field as they are the keys to this view.

24. Since this block is not returning data from the database, we do not need to make entries in the Filters or Ordering and Grouping fields for this block.
    

23. Click on the Next button at to the bottom of the screen.

24. The Ordering Fields screen is displayed next.  The columns are initially ordered as they were listed on the previous screen.  To move a field up or down, highlight the desired field by selecting it, and click on the Move Up or Move Down buttons on the right of the screen.  Move the fields until they are in the following order:
    TERRITORY
    DESCRIPTION
    LOCAL_FLAG
    ORG_UNIT_ID
    

25. Click on the Next button at the bottom of the screen to continue.

26. The Option to Add More screen is displayed.  We need to create the List block next.  Set the Add Block or Labels checkbox to on.  The entity in its current form will be displayed.  
    

27. Since we are adding the next block to the main screen entity, select the TERRITORIES entity.

28. Click on the Add Block button at the bottom right of the screen.
    

29. The List block should be named the same as the query block, because the ExecuteQbe() javascript command that takes us from query mode to list mode and restricts the data displayed in the list mode to that which meets the criteria on the query screen requires it.

30. In the Block Name property, enter TERRITORY as the name of the block.

31. In the Block Type property, select Standard Block.

32. Set the Query Type property to Simple Query.

33. Leave the Datasource property set to (use parent).

34. In the Table property, select the name of the table or view from which the data will be obtained.  Since our datasource is set to use the Oracle 9i database for NDS Applications, we will select the view TERRITORY_CODE_UVW.

35. Set the Create Heading checkbox to on to indicate that a heading should be created for each mode for this block.

36. In the Mode Selection section, set the QBE checkbox to off and the List checkbox to on, as we are creating the block to list the data returned from the database.

37. In the Scheme Selection section, set the List bullet to on, since multiple records are being returned to this screen and we wish to have the labels displayed at the top of the screen and the fields displayed below them.
    

38. Click on the Next button at the bottom right of the screen.

39. The Adding Fields screen is displayed.  Select the columns that you wish to include on the screen.

40. Click on the Field label and the Label label at the top of the columns to select all columns:
    

41. Left click on the ORG_UNIT_ID column to set all the flags to off for this field, since we will not be displaying it on the list block.

42. A key must be selected to continue.  Set the Key checkbox to on for the ORG_UNIT_ID field and the TERRITORY field as they are the keys to this view.

43. In the Filters property, you could enter code to restrict the data returned from the table.  We only want to view territory records for the user's logged in enterprise, so enter the following filter:
    
    where org_unit_id = $$ORG_UNIT_ID$$

44. In the Ordering and Grouping property, you can enter code to determine the order in which the data is displayed in the screen.  We want the territories to be listed in alphabetical order by territory code, so the following should be entered:
    
    order by territory
    

45. Click on the Next button at to the bottom of the screen.

46. The Ordering Fields screen is displayed next.  The columns are initially ordered as they were listed on the previous screen.  To move a field up or down, highlight the desired field by selecting it, and click on the Move Up or Move Down buttons on the right of the screen.  Move the fields until they are in the following order:
    ORG_UNIT_ID
    TERRITORY
    DESCRIPTION
    LOCAL_FLAG
    

47. Click on the Next button at the bottom of the screen to continue.

48. The Option to Add More screen is displayed.  We have no more blocks to create.  Click on the Finish button at the bottom of the screen.
    

49. The new entity is added to the initially selected group.  In the Explorer Tree, the new entity will be displayed, expanded with all blocks shown.
    

50. Click on the Save button in the main toolbar to save the new screen entity.

51. Right click on the TERRITORIES entity and select Designer Frame from the menu.
    

52. Within the Designer Tool, you can move, align, and resize the objects.  For specific instructions on the Designer Tool and its functionality, see the Designer Tool section.

53. When the Designer Tool is displayed, expand it so that you can see the entire entity.  The Designer Tool displays the default mode of the entity selected.  The pop-list in the upper right of the Designer Tool indicates that we are viewing the lay out of the QBE View.
    

54. Left click on the field that displays the word TERRITORY to select it and double click to display the property sheet.  This is the HEADING field for the QBE screen.

55. In the Contents property, enter the text Search Territory Codes.
    

56. The TERRITORY field needs to be uppercase.  Left click on the field that displays the word TER... and double click to display the property sheet.

57. Set the Text Case property to Uppercase.
    

58. The LOCAL_FLAG field needs to be set as a checkbox field instead.  Left click on the field that displays the word LOCAL_FLAG and double click to display the property sheet.

59. Set the Displays As property to Checkbox.

60. In the YES Value property, enter Y.

61. In the NO Value property, enter N.
    

62. Click on the Save button in the main toolbar to save the changes.

63. You have completed the changes for this screen in QBE Mode.  Now we will move onto List Mode.

64. In the pop-list in the upper right corner of the Designer Tool, select List View.
    

65. We need to modify the LEFT_MENU block to remove the link to the New screen, since we have no New mode for this screen.  Also, since the list screen is an editable list, meaning it allows records to be inserted and updated, we need to add the Save link.

66. In the Explorer Tree, expand the LEFT_MENU block and left click on the SAVE field to select it.  Double click to display the property sheet.

67. Set the On List property to true.
    

68. Left click on the NEW field to select it and display the property sheet.

69. Set the On QBE, On List, and On Edit flags to false for this field.
    

70. On the Designer Tool, you can see the newly added Save link.
    

71. Left click on the field that displays the word TERRITORY_HEADER to select it and double click to display the property sheet.  This is the HEADING field for the List screen.

72. In the Contents property, enter the text Maintain Territory Codes.
    

73. The LOCAL_FLAG field needs to be set as a checkbox.  Left click on the field that displays LOCAL_FLAG and double click to display the property sheet.

74. In the Default Value field, enter N.  We want this field to default to N if no entry is made for a new record.

75. Set the Displays As property to Checkbox.

76. In the YES Value property, enter Y.

77. In the NO Value property, enter N.
    

78. The Territory, Description, TERRITORY, and DESCRIPTION fields need to be made larger and marked as required.  Also, the TERRITORY field needs to be upper case.

79. In order to make sure that there is enough room to make the fields larger, we need to move the other fields to the right.  Move the fields around until they look like this:
    

80. Drag the edges of fields until they look like this.  You are doing this for the Territory, Description, TERRITORY, and DESCRIPTION fields:
    

81. Left click on the TERRITORY field and double click to display the property sheet.

82. Set the Required property to true.

83. In the Tool Tip property, enter Territory.

84. Set the Text Case property to Uppercase.
    

85. Left click on the DESCRIPTION field and double click to display the property sheet.

86. Set the Required property to true.

87. Set the Tool Tip property to Description.
    

88. Click on the Save button in the main toolbar to save the changes.

89. In the Explorer Tree, we need to modify the ORG_UNIT_ID field to have a default value.  We want it to be filled in automatically with the user's org unit id .  Left click on the ORG_UNIT_ID field and display the property sheet.

90. In the Default Value field, enter $$ORG_UNIT_ID$$.
    

91. We need to set up the list block to allow the entry of new records.

92. Left click on the TERRITORY block and double click to display the property sheet.

93. We only want the editable list to display 50 records, in order to save load time.  In the Max Number of Rows field, enter 50.  
    
    The initial value is 0, which indicates that the default number of 200 will be used.

94. We want the new rows to be displayed at the top of the list, se set the New Rows First property to true.

95. We want two new rows to display.  In the Num New Rows property, enter 2.
    

96. Click on the Save button in the main toolbar to save the changes.

97. To test the new screen entity, highlight it by selecting it, and click on the Run button in the main toolbar.

98. Since a global variable was defined in the Filtering property, you must define the value before the screen is run.  Enter 100 in the value field and press the Run button.
    

99. The screen will be run in the browser.
    
    

Xephr is a registered trademark of NDS Systems, LC.

Copyright © 2007 NDS Systems LC.