10Customizing Task UI

Customizing Task UI

This chapter describes how to customize a task UI. It includes the following topics:

• Starting a Task UI

• Resuming a Paused Task UI

• Creating a Subtask

• Defining the Context for a Task Step

• Creating a Task Event

• Using a Business Service Step to Call a Workflow Process

• Other Options for Customizing a Task UI

Starting a Task UI

A task UI typically starts when the user clicks a task group item that Siebel CRM displays as a link in a task group in the task pane. This topic describes options for starting a task other than through the task pane. It includes the following topics:

• Creating a Button to Start a Task UI

• Creating a Menu Item to Start a Task UI

• Creating an iHelp Link to Start a Task UI

• Creating a Workflow Process to Start a Task UI

• Creating a Script to Start a Task UI

Creating a Button to Start a Task UI

You can create a button on an applet that a user can click to start a task UI. For example, a button labeled Update Contact Info in the standard My Contacts list. For more information, see Configuring Siebel Business Applications.

To create a button to start a task UI

1. In Siebel Tools, display the Control User Prop object type.

   Control User Prop is a child of the Control object type, which is a child of the Applet object type. For more information, see Displaying Object Types You Use to Develop a Task UI.

2. In the Applets list, query the Name property for the applet that contains the control that starts the task UI.

3. In the Object Explorer, expand the Applet tree, and then click Control.

4. In the Controls list, add a new control using values from the following table.

   Property	Description
   HTML Type	Choose MiniButton
   Caption	Define the Caption property so the user can readily identify the control.
   Method Invoked	Enter LaunchTask. This option is not available from the list of values. You must use the keyboard to manually type it in the property.

5. Make sure the control you defined previously is still chosen.

6. In the Object Explorer, expand the Control tree, and then click Control User Property.

7. In the Control User Props list, add a new user property using values from the following table.

   Property	Description
   Name	Choose Task Name
   Value	Enter the name of the task UI.

Creating a Menu Item to Start a Task UI

You can create a menu item on an applet that the user can click to start a task UI. For more information, see Configuring Siebel Business Applications.

To create a menu item to start a task UI

1. In Siebel Tools, in the Object Explorer, click Command.

2. In the Commands list, create a new command using values from the following table.

   Property	Description
   Name	Enter text that describes the logic that the command performs.
   Business Service	Choose Task UI Service (SWE). Caution: You must make sure that the business service you specify does not include a browser script. A business service only works with a server script. If an applet menu item on the Siebel Server calls a business service that includes a browser script, then the business service fails.
   Target	Choose Server.
   Method	Choose LaunchTask.
   Method Argument	Enter the name of the task UI.

   The task UI to open is defined in the properties of the command, so you must define a new command for each task UI.

3. Add a menu item to the applet menu that calls the command that is defined for the task UI.

Creating an iHelp Link to Start a Task UI

You can use the following types of links in the iHelp Pane:

• An iHelp item

• A task UI

To create an iHelp link to start a task UI

1. In the Siebel client, choose the Administration - iHelp screen, and then the All iHelp Items view.

2. Create an iHelp item.

   For more information, see Siebel Applications Administration Guide.

3. In the iHelp Items list, choose an iHelp item.

4. Click Revise, and then click the More Info tab.

5. In the Related Task field, choose a task UI.

   To display a link for a task UI in the iHelp Pane, you must create a relationship between the task and an iHelp item on the iHelp Pane. For more information, see Siebel Applications Administration Guide.

6. To activate the iHelp item, click Activate.

   If the Activate button is not available, then click the Responsibility tab, and make sure the Active Flag option includes a check mark for your responsibility. For more information, see Adding a Responsibility to a Task UI.

7. Click the iHelp icon to view the link that resides in the iHelp item that Siebel CRM displays to start the task UI.

Creating a Workflow Process to Start a Task UI

You can start a long-running workflow process that starts a task UI. For more information about how to do this, see Siebel Business Process Framework: Workflow Guide.

Creating a Script to Start a Task UI

You can use a browser script or a server script to start a task UI. Your script calls the Task UI Service business service. It then passes the name of the task UI to the LaunchTaskFromScript business service method to start the task UI. You must compile the script into proxy JavaScript objects or to the SRF (Siebel Repository File). Processing varies depending the following type of script you use:

• Browser script. Siebel CRM handles the InvokeMethod methods for a script on the client objects, and then passes them to their server equivalents.

• Server script. Siebel CRM compiles the JavaScript files that include the scripted methods to the SRF, and then calls them from the Object Manager at the required preevent or postevent.

In this situation, browser script or server script does not use the CanInvokeMethod method.

Siebel CRM does the following work at run time:

1. The Task UI Service examines the name of the task UI and makes sure the user possesses the license and responsibility to run the task. For more information, see Adding a Responsibility to a Task UI.

2. If Siebel CRM allows the user to run the task, then the service passes the pointer of the active business component to the Task Controller, designating it as the context business component.

3. If any of the following situations exist, then the task controller creates an error:

   • The task requires a business component that is not the same as the context business component.

   • The task is not activated.

