This module will attempt to: Discuss Form and List Applets Describe the configuration steps needed to configure List Applets using the List Applet Wizard & Other methods Describe the configuration steps needed to configure Form Applets - Form Applet Wizard & Other
An applet is a data entry form, composed of controls, that occupies some portion of the Siebel application window. An applet can be configured to allow data entry, provide a scrolling table of data rows, or display business graphics, a navigation tree, or a Web browser. It provides viewing, entry, modification, and navigation capabilities for data in one business component. An applet is always associated with a business component. Although the same business component can be associated with multiple applets, an applet is associated with only one business component.
Now let us begin our discussion with a definition of List Applets and Form Applets; A list applet allows simultaneous display of data from multiple records. It presents business component information in a list table format with each record of data represented in a row. In addition to textual data, lists also support images in .jpg and .gif formats and edits control such as check boxes, dropdown lists, noneditable MVGs, and text fields. A form applet presents business component information in a data entry form layout. Users enter data using text boxes, check boxes, buttons, and similar visual constructs known collectively as controls. The fields for the record are displayed in a grid or form therefore more fields can be displayed at any one time in a form applet than a list applet There are numerous other types of applets that Siebel can create including Pick Applets, Multi Value group applets,chart applets associate applets. For a full list of applet types, refer to the Siebel Bookshelf.
Applet behavior is managed by the C++ class specified in the applet’s Class property. This value is typically one of the following four standard classes provided by Siebel: CSSFrame (form applets) CSSFrameList (list applets) CSSFrameTree (tree applets) CSSFrameChart (chart applets) All specialized applet classes are a subclass of one of these four classes. Specialized applet classes are associated with a specialized business component or a BC based on a specialized C++ business component class. Their behavior may depend on the presence of certain fields, and you will receive a run-time error if these fields are not defined. So you want to use one of the two standard classes (CSSFrame and CSSFrameList) for new applets, unless you want to create a new applet based on an existing specialized business component (for example, Action). In this instance, you would use the specialized applet class.
Now just to recap, a list applet is a type of applet that will display one or more records in a list table format. Each row on the list applet represents one record from the business component. There are typically 2 to 4 action control buttons on the list applet and these are usually the “New” control button, the “Save” control button, and the forward and backward scroll control buttons. These will be explained further in the next slide. One important thing to note in List Applets is that it supports drilldown to other views. This can be done by clicking on any of the hyperlinked fields which can be identified as the fields that are displayed in Blue text.
As described in the previous slide, the buttons that are typically found on the list applet are the Next Record and Previous Record control buttons. These buttons allow you to scroll forwards and backwards through the records in the list applet one at a time. The New button, when pressed allows you to create a new record for the list. It performs the same functionality as the CTRL-N function. What you will see when you press the New button is a blank record on the list applet where you can enter data into and create a new record. The Save button, when pressed explicitly saves the record. It is very important to realize that you MUST press the save button to save a record when you are in a customer application, or using the standard interactivity framework. If you fail to press the save button before stepping off a new or modified record, your changes will not be saved and the record will revert back to what it was before your changes. In an employee application or High Interactivity, you can implicitly save the record by stepping off it therefore there is no need to press the Save button to save your changes
Every list applet can have multiple web templates. These web templates are called modes and the typical modes for List Applets are Base, Edit and Edit List modes. We will discuss these modes in greater detail over the next few slides. It is important to note that you should choose the template for your applet based on the desired applet functionality.
The base read-only mode for a web template displays the data only but does not allow the user to edit, query or enter new records Views appear by default in Base mode. An applet that you define on a base mode template does not necessarily have to stay in this mode as you can enable the mode function through buttons or the applet menu. Base mode is mostly used in low-interactivity applications; this generally means customer applications. It can also be used in employee applications, in any places where the ability to add, delete, and edit records should be restricted.
The Edit mode is used in conjunction with base mode to permit creating and editing records. If a user wishes to edit data in edit mode, the user can press the edit button which navigates the user to a different template. In this case, the Edit mode. The Edit mode appears as a form applet and allows a user to enter new records or edit existing records.
The Edit List mode is only available in high-interactivity (generally employee) applications and enables editing as a default. This mode is the most common mode used for all list applets because it allows the user to edit records within the list applet. The Edit List Mode also supports in line record creation which means a new record can be created directly in the list applet. Unlike Customer Applications where a different form template is used for entering information for new records.
Now in order to determine what the default mode of the applet will be in a view, you will need to set the Applet Mode property. This property can be set by doing the following: In the object explorer window, select the View object type Select the view that the applet you wish to set the applet mode property for Select the View template object Then select the View Web Template Items object and tab across to the Applet mode property from where you can set the mode to Base, Edit or Edit List
Now that we understand the makeup of list applets lets discuss how to create a new applet. There are two ways to create an applet: You can either go through the individual steps to creating the applet manually which would require you to create a new object definition and associate the applet template with the applet object definition then you would need to bind controls to the applet. This can be a laborious process which is unnecessary. Siebel 7 provides you with the functionality to use a List Applet Wizard to create an applet which automates all the steps defined above. As this is generally the preferred method, we will describe using the list applet wizard in greater detail in the following slides.
Now there are many benefits to creating a list applet using the list applet wizard as you can see in this slide. Basically the list applet wizard ensures correctness when creating list applets as steps can not be omitted in the process. Human error is always a high risk factor when creating things like list applets and using the list applet wizard reduces this risk. In addition to the reduced risk, productivity can be improved by using the list applet wizard as it automates the process which is always faster than manually stepping through all the required tasks in creating the object. The steps needed to invoke the list applet wizard are as follows: Select File >New Object from the Siebel Tools main menu.The New Object Wizard dialog box will be displayed on the screen You will then need to click the Applets tab, and then double-click the List Applet icon.Now the General page of the List Applet Wizard appears which will be discussed in the next slide.
The first screen that you are prompted with after selecting the List Applet Wizard is the General page and it is displayed above. This screen allows you to enter the project and business component for which the applet will be based on. Only locked projects appear in the picklist. This screen is also where you would enter the name of the new applet. You must note that the applet name must be a unique name that has not already been used by another applet in the system. It is used to refer to the applet when laying out a view. The last thing that you can specify in this screen is the display title for the new applet. This is the name to appear in the user interface and may be left blank if no title is desired. The wizard will use this information to create an applet object and define the required applet properties. Once you have entered all the necessary values in this screen, you can press ‘Next’ to be taken to the next step in the List Applet Wizard.
This next screen in the list applet allows you to enter the Web templates to use for the applet. The presentation of the applet in each mode is determined by the Siebel Web Template. This section asks you to select templates for each type of edit mode for the applet and once you have done that, it associates the template with the applet. Associating a template and an applet in Tools lets the program know which template(s) to use for the applet. Please note that a thumbnail image for many templates appears when you select the template name. Two good techniques for picking a template are to either find an existing applet with a layout similar to what you want, or Select Web Templates in the OE, click a likely-looking template name, right-click, and select View Web Layout. This should be done before you start the wizard. There is a check box just below the list of templates called “Show All Templates”. When checked, all the templates available on the system are displayed. If left unchecked, you will only be able to see the templates that associate to list applets. Once you have selected all the necessary values in this screen, you can press ‘Next’ to be taken to the next step in the List Applet Wizard.
This third screen in the List Applet Wizard displays the Web Applet – Fields screen. This screen in the wizard allows you to choose the business component fields that will appear in the web layout. The way to select the fields is to select the required field from the Available fields list and press the forward arrow button to move the field to the selected fields list. In order to arrange the order of the fields to show in the applet you can use the up and down arrow buttons to the right of the selected fields list. The fields that appear in the Available pane are those fields defined for the business component that you selected in the earlier part of the wizard. It is a good idea here to add all the columns in the business component to the web layout. It is a lot easier to delete them later as necessary rather than having to add them in. This step in the procedure creates the applet web template items and is necessary to bind the controls to the applet. Once you are done selecting your fields and ordering them, you can press the next button to go to the next screen in the wizard.
In the second Web Layout-Fields page, choose the controls in the Available Controls box that you want to appear on the applet. Again the way to select the controls is to select the required controls from the Available controls list and press the forward arrow button to move the control to the selected controls list. In order to arrange the order of the controls to show in the applet you can use the up and down arrow buttons to the right of the selected controls list. The vertical sequence of the controls in this screen of the wizard determines their sequence from left to right in the resulting list applet. It is easier to set the sequence here than reorder them in the Edit Web Layout editor. All the entries in the Selected Controls box are added by default. If you wish to exclude some of the controls and move them to the Available Controls box, select the controls and click the activated arrow.
Something to consider is that the available controls come from the “Model HTML Controls” applet. This applet specifies the available controls and also to which template each control is mapped. Users can modify this applet if necessary by adding or removing controls from the applet. This applet is considered a dummy applet and is not based on any business component.
In the next window you can review the information displayed in the Finish page, and then click Finish. The List Applet Wizard creates the applet and supporting object definitions based on the selections you made. It is important to note that you can return to previous pages and make changes by clicking the Back button.
Once you press the Finish button in the List Applet Wizard, the wizard will automatically create required object definitions for the Applet, the controls, the list and the list column. The wizard will also map all Applet Web Templates and Applet Web Template items. The applet class will be defaulted to the CSSFrame List and the Web Layout Editor will be invoked. There will be no need for you to do any of this manually from here.
Now once the wizard has finished creating the applet you can use the Web Layout Editor to rearrange the layout of list columns or controls as necessary. In order to access the Web Layout Editor you must navigate to the Applet Object Definition in the Object Explorers window and select the applet that the Wizard has just created. Place your cursor on the applet definition and right click on the mouse. The right click functionality will display a menu with a number of different options. You should select Edit Web Layout Editor from here, this will take you to the Web Layout editor where you can add, remove and reorder the columns displayed. In order to add columns and controls, you should drag them from the Controls/Columns toolbar and onto the Web Layout Editor. In order to delete columns or controls you should select what you wish to delete and right click on the mouse and select the delete option.
The applet title is the value in the Title property. It determines what displays in the tab at the upper left of an applet in a view, or in the title bar of a pop-up applet. Follow these general guidelines when creating applet titles: Always specify an applet title. Do not leave this property blank. No two applets in the same view should have the same title. If a view contains multiple applets displaying data from the same business component, distinguish the titles by type. For example, in a list-form view displaying accounts, use distinct titles such as “Account List” and “Account Form.”
A List Column object definition corresponds to one column in the scrolling list table in a list applet, and to one field in the business component. Once you get to this stage in the process you can edit the List Column definition. In order to view all the columns in the list applet you will need to navigate to the Applet object definition in the Object Explorer Window. You should then select the list applet for which you wish to edit the list column definition and then select the list object type for that applet. You can now select the list columns object type for the particular list. This screen displays all the columns on the list and from here you can select each column you wish to modify and set the following properties. You can set the “Display Name” property to set the value to use as the list column heading. The “Read Only” property should be set to a True or False value, an True value prevents data from being edited on the column. Please note here that if the underlying business component field has a property setting of Read Only = True, the list column is also read-only even if the list column’s Read Only property is False. The “Popup Edit” property should also be set to a true or false value. Setting the popup edit property to true specifies that an ordinary text field requires a pop-up edit box. The “Runtime” property can be set to true or false as well and if set to true, a run-time check is made to see if a picklist, calculator, calendar, or MVG pop-up button will be provided. If set to false it is assumed that there is no picklist or MVG or that the field is Date or Time in DateTime and finally the “HTML type” can be changed. The HTML type defines how the list column is to be rendered. If this value is not set, the Type property will be used.
One further definition we wish to discuss is the List Control Definition. It is important that you know that this exists but you should never edit this control. The List Control Definition is created for list applets in order to display the collection of list columns. It can be found in the Applet Object Definition in the Object Explorers window under the Control object type for the applet.
In this example we are creating a new project and associate our new applet to this project, but in real life you can be asked to associate the new Applet to an existing project.
After step 6, you will be prompted to the General Window of the List Applet Wizard.
After selecting the information above, proceed to click the Next button. The Web Layout – General Window is prompted.
After selecting all the information mentioned above, proceed to click the Next button. The Web Layout Fields window will be prompted.
We have follow steps 9-12 to add the following fields: Asset Description Product Name Product Part Number Product Id Mfg Date Proceed to click the Next button. A second Web Layout – Fields window will be prompted.
After this step you will be prompted to the Finish Window.
After clicking Finish, Siebel Tools automatically starts the Web Layout Edit Editor.
A new applet has been created. You will not be able to view your new Applet in the Application yet.
Now that we have fully described list applets and how they are created using the List Applet Wizard, we can continue our discussion with Form Applets. We have already explained form applets at the beginning of this module but just to recap, a form applet presents business component information in a data entry form layout. In a form applet users would enter data using text boxes, check boxes, buttons, and similar visual constructs known collectively as controls. Field controls on the form applet display fields in the business component containing data stored on the tables. Above each field control is a field caption which displays some caption text that describes the data that the associating field control contains. Also on a form applet are button controls. These controls initiate an action when clicked such as allowing you to create a new record when you press the new button control and allowing you to explicitly save the record when you press the save button control. The backward and forward button controls allow you to scroll backwards and forwards between records in the business component when pressed.
Now you should start to get familiar with the appearance of Form applets. What you will notice is that there are lots of fields on the form applet representing one field on the business component. If no editing controls have been placed on the fields then you should be able to edit each field that is displayed. You will know if a field is Read-only as the field will have a slightly shaded background therefore not allowing you to edit its value. When you press the backward or forward button control you can scroll backward and forward between the records on the business component one record at a time. One more important thing to point out about Form applets is that when a field is a required field, there will be a red asterisk beside the label marking it as a required field. When a field is a required field, you cannot save a record (either new or modified) if any of the required fields do not have data contained in them.
One more concept we would like to introduce in form applets is Expanding and Collapsing form applets. All forms appear with the Show More button, shown in the above slide, in the top right corner. Use this button to expand or collapse the form. This allows you to look at more or fewer fields in a record, according to your needs and the state of the form. The expanded form shows all the fields of a record. Your system administrator determines what fields appear in the expanded form and in the collapsed form. When you first enter a form applet, you will see it in its default display which is in the Collapsed display. This display shows a limited set of fields on the form and all the fields that are displayed can be edited. When you press the Show More button, all the fields on the form are displayed, hence you are viewing the form in it’s “Expanded” display. We will cover how to configure expanding and collapsing form applets later in the module.
Now earlier when we were describing list applet modes, we discussed how list applets could use Base Mode, Edit Mode and Edit List mode. Now we will discuss the modes available for form applets. A form applet can only use either the Base mode or the Edit mode, it does not have the option of using edit list mode. Now we have already discussed the concept of Base Mode and Edit Mode templates, but just to recap, Base mode is the read-only mode for displaying but not editing data. Views appear by default in base mode. Edit mode is the mode used for editing an existing record. The way to determine the type of mode that you wish the applet to be displayed in is to navigate to the Applets Object Definition in the objects explorer window and select Applet Web Templates for the desired applet. Here you will see all the Applet Web Templates associating to the particular applet and the type property for each applet determines its mode. You can change this type here.
Now that we have described form applets, we will now explain how to create a form applet using the Form Applet Wizard. The Form Applet Wizard helps you define all the correct properties and automatically creates child objects, such as Web Template Items, based on the information you enter. You can also create applets manually by defining all the necessary properties and child objects. The Form Applet Wizard does the following: Creates the form applet Creates the applet Web template Creates the controls Maps controls to Web templates by creating Applet Web Template Items In order to create a Form Applet using the Form Applet Wizard: Choose File >New Object from the Siebel Tools main menu. The New Object Wizard dialog box appears. Click the Applets tab, and then double-click the Form Applet icon. The General page of the Form Applet Wizard appears. Now we have already described the General page of the List Applet Wizard in this section but now we will describe the General page of the Form Applet wizard. This is the first screen that you are prompted with after selecting the Form Applet Wizard is the General Page and it is displayed above. This screen is very similar to the List Applet Wizard General page as it allows you to enter the project and business component for which the applet will be based on. Only locked projects appear in the picklist. This screen is also where you would enter the name of the new applet. Once again, the applet name must be a unique name that has not already been used by another applet in the system. It is used to refer to the applet when laying out a view. The last thing that you can specify in this screen is the display title for the new applet. This is the name to appear in the user interface and may be left blank if no title is desired.
Now the next screen in the Form Applet Wizard is the Web Layout – General page. This screen of the wizard solicits data to associate the correct applet Web template object definitions to the form applet object definition. The presentation of the applet in each mode is determined by the Siebel Web Template. This section asks you to select templates for each type of edit mode for the applet and once you have done that, it associates the template with the applet. Associating a template and an applet in Tools lets the program know which template(s) to use for the applet. Please note that a thumbnail image for many templates appears when you select the template name. There is a check box just below the list of templates called “Show All Templates”. When checked, all the templates available on the system are displayed. If left unchecked, you will only be able to see the templates that associate to list applets. Once you have selected all the necessary values in this screen, you can press ‘Next’ to be taken to the next step in the Form Applet Wizard
The next page that you are displayed with is the Web Layout – Fields page. In the Web Layout - Fields page, select the fields that you want to appear on the applet and then click Next. The fields that appear in the Available pane are those fields defined for the business component that you selected in Step 1. This screen of the wizard solicits data to create and associate the correct applet Web template item object definitions with the applet object definition. Now it is important to note that you can’t set the order for the fields in this wizard, except by picking the fields in order. Using the Web Layout Editor to arrange the fields correctly is more important with form applets than it was with list applets and you should note that there is no “Columns Displayed” option for form applets.
In the second Web Layout-Fields page, choose the controls in the Available Controls box that you want to appear on the applet and then click Next. All the entries in the Selected Controls box are added by default. If you wish to exclude some of the controls and move them to the Available Controls box, select the controls and click the activated arrow.
Review the information displayed in the Finish page, displayed above, and then click Finish. The Form Applet Wizard creates the applet and supporting object definitions based on the selections you made. If you need to review or change information in any of the previous screens, you can return to previous pages by clicking the Back button.
Now once you have created a new Form applet, you may wish to modify it or any other applets that have been created. The way to do that is by using the The Siebel Web Applet Editor. This helps ensure visually accurate and correctly translated configurations by providing a design-time preview of the applet in a variety of modes and with various language settings. The Web Applet Editor allows you to map controls and list columns to Web templates. It also allows you to preview the applet as it would be rendered at run time. It should be noted that after you create an applet using a new applet wizard, the Web Applet Editor automatically opens. The steps involved in accessing the Web Applet Editor when it is not automatically opened are explained in the next slide.
The first thing you need to do in order to access the web applet is select a target browser from the drop-down list in the tools bar. Please note that if you do not select a browser, you get an error message when you choose the Edit Web Layout option from the menu. The Target Browser feature of Siebel Tools allows you to configure applications conditionally for different browsers (for example, Internet Explorer 5, Netscape 4.7) The next step you need to do is select the Applet Object in the Object Explorer and then select an applet that you wish to begin editing from the list object editor. In order to display the Applet Web Template, you will need to right click on the applet and select the “Edit Web Layout” option from the pop up menu that is displayed. After having done that you will be taken directly to the Applet Web Template Layout window.
Once in the Applet Web Layout Editor, you can edit the controls on the screen. You can add controls to the applet template by dragging and dropping features from the Control/Columns window. You can also add controls by dragging and dropping from the Web controls toolbar, including custom controls such as Minibuttons It is important to set all the necessary properties for each control that you create in the Web Layout editor. You can edit the control properties in the properties window by modifying the value beside the appropriate control. For a list of all the properties for a control you can refer to the Object Types Reference in the Siebel Bookshelf Guide.
Another thing that you should think about when designing your Applet is which fields you wish to display in More mode or Less mode. The way to set that property for a control is by right clicking on the control in the Applet Web Template and selecting ‘More’. If you enter More for the Mode property, the field will not display in the collapsed applet. Setting More in the Web Layout Editor sets the Mode property for the Applet Web Template Item to More. You will notice that once you have selected the More property, the control is highlighted green. This is to distinguish that the field has actually been selected to be included in the More mode. What you will also notice is that if you right click on this highlighted field the More option in the drop down menu has a tick beside it, also to denote that it has been selected to be included in the more mode. In order to deselect the field you will need to right click on it once again and select the more option with the tick currently beside it. Doing this will remove the tick beside the More option in the drop down menu and remove the highlight from the control, denoting that it will no longer be included only in the More mode.
Now in order to enable the expanding and collapsing tool in the form applet, you must create a toggle layout control and add it using the Web Layout Editor. In order to do that, you will need to select the applet object in the Object Explorer and then select an applet that you wish to set the property for from the list object editor. The next thing that you will need to do is select the controls object below the applet object. From here you can create a new control called “Toggle Layout”. You will need to set the HTML Type property to ‘Link’ and HTML Bitmap property to ‘BTTNS_MORE’ and finally set the method invoked property toe ‘ToggleLayout’.
Now once you have modified the applet and are satisfied with it, you will probably want to see a preview of it to see what it will look like on the Siebel application. In order to view an applet in Preview mode all you need to do is right click anywhere in the Web Layout Editor and select “Preview” from the drop down menu. This will take you directly to the preview mode. Now one thing that you should note when in the preview mode is that you can preview the screen in ‘More’ mode by right clicking and selecting more from the drop down menu. This will display the preview with all the fields on the applet, including those fields that you would only see after pressing the “More” button in the Siebel application. By deselecting the More option from the right click drop down menu in the preview mode you will only see those fields that are displayed in the collapsed mode in the Siebel Application.
After completing this module you should be able to: Discuss Form and List Applets Describe the configuration steps needed to configure List Applets using the List Applet Wizard & Other methods Describe the configuration steps needed to configure Form Applets - Form Applet Wizard & Other