8Examples of Developing a Task UI
Examples of Developing a Task UI
This chapter describes examples of developing a task UI. It includes the following topics:
Example of Developing a Task UI That Assists with Adding an Opportunity
Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity
Example of Developing a Task UI That Assists with Adding an Account and a Service Request
Example of Developing a Task UI That Assists with Creating Multiple Opportunities
Example of Modifying a Predefined Task UI
To modify the predefined FS Asset To Contract Task, perform the following tasks:
The work that you do to modify a predefined task UI varies depending on the task you must modify. In this topic you modify the relatively complex FS Asset To Contract Task. Siebel CRM displays the following message in the Siebel client when it runs this task UI:
Select a Service Package to be Added
You must create some products with Type equal to Service to make sure Siebel CRM displays data in this view. You activate the task, add product data, and then verify task functionality. A significantly different configuration might be required to configure a different predefined task UI.
For more information, see About Predefined Task UIs.
Activating the Task UIs and Subtasks
This task is a step in Example of Modifying a Predefined Task UI.
In this topic, you activate the task UIs and subtasks.
To activate the task UIs and subtasks
In the Siebel client, navigate to the Administration - Business Process screen, and then the Task Deployment view.
Query the Name column for FS Asset To Contract Task, and then click Activate.
Repeat the previous step for the following tasks:
FS Cover Asset SubTask
FS Submit Agreement Sub Task
Verify that Siebel CRM displays each task UI in the Active Tasks list and that the Deployment Status for each task is Active.
Navigate to the Administration - Application screen, and then the Tasks view.
Verify that each of the tasks you activated in previous steps includes the Siebel Administrator responsibility:
In the Registered Tasks list, click each view in succession.
As you click each view, in the Responsibilities list, verify that a record exists with Siebel Administrator in the Responsibility field.
If this record does not exist, then add it now. Leave the Allow Delete and Allow Transfer fields with their default check mark.
For more information, see Adding a Responsibility to a Task UI.
Adding the Product Data for the Asset to Contract Task
This task is a step in Example of Modifying a Predefined Task UI.
In this topic, you add the product data.
To add the product data for the Asset to Contract Task
Navigate to the Administration - Product screen, and then the Products view.
Create a new product using values from the following table.
Field Description Name
Choose Technical Support 24x7.
Type
Choose Service.
Service Product
Make sure this field includes a check mark.
Make sure the following product is chosen:
Technical Support 24x7
Click the Product Definitions link.
Note the default record that Siebel CRM displays in the Versions list with Version set to Work Space.
Define the Start Date field to be midnight of the date for today.
For example, if today is July 1, 2013, then enter the following date:
7/1/2013 12:00:00 AM
Leave the end date field empty.
In the Products list, click Release.
Siebel CRM releases the product version for this configuration, causing a new version to display in the Versions list with 1 in the Version field and the following value in the Start Date field:
7/1/2013 12:00:00 AM
Navigate to the Administration - Contracts screen, and then the Term Templates view.
Create a term template using values in the following table.
Field Value Term #
TS Term 1
Term Name
Technical Support Terms
Type
Standard
Description
This is a test Agreement Term Save record.
Log out of the Siebel client.
Verifying the Functionality of the Asset to Contract Task
This task is a step in Example of Modifying a Predefined Task UI.
In this topic, you verify the functionality of the Asset to Contract task.
To verify the functionality of the Asset to Contract task
Log in to the Siebel client, click the Accounts screen tab, and then click the Tasks icon.
Verify that the task pane displays the task UI named Agreement Creation Task.
Click the following link that Siebel CRM displays under the Agreement Creation Task:
Assets to Agreement
Verify that the task pane displays the following task groups:
Create / Revise Agreement
Cover Assets
Submit Agreement.
In the Identify Agreement task view, make sure the Use Existing Agreement radio button includes a check mark, and then click Next.
In the Select an Agreement for Revision task view, choose an agreement from the list, and then click Next.
On the Agreement Detail task view, note that Siebel CRM enters data in some fields according to the choice you made in the previous step, and then click Next.
On the Add Service Package task view, click Continue.
The choice you make alters the task flow:
If you click Continue, then Siebel CRM runs the FS Submit Agreement Sub Task.
If you click Use Existing Line Item, then Siebel CRM displays the Agreement Line Item List View.
To verify this logic in the Task Editor, you can examine conditions on connectors that emanate from the Create New Line Item decision point. For more information, see Examining the Logic of a Task UI.
You can chose one of the other options on a subsequent test of this task UI to view how the task logic varies according to the condition that is met.
On the Add Agreement Terms task view, click Add, add the Technical Support Terms term, and then click Next.
Siebel CRM displays the Agreement Terms Task View of the subtask named FS Submit Agreement Sub Task. You can verify this logic in the Task Editor.
On the Submit Agreement for Approval task view, click Continue, and then click Next.
On the Generate Agreement Document task view, click Auto Document, and then click Submit.
If you click Submit, then Siebel CRM updates the base table with the modification that you made to the agreement. If you add a new agreement, then the All Agreements List view displays a new record for the agreement.
Example of Developing a Task UI That Assists with Adding an Opportunity
The example in this topic describes how to develop a task UI that assists the user with adding an opportunity. To develop this example, perform the following tasks:
The data manipulation and storage requirements for this example do not involve transient data, so you do not use a transient business component or a task applet. Instead, you use a standard business component and create a standard applet. For more information, see the following topics:
Creating and Diagramming the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
In this topic, you create and diagram the task UI.
To create and diagram the task UI
Make sure Siebel Tools is prepared to create a task UI.
For more information, see Preparing Siebel Tools to Create a Custom Task UI.
In the Object Explorer, click Project.
In the Projects list, create a new project named Opportunity Task UI.
You can use this project to support this development effort. For more information, see Using Siebel Tools.
Use the Task Wizard to create a new task UI using values from the following table.
Property Description Project
Choose Opportunity Task UI.
Task Name
Enter Create New Opportunity.
Display Name
Enter Create New Opportunity.
Business Object
Choose Opportunity.
Transient Business Component
Leave this field empty.
Subtask
Make sure this option does not include a check mark.
For more information, see Creating a Custom Task UI.
Diagram the task UI to resemble the flow that the following diagram displays:
Siebel Tools displays the label for the task view step after you bind the view in a subsequent step in this example. For more information, see Diagramming a Task UI.
Click the Create Opportunity step, and then use the Properties window to define properties using values in the following table.
Property Value Business Component
Opportunity
Defer Write Record
TRUE
Operation
Insert
For more information, see About the Defer Write Record Property.
Save your work and then close the Task Editor.
Creating the Applet
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
In this topic, you create a new standard applet that the user uses to enter information about an opportunity.
To create the applet
In Siebel Tools, choose the File menu, and then the New Object menu item.
In the New Object Wizards dialog box, click the Applets tab.
Click the Form Applet icon and then click OK.
In the General dialog box, define fields using values from the following table, and then click Next.
Property Description Project
Choose Opportunity Task UI.
Name
Enter Opportunity Task UI Form Applet.
Display Title
Enter Opportunity.
Business Component
Choose Opportunity.
Upgrade Behavior
Choose Admin.
Use Grid Layout
Make sure this option includes a check mark.
In the Web Layout - Form dialog box, accept the default Edit Mode, and then click Next.
In the Web Layout - Fields dialog box, move the following fields from the Available Fields window to the Selected Fields window, and then click Next:
Name
Description
Primary Revenue Amount
Primary Revenue Close Date
In the Web Layout - Fields dialog box, move fields that Siebel Tools lists in the Available Controls window to the Selected Controls window, and then click Next.
Siebel Tools might already display fields for this dialog box in the Selected Controls window.
In the Finish dialog box, review your settings and then Click Finish.
Siebel Tools creates the new applet and then opens the Web Layout Editor.
In the Applet Web Template window, reposition controls and labels until the applet resembles the layout that the following diagram displays:
Choose the Description control, and then use the Properties window to set the property described in the following table.
Property Value HTML Type
TextArea
You set the HTML Type property, and then Siebel Tools displays a scroll bar along the side of the Description control.
Save your work and then close the Applet Web Template window.
Creating the Task View
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
In this topic, you create a task view that displays the applet that allows the user to enter opportunity details. You defined this applet in Creating the Applet.
To create the task view
Create a task view.
For more information, see Creating a Task View.
In the New View dialog box, enter values described in the following table.
Property Value Project
Opportunity Task UI
View Name
Opportunity Task UI View
View Title
Opportunity
Business Object
Opportunity
Upgrade Behavior
Admin
In the View Web Layout - Select Template dialog box, choose the following template:
View Detail (Parent with Pointer)
In the Web Layout - Applets dialog box, chose the following applet, and then click Next:
Opportunity Task UI Form Applet
The Opportunity Task UI Form Applet is the custom applet you created in Creating the Applet.
In the Task View - Pick Task dialog box, click No, and then click Next.
In the Task View - Select Playbar Applet dialog box, choose the Task Playbar Applet - Bottom applet as the footer playbar applet, and then click Next.
Click Finish, verify that the layout is correct, and then close the Web Layout Editor.
Binding the Task View To the Task View Step
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
In this topic, you bind a task view to the task view step.
To bind the task view to the task view step
Bind the task view step that resides immediately downstream of the Create Opportunity Siebel operation step to the Opportunity Task UI View.
For more information, see Binding a Task View to a Task View Step.
Controlling the Buttons of the Playbar Applet
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
You configure properties on the task view step to control the buttons that are active in the playbar applet. You also set the display name for the task view.
To control the buttons of the playbar applet
In the Task Editor, click the Opportunity Task UI View step, and then use the Properties window to define properties described in the following table.
Property Description Disable Previous
Choose TRUE.
Display Name - String Override
Enter Opportunity Details.
Forward Button Type
Choose Submit.
Save your modifications and then close the Task Editor.
Creating the Task Group
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
In this topic, you create a task group for the Create New Opportunity task UI. For this example, you create the task group so that Siebel CRM displays it only when it also displays the Opportunity List View. For more information, see Task Group.
To create the task group
Create the task group:
Create the new task group using values from the following table.
Property Value Name
Opportunity Task Group
Project
Opportunity Task UI
Display Name - String Override
Opportunity Tasks
Create the new task group item using values from the following table.
Property Value Action Invoked
Create New Opportunity
Type
Task
Sequence
1
For more information, see Creating a Task Group.
Define the task group to display in a specific view.
Choose Opportunity Task Group from the pop-up applet when you define the Task Group property in the View Task Groups list, and then define the property described in the following table.
Property Value Sequence
2
For more information, see Adding a Task Group to a View.
Verifying the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity.
In this topic, you verify that the task UI delivers the required functionality. For more information, see Verifying Functionality of a Task UI.
To verify the task UI
Log in to the Siebel client, click the Tasks icon, and then verify that the task pane does not display in the Opportunity Tasks task group.
You defined this task UI to display only when the Opportunity List View is the current view.
Click the Opportunities screen tab, and then click the Opportunities List link.
Verify that the task pane now displays the Opportunity Tasks task group.
In the task pane, click the Create New Opportunity link, and then verify that Siebel CRM displays the Enter Opportunity Details view and that it correctly arranges the controls.
The layout must be similar to the layout that you defined in Creating the Applet.
If the layout requires adjustment, then you can rapid prototype the applet layout. For more information, see Rapid Prototyping the Layout of an Applet.
Verify the following:
The Pause, Submit, and Cancel buttons are active.
The Previous button is disabled.
Enter a value in the following fields, and then click Submit:
Name
Description
Primary Revenue Amount
Siebel CRM closes the task UI and then displays the standard Opportunity List View.
Verify that Siebel CRM includes the opportunity you defined in the previous step in the opportunity list, and that the opportunity fields include the values you entered in the task UI.
Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity
The example in this topic describes how to develop a task UI that assists the user with adding a new opportunity and an activity for this opportunity. To develop this example, perform the following tasks:
In this example, the user uses a task UI to enter information in the fields of an opportunity. Siebel CRM displays a radio button group that allows the user to choose to add an activity. Siebel CRM stores this choice as transient data, so you use a transient business component and a task applet. For more information, see Overview of Transient Data.
Creating and Diagramming the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you create and diagram the task UI.
To create and diagram the task UI
Create and test the task UI that is described in Example of Developing a Task UI That Assists with Adding an Opportunity.
Creating the Transient Business Component
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
This task UI uses a radio button group to provide the user an option to add an activity to the opportunity. It is not necessary to store the reply that the user provides in the Siebel database. Instead, you use a transient business component to store the reply. For more information, see the following topics:
To create the transient business component
Use the Business Component Wizard to create a transient business component. In the New Business Component dialog box, define properties using values from the following table.
Property Description Project
Choose Opportunity Task UI.
Name
Enter TBC for Opportunity.
MultiRecord TBC checkbox
Make sure this property does not contain a check mark.
For more information, see Creating a Transient Business Component.
In the Object Explorer, expand the Business Component tree, and then click Field.
In the Fields list, create a new field using values from the following table.
Property Description Name
Enter Create Activity.
Picklist
Choose a picklist. This choice only acts as a placeholder. You define the actual picklist in a subsequent step in this procedure.
Text Length
Enter 10.
Type
Choose DTYPE_TEXT.
Make sure the Create Activity record is still chosen in the Fields list.
In the Object Explorer, expand the Field tree, and then click Pick Map.
In the Pick Maps list, create a new pick map using values from the following table.
Property Value Field
Create Activity
Picklist Field
Value
Creating the Picklist
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you create the picklist that the Create Activity field references.
To create the picklist
In Siebel Tools, choose the File menu, and then the New Object menu item.
In the General tab of the New Object Wizards dialog box, choose Pick List, and then click OK.
Use the Pick List Wizard to create the pick list:
In the Pick List dialog box, enter values described in the following table, and then click Next.
Property Value Project
Opportunity Task UI
Business Component
TBC for Opportunity
Field
Create Activity
In the Pick List Type dialog box, accept the default Static pick list type and then click Next.
In the Pick List Definition dialog box, accept the following default value and then click Next:
Create New Pick List
In part two of the Pick List Definition dialog box, do the following work:
Enter the following text for the name: Yes No Prompt
Accept the following default: Create New List of Values
Click Next.
In the List of Values dialog box, do the following work:
Enter the following text for the name in the first window: Values for Yes No Prompt
Enter the following value in the middle window: Yes
Click Enter.
Siebel Tools displays the following value in the Current values window: Yes
In the List of Values dialog box, do the following work:
Enter the following text in the middle window: No
Click Enter.
Siebel Tools displays the following value in the Current values window: Yes and No
Click Next.
In the Pick List Definition dialog box, leave all fields empty, and then click Next.
In the Finish dialog box, click Finish.
In the Object Explorer, click Business Component.
In the Business Components list, query the Name property for the following value:
TBC for Opportunity
In the Object Explorer, expand the Business Component tree, and then click Field.
In the Fields list, query the Name property for the Create Activity field that you defined previously.
In the Picklist property, remove the value you entered earlier, and then choose the following value from the pop-up applet:
Yes No Prompt
Creating the Task Applet
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you create the task applet that allows the user to add an activity. For more information, see Task Applet.
To create the task applet
Use the Task Form Applet Wizard to create a new task applet:
In the Task tab of the New Object Wizards dialog box, choose the Task Form Applet icon.
-
In the General dialog box, define properties using values from the following table.
Property Value Project
Opportunity Task UI
Applet Name
Opportunity Task UI Next Step
Display Title
Next Step
Task Applet is Associated With
Create New Opportunity
Upgrade Behavior
Admin
Transient Business Component
TBC for Opportunity
In the Web Layout - Fields dialog box, move only the Create Activity field to the Selected Fields window.
For more information, see Creating a Task Applet.
In the Applet Web Template window, reposition the Create Activity control and label until the applet resembles the layout that the following diagram displays:
The No option is not visible when Siebel Tools displays the template. You must resize the Create Activity control to display the No option.
Save your work, and then close the Web Layout Editor.
Adding the Task Applet to the View
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you add the task applet to the view.
To add the task applet to the view
In the Object Explorer, click View.
In the Views list, query the Name property for Opportunity Task UI View.
In the Object Explorer, expand the View tree, expand the View Web Template tree, and then click View Web Template Item.
In the View Web Template Items list, add a new view web template using values from the following table.
Property Value Name
Opportunity Task UI Next Step
Item Identifier
6
Applet
Opportunity Task UI Next Step
Applet Mode
Edit
In the View Web Template Items list, choose the item named Task Playbar Applet - Bottom, and then set properties using values from the following table.
Property Value Item Identifier
8
Creating the Task View
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you create a new task view that allows the user to add an activity to the opportunity. For more information, see Creating a Task View.
To create the task view
Use the Task View Wizard to create a new task view:
In the New View dialog box, enter values described in the following table.
Property Value Project
Opportunity Task UI
View Name
Opportunity Activity Task View
View Title
Create Activity
Business Object
Opportunity
Upgrade Behavior
Admin
In the View Web Layout - Select Template dialog box, choose the following template:
View Detail (Parent with Pointer)
In the Web Layout - Applets dialog box, move the following applets from the Available Applets window to the Selected Applets window:
Opportunity Task UI Form Applet
Activity Form Applet
The Opportunity Task UI Form Applet is the custom applet you created in Creating the Applet that allows the user to enter details about the opportunity. The Activity Form Applet is a predefined applet that allows the user to enter details about the activity.
In the Task View - Pick Task dialog box, click No.
In the Task View - Select Playbar Applet dialog box, choose the Task Playbar Applet - Bottom applet as the footer playbar applet.
-
Click Finish, verify that the layout is correct, and then close the Web Layout Editor.
Revising the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you revise the task UI so that it allows the user to add an activity.
To revise the task UI
In the Object Explorer, click Task.
In the Tasks list, query the Task Name property for Create New Opportunity.
If Siebel Tools returns more than one record, then choose the record that includes the highest number in the Version property.
In the WF/Task Editor Toolbar, click the Revise icon.
Siebel Tools creates a new record in the Tasks list. This new record possesses the highest number in the Version property. For more information, see Using the WF/Task Editor Toolbar.
In the Tasks list, modify the new revision using values from the following table.
Property Value Transient BC
TBC for Opportunity
The Transient BC property identifies the transient business component.
Open the Task Editor for the new version, and then modify the task UI until it resembles the flow that the following diagram displays:
Siebel Tools displays the label of the Opportunity Activity Task View after you bind the view in a subsequent step in this example. For more information, see Diagramming a Task UI.
Choose the Opportunity Task UI View step, and then use the properties window to define values described in the following table.
Property Value Forward Button Type
Next
Choose the Create Activity step, and then use the properties window to define values described in the following table.
Property Value Business Component
Action
Defer Write Record
True
Operation
Insert
Choose the Opportunity Activity Task View step, and then use the properties window to define values described in the following table.
Property Value Display Name - String Override
Create Activity
Forward Button Type
Submit
Task View
Opportunity Activity Task View
Click the No connector, and then use the properties window to define values described in the following table.
Property Value Type
Default
Creating the Condition Criteria
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you create the condition criteria.
To create the condition criteria
Right-click the Yes connector, and then choose Edit Conditions.
Siebel Tools displays the Compose Condition Criteria dialog box. For more information, see Creating a Branch Connector.
In the Compare To picklist, choose Business Component.
You can use the Compare To picklist to indicate whether Siebel CRM must use an object, expression, or process property in the comparison. In this example, Siebel CRM compares the run-time value of a field from the TBC for Opportunity business component, as defined in the Object picklist. Items in the Object picklist are context-sensitive. Siebel CRM updates these items according to the value that you choose in the Compare To picklist.
In the Object picklist, choose TBC for Opportunity.
In the Operation picklist, accept the following default:
All Must Match (Ignore Case)
You can use the Operation field to create the condition in this example. The value you define in the Values section of the Compose Condition Criteria dialog must match the run-time value of the Create Activity field of the business component.
In the Field picklist, choose Create Activity.
In the Values window, click New.
In the Pick Value dialog box, choose Yes, and then click OK.
In the Compose Condition Criteria dialog box, click Add.
Siebel Tools adds the condition you created in the lower portion of the Compose Condition Criteria dialog box to the Conditions list in the upper portion of the dialog box. At this point, you can add another condition. For this example, you add only a single condition.
The condition you set in the Compose Condition Criteria dialog box must resemble the condition that the following diagram displays:
At run time, if the Create Activity field contains:
Yes. Siebel CRM directs the task flow down the Yes branch.
No. Siebel CRM directs the task flow down the No branch.
Click OK.
Save your work, and then close the Task Editor.
Verifying the Functionality of the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Opportunity and an Activity.
In this topic, you verify that the task UI delivers the required functionality.
To verify the functionality of the task UI
Log in to the Siebel client, click the Opportunities screen tab, and then click the Opportunities List link.
Click the Tasks icon.
In the task pane, click the Create New Opportunity link, and then verify that the Enter Opportunity Details view does the following:
Displays the same controls you examined in Verifying the Task UI
Includes the Create Activity radio button group
Enter Test Opportunity in the Name field, enter a Description, click Yes, and then click Next.
Verify that the Create Activity view displays correctly:
Verify that the upper portion of the view includes the same opportunity details that Siebel CRM displayed in the Enter Opportunity Details view.
Verify that the lower portion of the view displays fields that allow the user to provide details about the activity.
Verify that Siebel CRM enters data in the Opportunity field in the lower portion of the view that includes the opportunity name that you entered in the earlier view.
Do the following:
Enter some text in the Description field of the activity.
Define other activity fields at your discretion.
-
Click Submit.
Siebel CRM closes the task UI and then displays the standard Opportunity List View.
Verify the following:
The opportunity list includes the opportunity you created in Step 4.
The opportunity fields include the values you entered in the task UI.
In the Opportunity Name field, drill down on the Test Opportunity record.
Click the Activities view tab, and then verify that the standard Opportunity Detail - Activities View displays an activity record that includes the activity details you entered in the task UI in Step 6.
Example of Developing a Task UI That Assists with Adding an Account and a Service Request
The example in this topic describes how to develop a task UI that assists the user with adding an account and a service request for that account. To develop this example, perform the following tasks:
The data manipulation and storage requirements for this example do not involve transient data, so you do not use a transient business component or a task applet. Instead, you use standard business components and reuse standard applets. For more information, see:
Creating and Diagramming the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
In this topic, you create and diagram the task UI.
To create and diagram the task UI
Make sure Siebel Tools is prepared to create a task UI.
For more information, see Preparing Siebel Tools to Create a Custom Task UI.
In the Object Explorer, click Project.
In the Projects list, create a new project named Account Task UI.
You can use this project to support this development effort. For more information, see Using Siebel Tools.
Use the Task Wizard to create a new task UI, using values in the following table.
Property Description Project
Choose Account Task UI.
Task Name
Enter Create Account and SR.
Display Name
Enter Create new Account and SR.
Business Object
Choose Account.
Transient Business Component
Leave this field empty.
Subtask
Make sure this property does not include a check mark.
For more information, see Creating a Custom Task UI.
Diagram the task UI so that it resembles the flow that the following diagram displays:
Siebel Tools displays labels for the task view steps after you bind the views in a subsequent step in this example. For more information, see Diagramming a Task UI.
Click the Create Account step, and then use the Properties window to define properties using values in the following table.
Property Value Business Component
Account
Defer Write Record
TRUE
Operation
Insert
For more information, see About the Defer Write Record Property.
Click the Create SR step, and then use the Properties window to define properties using values in the following table.
Property Value Business Component
Service Request
Defer Write Record
TRUE
Operation
Insert
Save your work, and then close the Task Editor.
Creating the Applets
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
In this topic, you reuse standard applets. For more information, see Reusing a Standard Applet.
To create the applets
Copy a standard applet:
Copy the Account Entry Applet.
To name the new applet, use the following text:
Account Entry for Task UI
In the Project property, enter Account Task UI.
In the Applet Web Template window, delete and reposition controls and their labels so the applet resembles the layout that the following diagram displays:
Save your work and then close the Applet Web Template window.
For more information, see Reusing a Standard Applet.
Copy a standard applet:
Copy the Service Request Detail Applet.
Use the following text to name the new applet:
SR Entry for Task UI
In the Project property, enter Account Task UI.
In the Applet Web Template window, delete and reposition controls and their labels so the applet resembles the layout that the following diagram displays:
Reuse of this applet includes the fields that the insert operation requires. You can remove the following items to simplify layout:
Remove unused controls and labels from the grid.
Remove the Verify button and the Verify Best Time button from the area immediately before the grid.
- Save your work, and then close the Applet Web Template window.
For more information, see Reusing a Standard Applet.
Creating the Task Views
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
In this topic, you create task views that display the applets you created in Creating the Applets.
To create the task views
Use the Task View Wizard to create the task view that allows the user to enter account data:
In the New View dialog box, enter values described in the following table.
Property Value Project
Account Task UI
View Name
Account Entry Task View
View Title
Enter Account Details
Business Object
Account
Upgrade Behavior
Admin
In the View Web Layout - Select Template dialog box, choose the View Basic template.
In the Web Layout - Applets dialog box, chose the following applet:
Account Entry for Task UI
The Account Entry for Task UI applet is one of the custom applets you created in Creating the Applets.
In the Task View - Pick Task dialog box, click No.
In the Task View - Select Playbar Applet dialog box, choose the following applet as the footer playbar applet:
Task Playbar Applet - Bottom
Click Finish, verify that the layout is correct, and then close the Web Layout Editor.
For more information, see Creating a Task View.
Use the Task View Wizard to create the task view that allows the user to enter data about the service request:
In the New View dialog box, enter values described in the following table.
Property Value Project
Account Task UI
View Name
SR Entry Task View
View Title
Enter SR Details
Business Object
Account
Upgrade Behavior
Admin
In the View Web Layout - Select Template dialog box, choose the View Basic template.
In the Web Layout - Applets dialog box, chose the following applet:
SR Entry for Task UI
The SR Entry for Task UI applet is one of the custom applets you created in Creating the Applets.
In the Task View - Pick Task dialog box, click No.
In the Task View - Select Playbar Applet dialog box, choose the following applet as the footer playbar applet:
Task Playbar Applet - Bottom
Click Finish, verify that the layout is correct, and then close the Web Layout Editor.
For more information, see Creating a Task View.
Binding Task Views To Task View Steps
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
You must configure Siebel CRM to bind a task view to each task view step in the Create New Account task UI.
To bind task views to task view steps
Configure Siebel CRM to bind the task view step that resides immediately downstream of the Create Account Siebel operation step to the Account Entry Task View.
For more information, see Binding a Task View to a Task View Step.
Configure Siebel CRM to bind the task view step that resides immediately downstream of the Create SR Siebel operation step to the SR Entry Task View.
Controlling the Buttons of the Playbar Applet
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
This topic describes how to modify properties on the task view step to control the buttons that are active in the playbar applet. You also set the display name for the task view.
To control the buttons of the playbar applet
In the Task Editor, click the Account Entry Task View step, and then use the Properties window to define properties described in the following table.
Property Value Disable Previous
TRUE
Display Name - String Override
Enter Account Details
Forward Button Type
Next
Click the SR Entry Task View step, and then use the Properties window to define properties described in the following table.
Property Value Disable Previous
FALSE
Display Name - String Override
Enter SR Details
Forward Button Type
Submit
Creating Chapters for the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
In this topic, you create two new chapters for the Create New Account task UI. The task chapter is an optional UI element that assists user navigation. For more information, see Task Chapter.
To create chapters for the task UI
Create the task chapter:
Create two new chapters using values from the following table.
Name Display Name - String Override Sequence Chapter 1
Enter New Account
10
Chapter 2
Enter New SR
20
Assign the following steps to Chapter 1:
Start
Create Account
Account Entry
Assign the following steps to Chapter 2:
Create SR
SR Entry Task View
End
Save your modifications and close the Task Editor.
For more information, see Creating a Task Chapter.
Creating the Task Group
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
In this topic, you create a task group for the Create New Account task UI. The task group is a required UI element that specifies the group to display in the task pane when Siebel CRM displays the current view. For more information, see Task Group.
To create the task group
Create the task groups:
Create a new task group using values from the following table.
Property Value Name
Account Tasks
Project
Account Task UI
Display Name - String Override
Account Tasks
Create a new task group item using values from the following table.
Property Value Action Invoked
Create Account and SR
Type
Task
Sequence
1
For more information, see Creating a Task Group.
Define the task group to display across views.
Choose Account Tasks from the Task Groups pop-up applet when you define the Task Group property in the View Task Groups list, and then define the property described in the following table.
Property Value Sequence
2
For more information, see Adding a Task Group to Multiple Views.
Verifying the Task UI
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
In this topic, you verify that the task UI delivers the required functionality. For more information, see Verifying Functionality of a Task UI.
To verify the task UI
Log in to the Siebel client.
Click the Tasks icon, and then verify that the task pane displays a task group named Account Tasks.
To verify that Siebel CRM displays the task UI globally, click several different screen tabs, such as Home, Accounts, Contacts and Sales Orders. The Account Tasks task group must remain visible regardless of the standard view that Siebel CRM displays.
In the task pane, click the following link:
Create Account and SR
Verify that the task pane displays the following chapters:
Enter New Account
Enter New SR
The type of task pane that Siebel CRM displays varies depending on the context that the user uses to view the pane. At this point in this procedure, Siebel CRM displays the current task pane. For more information, see About the Task Pane.
Verify that Siebel CRM displays the Enter Account Details view and that it correctly arranges the controls.
The layout must be similar to the layout displayed in Example of a Task UI View.
If the layout requires adjustment, then you can rapid prototype the layout of the applet. For more information, see Rapid Prototyping the Layout of an Applet.
Verify that the following buttons are active:
Pause
Next
Cancel
Verify that Siebel CRM disables the Previous button.
Enter a value in the Account Name field and then click Next.
Verify that Siebel CRM does the following:
Displays the Enter SR Details view
Automatically enters data in the Account field that includes the account name you entered in the previous step.
Make sure the required fields include values.
Enter some text in the Summary field.
Click Submit.
Navigate to the My Accounts list, and then query the Account Name field for the name you entered previously.
Verify that Siebel CRM displays the new account.
Drilldown on the Account Name field.
Click the Service Requests view tab.
Verify that Siebel CRM displays one new SR for the account, and that this SR includes values you entered previously.
Rapid Prototyping the Layout of an Applet
This task is a step in Example of Developing a Task UI That Assists with Adding an Account and a Service Request.
You can do rapid prototyping on the layout of the applet. It is not necessary to recompile the entire task and the objects that the task references.
To rapid prototype layout of an applet
If the Siebel client is open, then close it.
In Siebel Tools, in the Object Explorer, expand the Applet tree, and then click Applet Web Template.
In the Applet Web Templates list, right-click the applet web template you must modify, and then choose Edit Web Layout.
Modify the layout, save your modifications, and then close Applet Web Template.
In the Applets list, right-click the record for the applet you modified in the previous step, and then choose Compile Selected Objects.
Log in to the Siebel client, navigate to the task UI you are modifying, and then examine your modifications.
Example of Developing a Task UI That Assists with Creating Multiple Opportunities
The example in this topic describes how to develop a task UI that assists the user with adding multiple opportunities. To develop this example, perform the following tasks:
Creating the Transient Business Component
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you create the transient business component for the task UI. For more information, see Overview of Transient Data.
To create the transient business component
Make sure Siebel Tools is prepared to create a task UI.
For more information, see Preparing Siebel Tools to Create a Custom Task UI.
In the Object Explorer, click Project.
In the Projects list, create a new project named Multiple Opportunity Task UI.
You can use this project to support this development effort. For more information, see Using Siebel Tools.
Choose the File menu, and then the New Object menu item.
In the New Object Wizards dialog box, choose the Task tab, click the Transient BusComp icon, and then click OK.
In the New Business Component dialog box, define the new business component using values from the following table.
Property Description Project
Choose Multiple Opportunity Task UI.
Name
Enter MultiRecordTBC.
MultiRecordTBC
Make sure this property includes a check mark.
Click Finish.
In the Object Explorer, expand the Business Component tree, and then click Single Value Field.
In the Single Value Fields list, create a new field using values from the following table.
Property Value Name
OptyName
Type
DTYPE_TEXT
Creating the Business Service
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you create the business service that the task UI calls.
To create the business service
In the Object Explorer, click Business Services.
In the Business Services list, create a new record using values from the following table.
Property Value Name
MultiTBC_Insert
Project
Multiple Opportunity Task UI
Class
CSSService
Display Name - String Override
MultiTBC_Insert
In the Business Services list, right-click the MultiTBC_Insert business service, and then choose Edit Server Scripts.
In the Scripting Language dialog box, choose eScript, and then click OK.
Siebel Tools opens the script editing window and chooses the Service_PreInvokeMethod function.
Make sure the cursor is positioned in the script editing window.
Choose the Edit menu, and then the Select All menu item.
Choose the Edit menu, and then the Cut menu item.
Paste the following script in the script editing window:
function Service_PreInvokeMethod (MethodName, Inputs, Outputs) { if (MethodName == "InsertRecordToTBC") { var currentBC; var currentTBC; var currentBO; var isSuccess; var iCounter; var indata; var isRecord; currentBO = TheApplication().GetBusObject ("Opportunity"); currentTBC = currentBO.GetBusComp ("TBUI81MultiRecordTBC"); currentBC = currentBO.GetBusComp ("Opportunity"); //Inserts data in the TBC iCounter = 3; do { indata="OptyMTBC"+iCounter; currentTBC.NewRecord(0); // creating a new record currentTBC.SetFieldValue("OptyName", indata); //setting name field currentTBC.WriteRecord(); // writing record in the multirecord TBC iCounter--; } while(iCounter); //Get the data from TBC and insert in BC currentTBC.ActivateField ("OptyName"); currentTBC.ClearToQuery(); currentTBC.SetSearchSpec ("OptyName", "*"); currentTBC.ExecuteQuery(ForwardBackward); isRecord = currentTBC.FirstRecord(); iCounter = 0; if(isRecord) { do { indata = currentTBC.GetFieldValue("OptyName"); currentBC.NewRecord(0); //This creates the new record currentBC.ActivateField("Name"); currentBC.SetFieldValue("Name", indata); // This is setting the field value for opportunity name currentBC.WriteRecord(); // writing the record to database. iCounter++; } while(currentTBC.NextRecord()); } } return (CancelOperation); }
Close the script editing window, and then click Yes in the Confirm dialog box.
In the Object Explorer, expand the Business Service tree, and then click Business Service Method.
In the Business Service Methods list, create a new business service using values from the following table.
Property Value Name
InsertRecordToTBC
Display Name - String Override
MultiTBCInsertBSM
Creating and Diagramming the Task UI
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you create and diagram the task UI.
To create and diagram the task UI
Make sure Siebel Tools is prepared to create a task UI.
For more information, see Preparing Siebel Tools to Create a Custom Task UI.
To create a new task UI, use the Task Wizard using values from the following table.
Property Description Project
Choose Multiple Opportunity Task UI.
Task Name
Enter Create Multiple Opportunities.
Display Name
Enter Create Multiple Opportunities.
Business Object
Choose Opportunity.
Transient Business Component
Choose MultiRecordTBC.
Subtask
Make sure this property does not include a check mark.
For more information, see Creating a Custom Task UI.
Diagram the task UI until it resembles the flow that the following diagram displays.
Siebel Tools displays the label for the task view step after you bind the view in a subsequent step in this example. For more information, see Diagramming a Task UI.
Click the Insert Opportunity step.
To define properties for the Insert Opportunity step, use the Properties window using values in the following table.
Property Value Business Service Name
81MultiTBC_Insert
Business Service Method
InsertRecordToTBC
Save your work, and then close the Task Editor.
Creating the Task Applet
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you create a new task applet that the user uses to enter opportunity information in the task UI. For more information, see Creating a Task Applet.
To create the task applet
In Siebel Tools, choose the File menu, and then the New Object menu item.
In the New Object Wizards dialog box, click the Task tab, choose the Task List Applet icon, and then click OK.
You create a list applet because the business need for this example requires that the user simultaneously create and view all opportunities that the user adds for the task instance. As an alternative, you can create a form applet where the user enters one opportunity at a time, and then uses buttons on the playbar to loop through the same form repeatedly until the user enters all opportunities.
In the General dialog box, define fields using values from the following table, and then click Next.
Property Value Project
Multiple Opportunity Task UI
Name
Multiple Opportunity Task Applet
Display Title
Multiple Opportunity
Task Applet is Associated With
Create Multiple Opportunities
Upgrade Behavior
Admin
Business Component
MultiRecordTBC
In the Web Layout - Fields dialog box, move the OptyName field from the Available Fields window to the Selected Fields window, and then click Next.
In the Finish dialog box, review your settings, and then Click Finish.
Siebel Tools creates the new applet and then opens the Web Layout Editor.
Save your work and then close the Applet Web Template window.
Creating the Task View
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you create a task view that displays the applet that allows the user to enter multiple opportunities.
To create the task view
Create a task view.
For more information, see Creating a Task View.
In the New View dialog box, enter values described in the following table.
Property Value Project
Multiple Opportunity Task UI
View Name
Multiple Opportunity Task UI View
View Title
Multiple Opportunities
Business Object
Opportunity
Upgrade Behavior
Admin
In the View Web Layout - Select Template dialog box, choose the following template:
View Detail (Parent with Pointer)
In the Web Layout - Applets dialog box, click Next.
Do not move any applets to the Selected Applets window.
In the Task View - Select Task dialog box, choose Create Multiple Opportunities, and then click Next.
In the Task View - Task Applets dialog box, move the following applet from the Available Applets window to the Selected Applets window:
Multiple Opportunity Task Applet
The Multiple Opportunity Task Applet is the custom applet you created in Creating the Task Applet.
Click Next.
In the Task View - Select Playbar Applet dialog box, choose the Task Playbar Applet - Bottom applet as the footer playbar applet, and then click Next.
Click Finish, verify that the layout is correct, and then close the Web Layout Editor.
Binding the Task View to the Task View Step
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you bind a task view to the task view step.
To bind the task view to the task view step
Bind the task view step to the Multiple Opportunity Task UI View.
For more information, see Binding a Task View to a Task View Step.
Controlling the Buttons of the Playbar Applet
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
You modify properties on the task view step to control the buttons that are active in the playbar applet. You also set the display name for the task view.
To control the buttons of the playbar applet
In the Task Editor, click the Opportunity Task UI View step, and then use the Properties window to define properties described in the following table.
Property Value Disable Previous
TRUE
Display Name - String Override
Enter Multiple Opportunities
Forward Button Type
Submit
Save your modifications and then close the Task Editor.
Creating the Task Group
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you create a task group for the Create Multiple Opportunities task. For this example, you define the task group so that Siebel CRM displays it only when it also displays the Opportunity List View. For more information, see Task Group.
To create the task group
Create the task group:
Create the new task group using values from the following table.
Property Value Name
Multiple Opportunities Task Group
Project
Multiple Opportunity Task UI
Display Name - String Override
Multiple Opportunities
Create the new task group item using values from the following table.
Property Value Action Invoked
Create Multiple Opportunities
Type
Task
Sequence
1
For more information, see Creating a Task Group.
Define the task group to display in a specific view:
In the Views list, query the Name property for Opportunity List View.
Choose Multiple Opportunities Task Group from the Task Groups pop-up applet when you define the Task Group property in the View Task Groups list, and then define the property described in the following table.
Property Value Sequence
2
For more information, see Adding a Task Group to a View.
Verifying the Task UI
This task is a step in Example of Developing a Task UI That Assists with Creating Multiple Opportunities.
In this topic, you verify that the task UI delivers the required functionality. For more information, see Verifying Functionality of a Task UI.
To verify the task UI
Log in to the Siebel client, click the Tasks icon, and then verify that the task pane does not display the Multiple Opportunities task group.
You defined this task UI to display only when the Opportunity List View is the current view.
Click the Opportunities screen tab, and then click the Opportunities List link.
Verify that the task pane now displays the Multiple Opportunities task group.
In the task pane, click the Create Multiple Opportunities link, and then verify that Siebel CRM displays the correct view and arranges the controls correctly.
The layout must be similar to the layout you defined in Creating the Task Applet.
If the layout requires adjustment, then you can rapid prototype the layout of the applet. For more information, see Rapid Prototyping the Layout of an Applet.
Verify that the following buttons are active:
Pause
Submit
Cancel
Verify that the Previous button is disabled.
Enter multiple opportunities and then click Submit.
Siebel CRM closes the task UI and then displays the standard Opportunity List View.
Verify that the opportunity list includes the opportunities you created in the previous step.