4. If Siebel CRM does not encounter an error, then it runs the task UI and opens the task pane.

Note the following restrictions when using a script with a task UI:

• Calling a task UI from a script requires UI context, meaning that Siebel CRM can reference a record in an applet. You must not configure Siebel CRM to start a task from a script that does not include UI context, such as a script for a workflow process, or from an event where the UI did not finish processing, such as the Applet_Load event.

• A script can pass only the name of the task UI. It cannot pass any other parameters.

• You can use a script only to start a task UI. You cannot use a script to interact with a task in any other way.

For more information, see About Event Handling.

Example of a Client Script

In this example, the browser script locates the Create a Contact task UI, and then starts the task:

function Applet_PreInvokeMethod (name, inputPropSet)

{
    try
    {

        if (name == "Test")
        {

            var inputPropSet;
            var outputPropSet;
            var taskUIsvc;

            inputPropSet = theApplication().NewPropertySet();

            outputPropSet = theApplication().NewPropertySet();

            taskUIsvc = theApplication().GetService("Task UI Service (SWE)");

            inputPropSet.SetProperty("TaskName","Create a Contact");
            <!-- Note: because taskUIsvc.Invokemethod() is required to pass outputPropSet, 
            the outputPropSet is created. outputPropSet is not used to send results back 
            to the task UI--!> 

            taskUIsvc.InvokeMethod("LaunchTaskFromScript",inputPropSet,outputPropSet);

            return ("CancelOperation");

        }
    }
    catch(e)
    {
        theApplication().alert("Error" + e.toString());
    }
    finally
    {
    }
    return ("ContinueOperation");
}

Example of a Server Script

In this example, the server script opens the Create a Contact task UI:

function WebApplet_PreInvokeMethod (MethodName)
{

    try
    {
        if (MethodName == "Test")
        {

            var inputPropSet;
            var outputPropSet;
            var taskUIsvc;

            inputPropSet = TheApplication().NewPropertySet();

            outputPropSet = TheApplication().NewPropertySet();

            taskUIsvc = TheApplication().GetService("Task UI Service (SWE)");

            inputPropSet.SetProperty("TaskName","Create a Contact");

            <!-- Note: because taskUIsvc.Invokemethod() is required to pass outputPropSet, 
            the outputPropSet is created. outputPropSet is not used to send results back 
            to the task UI--!> 

            taskUIsvc.InvokeMethod("LaunchTaskFromScript",inputPropSet,outputPropSet);

            return (CancelOperation);

        }
    }

    catch(e)
    {
        TheApplication().RaiseErrorText("Error" + e.toString());
    }
    finally
    {
    }
    return (ContinueOperation);
}

Resuming a Paused Task UI

This topic describes configuration options to resume a paused task UI. It includes the following topics:

• Creating an Association That Allows the User to Resume or Transfer a Paused Task UI

• Process of Creating a View That Allows a User to Transfer a Paused Task UI

• Modifying a Task UI to Display a Message That Is Specific to a Task Instance

For more information, see the following topics:

• Task Pause with the Task Playbar

• Universal Inbox

• Allowing Task Transfer

• Transferring a Task Instance

Creating an Association That Allows the User to Resume or Transfer a Paused Task UI

This topic describes how to configure a task instance to reference a business component instance. A user can pause a task UI. The same or another user can resume the task at a later time, retaining the task state. You can configure a task to reference a business object instance so that Siebel CRM can transfer a paused task between users.

For example, assume you are a customer service representative (CSR) in a 100 person IT contact center for a computer manufacturer. The primary business process you perform, diagnosing problems with IT computer systems, beings with a task UI that requires complex information from a customer. Occasionally, the customer might call you back with diagnostic information that requires you to pause the task. Another CSR might answer the phone when the customer calls, so this CSR must access the paused task.

The CSR must look up the customer and view a list of the task UIs that are open for the CSR when the call comes in, regardless of who started or paused that task. The CSR must take ownership of the paused task and resume it. To use this pause and transfer functionality, you must associate the task with a business object instance so that Siebel CRM can retain the current task state.

To create an association to resume or transfer a paused task UI

1. Determine where you must locate the business service step in the task UI.

   For more information, see Locating the Business Service Step in the Task UI.

2. Add a business service step to the task UI using values described in the following table.

   Property	Value
   Business Service Name	Task Administration
   Business Service Method	Associate

3. Make sure the business service step you added in the previous step is still chosen.

4. In the Multi Value Property Window, add a new input argument using values described in the following table.

   Field	Value
   Input Argument	ObjectId The ObjectId identifies the business component record that the task UI references.
   Type	Literal
   Value	Enter the RowId of the business component record that the task UI references.

5. In the Multi Value Property Window, add a new input argument using values described in the following table.

   Field	Value
   Input Argument	ObjectType The ObjectType is the name that Siebel CRM uses for the association. It uses this configuration as part of the search specification. The ObjectType is not required to match the business component name, but including it can help to keep objects synchronized.
   Type	Literal
   Value	Name of the business component that the task UI references.

6. If necessary, customize the user interface.

   For more information, see Process of Creating a View That Allows a User to Transfer a Paused Task UI.

Locating the Business Service Step in the Task UI

The task UI must call the Associate method of the Task Administration business service as early as possible in the task flow. The configuration varies depending on the following:

• The task UI creates a new record that must be associated. Siebel CRM can do this call between the view that first validates the new record and the next subsequent commit step. The user cannot view the associated record outside of the task UI before Siebel CRM saves the task transaction.

• The task UI updates an existing record. Siebel CRM must create the association with this record before it displays the first view in the task UI. In this situation, the ObjectId parameter of the Associate method typically uses the value that the Context BC Id task property contains.

Limitations of Associating a Task UI with a Long-Running Workflow Process

If a long-running workflow process creates a task UI but never starts it, then Siebel CRM cannot associate this task UI with a business object. To avoid this situation, you must configure Siebel CRM to start the task manually or automatically.

Process of Creating a View That Allows a User to Transfer a Paused Task UI

To create a view that allows a user to transfer a paused task UI, perform the following tasks:

1. Creating a New Link to Support Task Transfer

2. Modifying the Business Object to Support Task Transfer

3. Creating a Standard View to Support Task Transfer

4. Modifying a Screen to Support Task Transfer

This topic describes how to configure the user interface for a custom business object to be multicall capable, which is a configuration that allows you to define a task view on a custom screen that allows the user to view a paused task for a parent record. For example, you can add a service request view that includes a parent service request applet and a child applet that includes a list of paused inbox items. This configuration allows the user to transfer a paused task to another user from a view rather than from the Inbox Items List view.

Creating a New Link to Support Task Transfer

This task is a step in Process of Creating a View That Allows a User to Transfer a Paused Task UI. It describes how to create a new link to allow for task transfer.

To create a new link to support task transfer

1. In the Object Explorer, click Link.

2. In the Links list, create a new link using values described in the following table.

   Property	Description
   Parent Business Component	Choose the business component where you must use task transfer.
   Child Business Component	Choose UInbox Item Context.
   Source Field	Choose Id.
   Destination Field	Choose Item Context Id.
   No Update	Choose TRUE.
   No Delete	Choose TRUE.
   No Insert	Choose TRUE.
   Search Specification	Enter the following code: (LookupName('WF_INST_STAT_CD', [Task Status]) = 'PAUSED' OR LookupName('WF_INST_STAT_CD', [Task Status]) = 'TRANSFERRED') AND [Item Context Object Name] = 'object_name' where: object_name is the name you use to associate the task UI. This name must match the string that you use in the definition of the task UI when you associate this task with the business object. It does not need to match the name of the business object.

   For more information, see Resuming a Paused Task UI.

3. Right-click the new link, choose Validate, and then click Start.

Modifying the Business Object to Support Task Transfer

This task is a step in Process of Creating a View That Allows a User to Transfer a Paused Task UI.

This topic describes how to modify the business object to support task transfer.

To modify the business object to support task transfer

1. In the Object Explorer, click Business Object.

2. In the Business Objects list, query the Name property for the business object where you must use task transfer.

3. In the Object Explorer, expand the Business Object tree, and then click Business Object Component.

4. In the Business Object Components list, create a new business object component using values described in the following table.

   Property	Description
   Bus Comp	Choose UInbox Item Context.
   Child Business Component	Choose the new link.

5. Right-click the business object, choose Validate, and then click Start.

Creating a Standard View to Support Task Transfer

This task is a step in Process of Creating a View That Allows a User to Transfer a Paused Task UI.

This topic describes how to create a new standard view to allow for task transfer.

To create a standard view to support task transfer

1. In Siebel Tools, choose the File menu, and then the New Object menu item.

2. In the New Object Wizards dialog box, on the General tab, choose View, and then click OK.

3. Follow the prompts in the wizard to define the new view, using values described in the following table.

   Property	Description
   Business Object	Choose the business object that you modified in the Modifying the Business Object to Support Task Transfer topic.
   View Name	Enter a descriptive name for the view. For example, ObjectName - Paused Tasks.
   Upgrade Behavior	Choose Preserve. This setting preserves this modification during an upgrade.
   Web Template	Choose a master and detail template. For example, View Basic.
   Master Applet	Choose a master applet according to the master business component that is defined.
   Child Applet	Choose Task Item Context List Applet.

4. Edit the Web layout, as necessary.

5. Right-click the new view, choose Validate, and then click Start.

Modifying a Screen to Support Task Transfer

This task is a step in Process of Creating a View That Allows a User to Transfer a Paused Task UI. This topic describes how to modify a screen to support task transfer.

To modify a screen to support task transfer

1. In the Object Explorer, click Screen.

2. In the Screens list, query the Name property for the screen where you must define the task transfer view.

3. In the Object Explorer, expand the Screen tree, and then click Screen View.

4. In the Screen Views list, add a new screen view using values described in the following table.

   Property	Description
   View	Choose the view that you modified in the Creating a Standard View to Support Task Transfer topic.
   Sequence	Define a sequence that correctly positions this view on the site map.
   Type	Choose Detail View.
   Parent Category	Choose a value.
   Viewbar Text	Define a value. For example, for a task UI, you can use the following symbolic string: SBL_TASKS-1004224752-2S0
   Menu Text	Define a value. For example, for a task UI, you can use the following symbolic string: SBL_TASKS-1004224752-2S0
   Display In Page	Choose TRUE.
   Display In Site Map	Choose TRUE.
   Upgrade Behavior	Choose Preserve. This setting preserves this modification during an upgrade.

5. Right-click the new record in the Screen Views list, choose Validate, and then click Start.

6. Compile your modifications and then deploy the task UI.

7. Make sure you can access the new view while you use the responsibilities.

Modifying a Task UI to Display a Message That Is Specific to a Task Instance

In some situations, you might need to display a message that is specific to a task instance in the Inbox Items List view. For example:

• Information that helps the instance owner to distinguish between instances that include the same task name.

• Instructions that the current instance owner requires to complete the task UI.

• A timestamp.

You can modify a task UI to display a message that is specific to a task instance. Siebel CRM displays this message in the Inbox Context field in the Inbox Items List view. If the user pauses or finishes a task UI, then Siebel CRM displays information from the Instance Identifier task property in this context field.

The following conditions apply:

• You can use an expression for the Instance Identifier.

• The Instance Identifier property is limited to 200 characters in length.

• You can define the instance identifier only on a task step where you can define an output argument. For more information, see Arguments of a Task Step.

• If the user clicks Pause on the first view, then Siebel CRM does not display information from the Instance Identifier.

To modify a task UI to display a message that is specific to a task instance

1. Add an output argument to a task UI step.

2. In the Multi Value Property Window, click the Property Name field for the output argument, and then pick Instance Identifier from the Property Name dialog box.

3. Define the remaining fields in the same way that you define a typical output argument.

Creating a Subtask

You create a new subtask in the same way as you create a parent task UI. The only difference is that you must make sure the value for the Is Subtask property includes a check mark. If you use the Task Wizard, then make sure the Create As a Subtask option includes a check mark. For more information, see Creating a Subtask Step.

Defining the Context for a Task Step

You can create a search specification on a Siebel operation step or a task view step that filters data. You define a Task Step Context object, which is a child of the Task Step object type. For more information, see Siebel Object Types Reference.

To define the context for a task step

1. Open the Task Editor.

   For more information, Opening the Task Editor.

2. In the Task Editor, choose a Siebel operation step or a task view step.

3. In the Multi Value Property Window, click the Task Step Context tab.

4. Right-click the list area in the Multi Value Property Window, and then choose New Record.

5. Enter a Name for the task step context, and then choose a Type.

   If you set Type to Expression, then enter the name of a business component in the Expression Business Component field.

6. Enter a Search Specification for the context.

   Caution: It is recommended that you define the search specification for the Siebel operation step as efficiently as possible so that the specification matches only the smallest set of rows that are necessary to meet the business requirement. A search specification that identifies a large set of rows can severely degrade performance.

   • If you set the Type field to Literal, then enter a literal value in the form of an expression. For example, enter the following text:

     = 100
     

   • If you set the Type field to Expression, then enter an expression. For example, enter the following text:

     [Status] LIKE '*Open*'
     

     The Expression Business Component evaluates the expression. For example, you might use the following search specifications for a Siebel operation step that performs a query operation:

     "Repeatable " + timestamp()
     "Iteration " + [&Iteration]
     

   The Expression Builder does not examine the format. Make sure you enter an expression that includes the correct format.

7. Optional. Create a filter business component.

   For more information, see How Siebel CRM Uses a Filter Business Component.

Example of Defining the Context for the Step of a Task UI

The following image illustrates an example that includes an update operation.

In this example, the OptyListView task view step lists records in the Opportunity business component. The Siebel operation step named Update Revenue does the following:

• Performs an update operation on the Opportunity business component.

• Includes an input argument named Primary Revenue Amount of type Literal with a value of 50000.

If the user clicks Query, sets a criteria, and clicks Go, then Siebel CRM refreshes the view to display only the records that meet the query criteria. For example, the user might query for all records that includes a Lead Quality that is set to poor. If the user chooses one of these records and clicks Submit, then Siebel CRM sets the revenue amount to 50000 for the record in the Opportunity business component.

How Siebel CRM Uses a Filter Business Component

A filter business component provides the group of records where Siebel CRM performs the context search. Siebel CRM uses the following logic to identify the records that it displays:

• If the Is User Search Spec property is FALSE, then the user can only query records that Siebel CRM displays in the view, by default.

• If the Is User Search Spec property is TRUE, then the user can query all records. The Search Specification property determines the default records.

The following table describes example properties of a context search. In this example, the Is User Search Spec property is FALSE, so Siebel CRM displays only the records that include Opty as part of the name.

Table Example Properties for a Context Search

Property	Value
Name	Opportunity
Type	Literal
Expression Business Component	Opportunity
Filter Business Component	Opportunity
Search Specification	[Name] like 'Opty*'
Is User Search Spec	FALSE

Creating a Task Event

A task event is an optional object type that you can define for a task UI. You can define the following task events:

• Pause

• Resume

• PreCancel

• PostCancel

• PostComplete

• Delete

For more information, see About Event Handling, and Siebel Object Types Reference.

To create a task event

1. If necessary, display the Task object hierarchy.

   For more information, see Displaying Object Types You Use to Develop a Task UI.

2. Locate the task UI you must modify.

   For more information, see Locating a Task UI in the Tasks List.

   You cannot configure a subtask to reference an event. If the Is Subtask property of the task UI is set to TRUE, then you cannot add a task event to this task.

3. In the Object Explorer, expand the Task tree, and then click Task Event.

4. In the Task Events list, create a new task event:

   1. In the Name property, choose a name.

   2. Identify a business service or a workflow process to handle the event.

      For more information, see Specifying a Business Service or a Workflow Process to Handle a Task Event.

   3. Optional. Define input arguments and output arguments for the event.

      For more information, see Creating Input Arguments and Output Arguments for a Task Event.

Specifying a Business Service or a Workflow Process to Handle a Task Event

You can specify a business service or a workflow process to handle a task event.

To specify a business service or a workflow process to handle a task event

1. In the Task Events list, locate the task event you must modify.

2. Specify a business service or a workflow process to handle the task event:

   • To use a business service to handle the event, do the following:

     • Define the Business Service Name property.

     • Define the Business Service Method property.

   • To use a workflow process to handle the event, choose the name of the workflow process in the Workflow Process property.

     If the Workflow Process property includes a value, then Siebel Tools ignores the Business Service Name and Business Service Method properties and the workflow process handles the event.

     If you choose Workflow Process to handle the event, then you cannot define input arguments and output arguments. To use a workflow process as a handler for a business service, you define the following properties:

     Property	Value
     Business Service	Workflow Process Manager
     Method	RunProcess

     For more information, see Using a Business Service Step to Call a Workflow Process.

Creating Input Arguments and Output Arguments for a Task Event

You can create input arguments and output arguments for a task event.

Creating an Input Argument for a Task Event

This topic describes how to create an input argument for a task event that uses a business service.

To create an input argument of a task event

1. Locate the task UI you must modify.

   For more information, see Locating a Task UI in the Tasks List.

2. In the Object Explorer, expand the Task tree, and then click Task Event.

3. In the Task Events list, locate the task event you must modify.

4. In the Object Explorer, expand the Task Event tree, and then click Task Event IO Argument.

5. In the Task Event IO Arguments list, add a new task event IO argument.

6. In the Input/Output property, choose Input.

   Do not modify the Name property. Name is a system defined property.

7. In the Argument property, choose the name of an argument.

   The picklist displays the input arguments that are available for the business service method that Siebel Tools displays in the Business Service Method property of the parent task event. You choose an argument, and then Siebel Tools enter data in the Name property.

8. In the Type property, choose a source type.

   You can choose one of the following values:

   • Business Component

   • Expression

   • Literal

   • Task Property

   The type you choose identifies the source for the value of the input argument.

9. Define the remaining properties, according to the Type you chose in the previous step. Use values from the following table.

   Type	Description
   Business Component	Do the following work: Choose a business component in the Business Component property. Choose a business component field in the Business Component Field property.
   Expression	Use the Value property to define an expression. Siebel CRM evaluates this expression at run time to determine the value that it uses for the input argument.
   Literal	Use the Value property of the input argument to define a literal value. for the input argument, Siebel CRM.
   Task Property	Choose a task property in the Property Name property.

   Siebel Tools disables properties that are not applicable for the type you choose.

Creating an Output Argument for a Task Event

This topic describes how to create an output argument for a task event that uses a business service.

To create an output argument for a task event

1. Locate the task UI you must modify.

   For more information, see Locating a Task UI in the Tasks List.

2. In the Object Explorer, expand the Task tree, and then click Task Event.

3. In the Task Events list, choose the task event you must modify.

4. In the Object Explorer, expand the Task Event tree, and then click Task Event IO Argument.

5. In the Task Event IO Arguments list, add a new task event IO argument.

6. In the Input/Output property, choose Output.

   Do not modify the Name property. The Name property is a system defined property.

7. In the Type property, choose a source type.

   You can choose one of the following values:

   • Business Component

   • Expression

   • Literal

   • Output Argument

   The type you choose identifies the source for the value of the output argument.

8. Define the following properties, according to the Type you chose in the previous step:

   • Business Component

   • Expression

   • Literal

   • Output Argument

   For more information, see How the Type Field Affects Other Fields in the Multi Value Property Window.

   Siebel Tools disables properties that are not applicable for the type you choose.

9. In the Property Name property, choose the name of a task property.

   For example, to enter the value of the output argument in the Object Id task property, choose Object Id.

Using a Business Service Step to Call a Workflow Process

You can use a business service step to call a workflow process.

To use a business service step to call a workflow process

1. Add a business service step to a task UI using values from the following table.

   Property	Value
   Business Service	Workflow Process Manager
   Method	RunProcess

2. In the Multi Value Property Window, add an input argument to the business service step you added in the previous step using values from the following table.

   Property	Description
   Input Argument	Choose ProcessName.
   Type	Choose Literal.
   Value	Enter the name of the workflow process.

3. Define more input arguments, as necessary.

   To pass a value from a task UI to a workflow process, the input argument must use the same name as the process property of the workflow process. For more information, see Creating the Arguments of a Task Step and Siebel Business Process Framework: Workflow Guide.

Other Options for Customizing a Task UI

This topic describes optional UI objects you can create for a task UI. It includes the following topics:

• Specifying the Operations That Users Can Perform in an Applet

• Creating a Task Chapter

• Creating a Radio Button Group

• Creating an Applet Message

• Reusing a Standard Applet

• Hiding the Task Pane

• Enabling the Task Progress Indicator

Specifying the Operations That Users Can Perform in an Applet

Siebel CRM applies some restrictions on the operations that a user can do in an applet, such as No Insert, No Update, and so on. You can modify these restrictions. If you set the EnableStandardMethods applet user property to TRUE, then the following occurs:

• Siebel CRM applies the restrictions that it defines on the applet.

• The user can use the applet to modify a record that Siebel CRM displays in a task view the same way that this user modifies this record in a predefined view. For example, the user can do a query, advance the record pointer, edit multiple records simultaneously, and so on.

The user cannot do a MergeRecord operation in a list applet on a task view even if you set the EnableStandardMethods user property to TRUE.

For more information, see Operations That Siebel CRM Allows in Applets.

To specify the operations that users can perform in an applet

1. Log in to Siebel Tools.

2. If necessary, display the Applet User Prop object.

   For more information, see Displaying Object Types You Use to Develop a Task UI.

3. In Siebel Tools, in the Object Explorer, click Applet.

4. In the Applets list, query the Name property for the applet you must modify.

5. In the Object Explorer, expand the Applet tree, and then click Applet User Prop.

6. In the Applet User Properties list, create a new record using values in the following table.

   Property	Value
   Name	EnableStandardMethods
   Value	TRUE

Creating a Task Chapter

This topic describes how to create a task chapter. For more information, see Task Chapter.

To create a task chapter

1. Create a task chapter:

   1. Open the task UI you must modify in the Task Editor.

      For more information, see Using the Task Editor

   2. Right-click the canvas, and then choose Show Chapters.

      Any colors in the task UI steps disappear, leaving the task steps neutral (or colored white).

   3. In the Multi Value Property Window, click the Chapters tab.

   4. Right-click in the list area of the Multi Value Property Window, and then choose New Record.

   5. Define a value in the Name property.

   6. Define a value for the Display Name - String Reference property.

      Siebel CRM displays this value as the task chapter title in the Siebel client. To display a custom value, do the following work:

      • Define a value in the Display Name - String Override property.

      • Leave the Display Name - String Reference property empty.

   7. Choose a color from the pop-up Color applet, and then click OK.

   8. Choose a Sequence.

      Siebel Tools sorts the records in the Chapters tab according to the sequence number, by default. If you define a new chapter, then Siebel Tools sets the Sequence property to the next available number in the series. For example, 10, 20, 30, and so on. If you define more chapters in a task UI, then you can insert new chapters in the sequence without having to renumber the sequence. For example, you could insert 25 between 20 and 30.

      If you define a chapter but you do not assign a task step to this chapter, then Siebel Tools creates an error when you validate the task UI.

2. Assign task steps to a task chapter:

   1. Right-click a step in the Task Editor, and then choose Assign Chapter.

      To simultaneously assign multiple steps to a chapter, you can depress the shift key as you click each step that you must include in the chapter.

   2. Choose a chapter, and then click OK.

      Siebel Tools limits the list to the task chapters that are defined in the task UI.

   3. Repeat the previous two substeps until you have assigned each step in the task UI to a chapter.

      Although using chapters is not required, if you assign one step in a task UI to a chapter, then you must assign every step in the task to a chapter.

   4. Save your work.

Deleting a Task Chapter

You can delete a task chapter.

To delete a task chapter

1. In the Multi Value Property Window, click the Chapters tab.

2. Right-click the chapter you must delete, and then choose Delete Record.

Siebel Tools removes the chapter assignment from the applicable steps in the Chapters view. The steps remain but Siebel Tools does not assign them to a chapter.

Creating a Radio Button Group

The user can use the radio button group to make a choice in a task UI. The input that the radio button receives can determine the next step of a task, or it can determine the data that Siebel CRM gets and then displays in the subsequent task view. For more information, see Radio Button Group.

To create a radio button group

1. In Siebel Tools, create a field on the business component that supplies data for the radio button group.

2. Optional. Define a predefault value for the field you created in the first step.

   For more information, see Defining the Default Value for a Radio Button Group.

3. In the Object Explorer, click Pick List.

4. Right-click in the Picklists list, and then choose New Pick List Wizard.

5. Follow the prompts in the New Pick List Wizard, define the Pick List, and then choose or define the LOV.

6. Make sure the Business Component property of the new picklist is set to PickList Generic.

7. Configure the business component field you defined in the first step to reference the picklist:

   1. In the Object Explorer, click Business Component.

   2. In the Business Components list, query the Name property for the business component.

   3. In the Object Explorer, expand the Business Component tree, and then click Field.

   4. In the Fields list, query the Name property for the field.

   5. In the Picklist property, choose the new picklist.

8. In the Object Explorer, click Applet.

9. In the Applets list, query the Name property for the applet where you must add the radio button group.

   Siebel CRM cannot display a radio button group in a list applet. If you define a radio button group in a list applet, then Siebel CRM displays a radio button as a text entry field in the Siebel client.

10. In the Object Explorer, expand the Applet tree, and then click Control.

11. In the Controls list, create a new control using values from the following table.

    Property	Description
    Name	Enter text that describes the control.
    Field	Choose the field that you defined for the radio button group.
    HTMLType	Choose RadioButton.

Defining the Default Value for a Radio Button Group

Setting a default value for a radio button group allows you to set the choice that Siebel CRM displays in this group. Setting the default value for a radio button group is optional. If you set a default value, then make sure you choose the default value carefully. If you do not explicitly define a default value, then Siebel CRM displays the first value that the LOV lists in alphabetic, ascending order.

To define the default value for a radio button group

1. In the Object Explorer, click Business Component.

2. In the Business Components list, query the Name property for the business component that the applet references.

3. In the Object Explorer, expand the Business Component tree, and then click Field.

4. In the Fields list, query the Name property for the field that supplies data to the radio button group.

5. In the Predefault Value property, define the default value for the radio button group.

   Only one default value can exist for a radio button group.

Creating an Applet Message

An applet message allows you to combine static text and dynamic data in a message that Siebel CRM displays in the Siebel client. You can place an applet message in an applet. For more information, see Applet Message.

To create an applet message

1. If necessary, display the applet message and symbolic string object types, and their child object types.

   For more information, see Displaying Object Types You Use to Develop a Task UI.

2. In Siebel Tools, define a symbolic string that includes the text of the applet message:

   1. In the Object Explorer, click Symbolic String.

   2. In the Symbolic Strings list, create a new symbolic string.

      In the Current String Value property, use %1, %2, and so on as placeholders for the dynamic data. Make sure you use an ascending number sequence to avoid a run-time error. For example, use %1, %2, %3, and so on.

3. In the Object Explorer, click Applet.

4. In the Applets list, query the Name property for the applet where you must define the applet message.

5. In the Object Explorer, expand the Applet tree, and then click Applet Message.

6. In the Applet Messages list, add an applet message object to the applet:

   1. In the Text Message property, choose the symbolic string you defined in a previous step.

   2. Define the other properties, as necessary.

7. In the Object Explorer, expand the Applet Message tree, and then click Applet Message Variable.

8. In the Applet Message Variables list, define one record for each value that Siebel CRM must substitute in the applet message:

   1. In the Value property, enter a substitution number.

      For example, enter the number 1 to represent the %1 substitution you defined in a previous step.

   2. In the Field property, choose the business component field whose value must display for the placeholder in the message.

   3. Define the other properties, as necessary.

      For example, the following configuration causes Siebel CRM to substitute the %1 placeholder in the applet message with the value of the Opportunity Name field:

      Property	Value
      Value	1
      Field	Opportunity Name

9. Define the layout of the applet message.

   For more information, see Defining the Layout of the Applet Message.

Defining the Layout of the Applet Message

This topic describes how to define the layout of the applet message.

To define the layout of the applet message

1. In the Object Explorer, click Applet.

2. In the Applets list, query the Name property for the applet where you must define the applet message.

3. In the Object Explorer, expand the Applet tree, and then click Control.

4. In the Controls list, add a new control for the applet message you created in Creating an Applet Message using values from the following table.

   Property	Description
   Field	Enter the name of the applet message.
   Field Type	Choose Message.

5. Right-click in the Applets list, and then choose Edit Web Layout.

6. Select and (without releasing the selection) move a Label control from the Palette to the applet grid layout. Place this control where Siebel CRM must display the applet message.

7. Optional. To modify the width of a control for text, do the following work:

   1. Position the mouse over the border (or edge) of the control so that Siebel Tools changes the cursor to a line that includes arrows at each end of the line.

   2. Left-click and hold down the mouse button.

   3. To modify the size of the control, move the cursor.

      The text in the control wraps in the edit and preview modes. Siebel CRM wraps the applet message text in the Siebel client at run time. This message includes the dynamic text that replaces the placeholder text.

8. In the Properties window, set the HTML Display Mode property to FormatData.

   Setting the HTML Display Mode property to FormatData allows line returns and spacing in the text string.

9. Optional. If you did not enter text for the message when you defined the applet message, then you can enter it now:

   1. Double-click the control.

   2. In the text box in the layout editor, enter the text for the message.

Writing an Independent Message

An applet message uses a symbolic string, so you cannot predict with precision how Siebel CRM renders the message at run time. You must write the message so that it forms a sentence that is grammatically correct and that is less than 250 characters in length. Do not write a message that depends on the symbolic string to concatenate the message. For example, to instruct the user to make sure data is complete, you can write the following message:

Make sure the information you enter is complete.

Do not write the following:

Make sure the information

Reusing a Standard Applet

If the applet you use in a task UI does not interact with transient data, then, as an option, you can copy and modify a standard, predefined applet instead of creating a new one. For more information, see Overview of Transient Data.

To reuse a standard applet

1. Identify a standard applet:

   1. In the Siebel client, examine the Siebel application for an applet that closely matches your display requirements.

   2. Locate a candidate applet.

   3. Choose the Help menu, and then the About View menu item.

   4. Note the value in the Applets section.

      If Siebel CRM lists more than one applet, then note the applet name that most closely matches the functionality of the candidate applet.

   5. In Siebel Tools, query the Name property of the Applets list for the applet you identified previously.

   6. Right-click in the Applets list, and then choose Edit Web Layout.

   7. Verify that the layout resembles the applet you identified previously.

   8. Close the Web Layout Editor.

2. Copy a standard applet:

   1. Right-click in the Applets list, and then choose Copy Record.

      Siebel Tools performs a cascade copy of the applet. You can view the status bar that Siebel Tools displays along the end of the Siebel Tools user interface to monitor the status of the copy operation. Siebel Tools finishes the copy, and then displays the new record in the Applets list and places the cursor in the Name property.

   2. In the Name property, enter a name for your custom applet that indicates how the user uses the applet.

      For example, Account Entry for task UI.

   3. If necessary, define the Project property.

   4. Right-click in the Applets list, and then choose Edit Web Layout.

   5. In the Applet Web Template window, delete unnecessary controls.

      Task UI is intended to simplify the user interface, so it is recommended that you remove controls and labels that the user does not require to finish the task. Make sure you do not delete fields that the user requires to finish the task. For example, an insert operation for an opportunity requires the following fields:

      • Opportunity Name

      • Close Date

      • Currency

   6. In the Applet Web Template window, reposition controls and their labels until the applet resembles the required layout for the task UI.

   7. Save your work, and then close the Applet Web Template window.

Hiding the Task Pane

Siebel CRM automatically displays the Task Pane, by default. Siebel CRM does the following work if you configure it to hide the Task Pane:

• Hides the Task Pane for any task UI, including any completed, paused, or cancelled task instance. This hiding persists even if the user logs out and then logs back in to the client. Siebel CRM also hides any features that it normally displays in the Task Pane, such as the Task Progress Indicator.

• Disables the shortcut key for the Task Pane. This shortcut key is Ctrl + Shift + Y.

If you configure a Siebel application to hide the Task Pane, then no users can use the Task Pane to start a task UI in this application. Other ways exist to start a task UI. For more information, see Starting a Task UI.

For more information, see About the Task Pane.

To hide the Task Pane

1. Log in to Siebel Tools.

2. Display the Application User Prop object type.

   For more information, see Displaying Object Types You Use to Develop a Task UI.

3. In the Object Explorer, click Application.

4. In the Applications list, locate the Siebel application you must modify.

5. In the Object Explorer, expand the Application tree, and then click Application User Prop.

6. In the Application User Props list, create a new record using values from the following table.

   Property	Description
   Name	HideTaskPane
   Value	True

7. Compile your modifications.

8. In the Siebel client, test your modifications.

Enabling the Task Progress Indicator

This topic describes how to enable the Task Progress Indicator. For more information, see About the Task Progress Indicator.

To enable the Task Progress Indicator

1. Use a text editor to open the configuration file (.cfg) for the Siebel application.

   For example, to open the configuration file for Siebel Call Center, navigate to the following directory, and then open the uagent.cfg file:

   D:\Siebel\81\21031\MWC\BIN\ENU
   

2. Set the EnableTaskProgress parameter in the following Task section:

   [Task]
   EnableTaskProgress = TRUE
   

   If you set EnableTaskProgress to FALSE, or if it is not defined, then Siebel Task UI does not display the Task Progress Indicator.

3. Log in to the Siebel client.

4. Optional. ConfigureSiebel Task UI to display the task percentage:

   1. Navigate to the Administration - Business Process screen, and then the Task Deployment view.

   2. Query the Name column for the task UI you must modify.

   3. Click Compute Percentage.

5. Navigate to a view that includes the task UI that must display the Task Progress Indicator

6. Verify that Siebel Task UI displays the Task Progress Indicator.