16Developer’s Reference for Siebel Clinical

Developer’s Reference for Siebel Clinical

This chapter contains information about configuring and customizing Siebel Clinical using Siebel Tools and about customizing Siebel Clinical Web services. It assumes that you are familiar with the processes and conventions of working with Siebel Tools to change object properties. For more information about changing properties in Siebel Tools, see Configuring Siebel Business Applications.

This chapter includes the following topics:

About Using the Siebel REST API with Siebel Clinical

You can use the Siebel CRM Representational State Transfer (REST) application programming interface (API) to create, synchronize, and delete Siebel Clinical users. For more information about Siebel REST API and about using Siebel REST API with Siebel Clinical, see Siebel REST API Guide.

You can also use the Siebel REST API to invoke business services using Siebel server script techniques. For more information, see Using Siebel Tools.

When you create or synchronize Siebel Clinical users, you can pass default position and responsibility information in the REST API response by configuring the LS Clinical User Provisioning Service Business method. For more information, see the topic about configuring Siebel Clinical users in Siebel REST API Guide.

Overview of User Properties for Siebel Clinical

User properties are object definitions that are children of an applet, business component, control, field, or list column, and configure specialized behavior beyond the configuration in the properties of the parent object definition.

User properties drive some Siebel Clinical functionalities. You can customize these functionalities through their respective user properties. With user properties, you can control the behavior of the user interface, change default settings or leave them as they are, and enable or disable functionalities.

This chapter lists user properties that are specific to Siebel Clinical. For more information about user properties and user properties that apply to all Siebel Business Applications, see Siebel Developer's Reference.

User Properties for Business Components in Siebel Clinical

The following table describes the business component user properties that you can use to enable and configure functionality for Siebel Clinical.

Table User Properties for Business Components in Siebel Clinical

User Property

Business Component

Description

Apply Templates WorkFlow Process Name

LS Subject Schedule Date VBC

This property defines the workflow process that is invoked when the Enroll Screen Rescreen Through WorkFlow property is set to Y, and when the Disable Delete Non App Visit property is set to N.

The default value is LS Clinical - ApplyTemplates Process.

If the user clicks No on the pop-up message that the Disable Delete Non App Visit property enables, then LS Clinical - ApplyTemplates Process is invoked, and the subject visit template is applied.

Automatic Missed Status Tracking

Visit Plan

This property configures whether or not Missed status is automatically tracked in the Subject Status MVG (multi value group) for status tracking visits. You configure the status tracking visit for each visit type in the subject visit template.

Configure this property as follows:

  • To enable automatic tracking of Missed status for status tracking visits, set the value to Y.

  • To disable automatic tracking of Missed status for status tracking visits, set the value to N.

The default value is Y.

Completed Status Code

Visit Plan

This property configures automatic status tracking.

The default value follows is Completed.

Note: Do not change this value.

Date RollUp Fields:Protocol n

Clinical Protocol Site

This property configures automatic rollup of the Last Subject Off Study date from the site record to the protocol record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
 Name>", "<Sort Order>"

The value is set as follows:

"Last Subject Off Study Date", "Last Subject 
Off StudyDate", "(DESCENDING)"
Note: Do not change this value.

Date RollUp Fields:Region n

Clinical Protocol Site

This property configures automatic rollup of the Last Subject Off Study date from the site record to the region record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Sort Order>"

The value is set as follows:

"Last Subject Off Study Date", "Last Subject
Off Study Date", "(DESCENDING)"
Note: Do not change this value.

Delete NonApp WorkFlow Process Name

LS Subject Schedule Date VBC

This property defines the workflow process that is invoked when the Enroll Screen Rescreen Through WorkFlow property is set to Y, and when the Disable Delete Non App Visit property is set to N.

The default value is LS Clinical - DeleteNonAppVisits Process.

If the user clicks OK on the pop-up message that the Disable Delete Non App Visit property enables, then LS Clinical - DeleteNonAppVisits Process is invoked to delete incomplete clinical visits in the previous version of a subject visit template.

Disable Delete Non App Visit

Clinical Subject

This property turns on or off deletion of non applicable clinical subject visits. When users schedule clinical subject visits using a revised subject visit template, a pop-up message appears to confirm if incomplete visits in the previous template version must be deleted, and if complete visits in the new template version must be deleted. Clicking OK in the pop-up message deletes the non applicable subject visits. Clicking Cancel retains the non applicable subject visits.

Configure the value as follows:

  • To enable deletion of non applicable subject visits, set the value to N.

  • To disable deletion of non applicable subject visits, set the value to Y.

The default value is N.

Enroll Screen Rescreen Through WorkFlow

LS Subject Schedule Date VBC

This property specifies whether subject visit scheduling tasks are executed through workflows or business component methods.

Configure the value as follows:

  • To execute subject visit scheduling tasks through workflows, set the value to Y.

  • To execute subject visit scheduling tasks through business component methods, set the value to N.

The default value is N.

You configure the workflows that execute the scheduling tasks in the following business component properties:

  • WorkFlow Process Name

  • Apply Templates WorkFlow Process Name

  • Delete NonApp WorkFlow Process Name

Last Subject Off Study Date Rollup Status n

Clinical Protocol Site

This property identifies the qualified subject statuses that are used to populate the date in the Last Subject Off Study field. By default the following statuses are set:

  • Completed

  • Early Terminated

LS Amount Rollup Field 1

Clinical Payments

This property configures automatic rollup of Amount Paid To Date from the payment record to the site record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Rollup Parent Buscomp Name>"

The value is set as follows:

"Amount Paid To Date", "Amount Paid To Date",
"Rollup Parent Buscomp Name"
Note: Do not change this value.

LS Amount Rollup Field 2

Clinical Payments

This property configures automatic rollup of Amount Earned To Date from the payment record to the site record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Rollup Parent Buscomp Name>"

The value is set as follows:

"Amount Earned To Date", "Amount Earned To
Date", "Rollup Parent Buscomp Name"
Note: Do not change this value.

LS Amount Rollup Field 3

Clinical Payments

This property configures automatic rollup of VAT amounts from the payment record to the site record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Rollup Parent Buscomp Name>"

The value is set as follows:

"VAT Amount", "VAT Amount", "Rollup Parent
Buscomp Name"
Note: Do not change this value.

LS Amount Rollup Field 3

Clinical Protocol Site

This property configures automatic rollup of VAT amounts from the site record to the region record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Rollup Parent Buscomp Name>"

The value is set as follows:

"VAT Amount", "VAT Amount", "Rollup Parent 
Buscomp Name"
Note: Do not change this value.

LS Amount Rollup Field 3

Clinical Region

This property configures automatic rollup of VAT amounts from the region record to the clinical protocol record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Rollup Parent Buscomp Name>"

The value is set as follows:

"VAT Amount", "VAT Amount", "Rollup Parent 
Buscomp Name"
Note: Do not change this value.

LS Amount Rollup Field 3

Clinical Protocol

This property configures automatic rollup of VAT amounts from the protocol record to the program record.

The value takes the following parameters:

"<Source BC Field Name>", "<Target BC Field
Name>", "<Rollup Parent Buscomp Name>"

The value is set as follows:

"VAT Amount", "VAT Amount", "Rollup Parent 
Buscomp Name"
Note: Do not change this value.

LS Amount Rollup On Status 1

Clinical Payments

This property defines the payment status values that are used to calculate the Paid to Date amount.

By default, only payments with a status of Paid are used to calculate the Paid to Date amount.

This property takes a comma delimited list of values as follows:

"Amount Paid to Date","Paid"

LS Clinical Enable Revert On Status

Clinical Payments

This property defines the payment status values for which the Revert button is enabled.

The value takes a comma delimited list of payment statuses as follows:

"<Status1>", "<Status2>"

By default, the Revert button is enabled for the following payment Status values:

  • In Progress

  • To Be Processed

LS Subject Terminate Study Status Value 1

Clinical Subject Status

This property turns on or off the deletion of incomplete future visits for a subject. These incomplete visits are visits for which the date associated with the subject status has a value, the Completed field for the visit is not selected, and the date in the Date field of the visit is later than the date associated with the subject status. When enabled, the incomplete future visits are deleted if the status of the subject is a value in this property.

By default, this property includes the following values:

  • Screen Failure

  • Early Terminated

Missed Status Code

Visit Plan

This property configures automatic status tracking.

The value is set to Missed.

Note: Do not change this value.

Named Method 1

Action (No Owner Lock)

This property generates payment records.

The value string is set as follows:

"GenerateNewPayment", "INVOKESVC", "Action(No
Owner Lock)", "LS SubjectVisits Service", 
"GeneratePayment", "'Site Id'", "[Protocol 
Site Id]", "'srcBusComp'", "'Action (No Owner
Lock)'", "'srcBusObj'", "'Clinical Protocol
Site'", "'tgtBusObj'", "'Clinical Payments'",
"'tgtBusComp'", "'Clinical Payments'"
Note: Do not change this value.

Named Method 1

LS Clinical Subject Status Snapshot

This property generates the subject status snapshot for a clinical site.

The value string is set as follows:

"SiteSnap", "INVOKESVC", "LS Clinical Subject
Status Snapshot", "LS Clinical Trip Report 
Svc", "GetSiteSnapshot", '"SVId"', 
"ParentFieldValue('Id')"
Note: Do not change this value.

Named Method 2

Clinical Trip Report

This property turns on or off approver verification for trip reports. When enabled, the User Verification screen is launched during the approval process for trip reports to verify the user logon credentials of the approver.

Configure the value as follows:

  • To enable this property, set the value as follows:

    "ValidateUser", "INVOKESVCSEL", "Clinical
    Trip Report", "Workflow Process Manager",
    "RunProcess", "ProcessName", "LS Clinical 
    Trip Report Approval", "RowId", "[Id]", 
    "Enable Verification", "Y"
  • To disable this property, set the value as follows:

    "ValidateUser", "INVOKESVCSEL", "Clinical
    Trip Report", "Workflow Process Manager",
    "RunProcess", "ProcessName", "LS Clinical
    Trip Report Approval", "RowId", "[Id]", 
    "Enable Verification", "N"

This property is disabled by default, and cannot be null.

Note: Customers who do not have a license for Siebel Tools can use the CL – Verify TripReportApprover system preference to configure this functionality. For more information about configuring system preferences, see System Preferences in Siebel Clinical.

Named Method n

Clinical Protocol Site for Popup

This property associates accounts, activities, and documents for clinical protocols and clinical regions with sites. It specifies the method (for example, ProtocolAccountRolldownToSite) for the appropriate popup applet, the underlying business component (Clinical Protocol Site for Popup) for that applet, the method (ApplyRolldown) in that business component that calls the rolldown business service (LS Clinical Record Rolldown Service), and the appropriate user property (for example, Protocol Account To Site Rolldown) as the input argument for the business service.

To associate accounts for clinical protocols with sites, set the value string as follows:

"ProtocolAccountRolldownToSite", "INVOKESVC",
"Clinical Protocol Site for Popup", "LS 
Clinical Record Rolldown Service",
"ApplyRolldown", "UserPropertyName", 
"Protocol Account To Site Rolldown"

To associate accounts for clinical regions with sites, set the value string as follows:

"RegionAccountRolldownToSite", "INVOKESVC",
"Clinical Protocol Site for Popup", "LS 
Clinical Record Rolldown Service", 
"ApplyRolldown", "UserPropertyName", "Region 
Account To Site Rolldown"

To associate activities for clinical protocols with sites, set the value string as follows:

"ProtocolActivityRolldownToSite", "INVOKESVC",
"Clinical Protocol Site for Popup", "LS
Clinical Record Rolldown Service", 
"ApplyRolldown", "UserPropertyName", 
"Protocol Activity To Site Rolldown"

To associate activities for clinical regions with sites, set the value string as follows:

"RegionActivityRolldownToSite", "INVOKESVC", 
"Clinical Protocol Site for Popup", "LS 
Clinical Record Rolldown Service", 
"ApplyRolldown", "UserPropertyName", "Region
Activity To Site Rolldown"

To associate documents for clinical protocols with sites, set the value string as follows:

"ProtocolDocumentRolldownToSite", "INVOKESVC",
"Clinical Protocol Site for Popup", "LS
Clinical Record Rolldown Service", 
"ApplyRolldown", "UserPropertyName", 
"Protocol Document To Site Rolldown"

To associate documents for clinical regions with sites, set the value string as follows:

"RegionDocumentRolldownToSite", "INVOKESVC",
"Clinical Protocol Site for Popup", "LS
Clinical Record Rolldown Service", 
"ApplyRolldown", "UserPropertyName", "Region 
Document To Site Rolldown"

Status Field RollUp n

Clinical Subject Status

This property collates subject numbers for each status value. You can also configure it to collate subjects status and visit type value pairs. The subject accruals data is rolled up to the site record.

The following comma-delimited parameter configurations are supported:

  • "[Subject Status]", "[Business Component Field Name]", "[Visit Type]"

  • "[Subject Status]", "[Business Component Field Name]", "[Null]"

  • "[Subject Status]", "[Business Component Field Name]"

The Subject Status and Business Component Field Name parameters are mandatory. The Visit Type parameter is optional. The Visit Type value is not populated by default.

The following example provides the default configuration for the Enrolled status, and collates the subjects with an Enrolled status for automatic rollup to the site record:

"Enrolled", "# Enrolled"

Status RollUp Fields:Protocol n

Clinical Protocol Site

This property collates subject numbers for each status value. You can also configure it to collate subjects status and visit type value pairs. The subject accruals data is rolled up to the protocol record.

The following comma-delimited parameter configurations are supported:

  • "[Subject Status]", "[Business Component Field Name]", "[Visit Type]"

  • "[Subject Status]", "[Business Component Field Name]", "[Null]"

  • "[Subject Status]", "[Business Component Field Name]"

The Subject Status and Business Component Field Name parameters are mandatory. The Visit Type parameter is optional. The Visit Type value is not populated by default.

The following example provides the default configuration for the Enrolled status, and collates the subjects with an Enrolled status for automatic rollup to the protocol record:

"Enrolled", "# Enrolled"

Status RollUp Fields:Region n

Clinical Protocol Site

This property collates subject numbers for each status value. You can also configure it to collate subject status and visit type value pairs. The subject accruals data is rolled up to the region record.

The following comma-delimited parameter configurations are supported:

  • "[Subject Status]", "[Business Component Field Name]"

  • "[Subject Status]", "[Business Component Field Name]", "[Visit Type]"

  • "[Subject Status]", "[Business Component Field Name]", "[Null]"

The Subject Status and Business Component Field Name parameters are mandatory. The Visit Type parameter is optional. The Visit Type value is not populated by default.

The following example provides the default configuration for the Enrolled status, and collates the subjects with an Enrolled status for automatic rollup to the region record:

"Enrolled", "# Enrolled"

Status Tracking Field n

Clinical Subject

This property configures automatic status tracking for subject status. By, default, automatic subject status tracking applies to fields related to the following subject statuses:

  • Screen Failure

  • Randomized

  • Withdrawn

  • Early Terminated

You can track additional custom subject statuses by configuring additional values for this property type. This property takes the following comma-delimited list of parameters:

"[Business Component Field Name]", "[DateField]", "[Status Value"

  • [Business Component Field Name] is the name of the business component field that is tracked for automatic status tracking, for example, Randomization ID.

  • [Date Field] is the name of the corresponding date field that is tracked for automatic status tracking, for example, Randomized Date.

  • [Status Value] is the corresponding status value that is tracked for automatic status tracking, for example, Randomized.

Status Tracking Field 1

Clinical Subject

This property configures automatic status tracking for the subject status of Randomized.

The default value follows:

"Randomization Id", "Randomized Date",
"Randomized"

To track additional custom subject statuses, see Status Tracking Field n.

Status Tracking Field 2

Clinical Subject

This property configures automatic status tracking for the subject status of Screen Failure.

The default value follows:

"Reason Excluded", "Screen Failure Date", "Screen Failure"

To track additional custom subject statuses, see Status Tracking Field n.

Status Tracking Field 3

Clinical Subject

This property configures automatic status tracking for the subject status of Withdrawn.

The default value follows:

"Withdrawn Reason", "Withdrawn Date", "Withdrawn"

To track additional custom subject statuses, see Status Tracking Field n.

Status Tracking Field 4

Clinical Subject

This property configures automatic status tracking for the subject status of Early Terminated.

The default value follows:

"Early Termination Reason", "Early Terminated Date",
"Early Terminated"

To track additional custom subject statuses, see Status Tracking Field n.

Trip Report Template Filter 1

Clinical Trip Report

This property filters the trip report templates in the dialog box that appears when users click the select button in the Template field of a Trip Report form. It designates that templates with a protocol that is the same as the protocol for the site visit appear in the dialog box. Templates with no protocol also appear in the dialog box.

The default value follows:

"Protocol Id", "Protocol Id"

The first value designates the field name for protocols in the Clinical Trip Report business component. The second value designates the field name for protocols in the LS Clinical Trip Report Template business component.

Trip Report Template Filter 2

Clinical Trip Report

This property filters the trip report templates in the dialog box that appears when users click the select button in the Template field of a Trip Report form. It designates that templates with a region that is the same as the region for the site visit appear in the dialog box. Templates with no region also appear in the dialog box.

The default value follows:

"Region Id", "Region Id"

The first value designates the field name for regions in the Clinical Trip Report business component. The second value designates the field name for regions in the LS Clinical Trip Report Template business component.

Trip Report Template Filter 3

Clinical Trip Report

This property filters the trip report templates in the dialog box that appears when users click the select button in the Template field of a Trip Report form. It designates that templates with a visit type that is the same as the visit type for the site visit appear in the dialog box. Templates with no visit type also appear in the dialog box.

The default value follows:

"Type", "Visit Type"

The first value designates the field name for visit types in the Clinical Trip Report business component. The second value designates the field name for visit types in the LS Clinical Trip Report Template business component.

Validate Field

LS Subject Enrollment Date VBC

Note: This property is deprecated in version 8.1.1.9 and later.

This property represents the name of the field to validate.

The default value is Enrollment ID.

Validate On 1

Clinical Trip Report

This property turns on or off validation for trip reports that have a status of Rejected.

When enabled, trip reports that have a status of Rejected are validated to ensure that one of the following fields is populated:

  • Reviewer Comments

  • Approver Comments

Configure the value as follows:

  • To enable this property, set the value as follows:

    "Rejected", "Y"
  • To disable this property, set the value as follows:

    "Rejected", "N"

This property is enabled by default.

Validate On 2

Clinical Trip Report

This property turns on or off validation for trip reports that have a status of Submitted.

When enabled, trip reports that have a status of Submitted are validated to ensure that a reviewer is assigned to the trip report.

Configure the value as follows:

  • To enable this property, set the value as follows:

    "Submitted", "Y"
  • To disable this property, set the value as follows:

    "Submitted", "N"

This property is enabled by default.

Validate On 3

Clinical Trip Report

This property turns on or off validation for trip reports that have a status of Submitted for Approval.

When enabled, trip reports that have a status of Submitted for Approval are validated to ensure that an approver is assigned to the trip report.

Configure the value as follows:

  • To enable this property, set the value as follows:

    "Submitted for Approval", "Y"
  • To disable this property, set the value as follows:

    "Submitted for Approval", "N"

This property is enabled by default.

WorkFlow Process Name

LS Subject Schedule Date VBC

This property defines the workflow process that is invoked when the Enroll Screen Rescreen Through WorkFlow property is set to Y.

The default value is LS Clinical - SubjectVisits Process.

This workflow process applies the approved subject visit template to the subject.

If the subject visit template that is applied is different from the previous version of the subject visit template that was applied, and if the Disable Delete Non App Visit property is set to N, then a pop-up message appears to confirm if incomplete visits in the previous template version must be deleted, and if complete visits in the new template version must be deleted. Clicking OK in the pop-up message deletes the non applicable subject visits. Clicking Cancel retains the non applicable subject visits.

User Properties for Business Services in Siebel Clinical

The following table describes the business service user properties that you can use to enable and configure functionality for Siebel Clinical.

Table User Properties for Business Services in Siebel Clinical

User Property

Business Service

Project

Description

Data Rollup Is On

LS Data Rollup

LS Clinical Enhancement

This property configures rollup of subject status data to sites, regions, and protocols.

Configure the value as follows:

  • To enable this property, set the value to Y.

  • To disable this property, set the value to N.

This property is enabled by default.

Protocol Account To Site Rolldown

LS Clinical Record Rolldown Service

LS Clinical Admin

This property associates accounts for clinical protocols with sites. It specifies the data map information in the form of an input argument for the business service method. The named method property for the underlying business component calls this business service when you click the OK button in the LS Clinical Protocol Account Site Popup applet. This applet appears when you click the Apply To Sites button in the Accounts view of the Protocols screen.

The default value for this property follows:

'LS Clinical Protocol Account To Sites', 'LS
Clinical Account', 'Id', 'Clinical Protocol
Site for Popup', 'Id'

In this value, LS Clinical Protocol Account To Sites is a data map that maps the fields in accounts for protocols to the fields in accounts for sites, LS Clinical Account is the name of the source business component, and Clinical Protocol Site for Popup is the name of the underlying business component for the LS Clinical Protocol Account Site Popup applet. Id is a field that uniquely identifies an account in the source business component and a site in the business component for the popup applet.

You can change the field mapping for data maps in the Data Component list in the Data Map Administration view of the Administration - Application screen. For more information about changing data maps, see Siebel Order Management Infrastructure Guide.

Protocol Activity To Site Rolldown

LS Clinical Record Rolldown Service

LS Clinical Admin

This property associates activities for clinical protocols with sites. It specifies the data map information in the form of an input argument for the business service method. The named method property for the underlying business component calls this business service when you click the OK button in the LS Clinical Protocol Activity Site Popup applet. This applet appears when you click the Apply To Sites button in the Activities view of the Protocols screen.

The default value for this property follows:

'LS Clinical Protocol Activity To Sites',
'LS Action(Protocol/Region)', 'Id', 'Clinical
Protocol Site for Popup', 'Id'

In this value, LS Clinical Protocol Activity To Sites is a data map that maps the fields in activities for protocols to the fields in activities for sites, LS Action (Protocol/Region) is the name of the source business component, and Clinical Protocol Site for Popup is the name of underlying business component for the LS Clinical Protocol Activity Site Popup applet. Id is a field that uniquely identifies an activity in the source business component and a site in the business component for the popup applet.

You can change the field mapping for data maps in the Data Component list in the Data Map Administration view of the Administration - Application screen. For more information about changing data maps, see Siebel Order Management Infrastructure Guide.

Protocol Document To Site Rolldown

LS Clinical Record Rolldown Service

LS Clinical Admin

This property associates documents for clinical protocols with sites. It specifies the data map information in the form of an input argument for the business service method. The named method property for the underlying business component calls this business service when you click the OK button in the LS Clinical Protocol Document Site Popup applet. This applet appears when you click the Apply To Sites button in the Document Tracking view of the Protocols screen.

The default value for this property follows:

'LS Clinical Protocol Document To Sites', 'LS
Document Tracking', 'Id', 'Clinical Protocol
Site for Popup', 'Id'

In this value, LS Clinical Protocol Document To Sites is a data map that maps the fields in documents for protocols to the fields in documents for sites, LS Document Tracking is the name of the source business component, and Clinical Protocol Site for Popup is the name of underlying business component for the LS Clinical Protocol Document Site Popup applet. Id is a field that uniquely identifies a document in the source business component and a site in the business component for the popup applet.

You can change the field mapping for data maps in the Data Component list in the Data Map Administration view of the Administration - Application screen. For more information about changing data maps, see Siebel Order Management Infrastructure Guide.

Region Account To Site Rolldown

LS Clinical Record Rolldown Service

LS Clinical Admin

This property associates accounts for clinical regions with sites. It specifies the data map information in the form of an input argument for the business service method. The named method property for the underlying business component calls this business service when you click the OK button in the LS Clinical Region Account Site Popup applet. This applet appears when you click the Apply To Sites button in the Accounts view of the Regions screen.

The default value for this property follows:

'LS Clinical Region Account To Sites', 'LS
Clinical Account', 'Id', 'Clinical Protocol
Site for Popup', 'Id'

In this value, LS Clinical Region Account To Sites is a data map that maps the fields in accounts for regions to the fields in accounts for sites, LS Clinical Account is the name of the source business component, and Clinical Protocol Site for Popup is the name of the underlying business component for the LS Clinical Region Account Site Popup applet. Id is a field that uniquely identifies an account in the source business component and a site in the business component for the popup applet.

You can change the field mapping for data maps in the Data Component list in the Data Map Administration view of the Administration - Application screen. For more information about changing data maps, see Siebel Order Management Infrastructure Guide.

Region Activity To Site Rolldown

LS Clinical Record Rolldown Service

LS Clinical Admin

This property associates activities for clinical regions with sites. It specifies the data map information in the form of an input argument for the business service method. The named method property for the underlying business component calls this business service when you click the OK button in the LS Clinical Region Activity Site Popup applet. This applet appears when you click the Apply To Sites button in the Activities view of the Regions screen.

The default value for this property follows:

'LS Clinical Region Activity To Sites', 'LS
Action(Protocol/Region)', 'Id', 'Clinical
Protocol Site for Popup', 'Id'

In this value, LS Clinical Region Activity To Sites is a data map that maps the fields in activities for regions to the fields in activities for sites, LS Action (Protocol/Region) is the name of the source business component, and Clinical Protocol Site for Popup is the name of the underlying business component for the LS Clinical Region Activity Site Popup applet. Id is a field that uniquely identifies an activity in the source business component and a site in the business component for the popup applet.

You can change the field mapping for data maps in the Data Component list in the Data Map Administration view of the Administration - Application screen. For more information about changing data maps, see Siebel Order Management Infrastructure Guide.

Region Document To Site Rolldown

LS Clinical Record Rolldown Service

LS Clinical Admin

This property associates documents for clinical regions with sites. It specifies the data map information in the form of an input argument for the business service method. The named method property for the underlying business component calls this business service when you click the OK button in the LS Clinical Region Document Site Popup applet. This applet appears when you click the Apply To Sites button in the Document Tracking view of the Region screen.

The default value for this property follows:

'LS Clinical Region Document To Sites', 'LS
Document Tracking', 'Id', 'Clinical Protocol
Site for Popup', 'Id'

In this value, LS Clinical Region Document To Sites is a data map that maps the fields in documents for regions to the fields in documents for sites, LS Document Tracking is the name of the source business component, and Clinical Protocol Site for Popup is the name of the underlying business component for the LS Clinical Region Document Site Popup applet. Id is a field that uniquely identifies a document in the source business component and a site in the business component for the popup applet.

You can change the field mapping for data maps in the Data Component list in the Data Map Administration view of the Administration - Application screen. For more information about changing data maps, see Siebel Order Management Infrastructure Guide.

You can configure additional properties for the LS Clinical Record Rolldown Service business service to set up additional functionality for rolldowns. An example of such a custom property follows:

'Custom Data Map', 'Source Business Component', 'Id', 'Business Component for the 
Popup Applet', 'Id'

In this value, Custom Data Map is a data map that maps the fields in the source business component to the fields in the target business component, Id is a field that uniquely identifies a record in the source business component and a record in the underlying business component for the popup applet. The named method property for the underlying business component calls this business service when you click the OK button in the appropriate popup applet.

The value for the named method property specifies the method for the appropriate popup applet, the underlying business component for that applet, the method in that business component that calls the rolldown business service, and the appropriate user property as the input argument for the business service. An example of such a custom property follows:

"CustomAppletMethod", "INVOKESVC", "Business Component for the Popup Applet", "LS 
Clinical Record Rolldown Service", "ApplyRolldown", "UserPropertyName", 
"CustomProperty"

Applet Properties in Siebel Clinical

The following table describes the applet properties that you can use to enable and configure functionality for Siebel Clinical.

Table Applet Properties in Siebel Clinical

Property

Applet

Description

ClosePopUp

LS Clinical Protocol Account Site Popup Applet

LS Clinical Protocol Activity Site Popup Applet

LS Clinical Protocol Document Site Popup Applet

LS Clinical Region Account Site Popup Applet

LS Clinical Region Activity Site Popup Applet

LS Clinical Region Document Site Popup Applet

This property closes the pop-up applet when an end user performs an action to close this applet, such as clicking the OK button. This action calls the method in the value for this property.

You can enter a comma-delimited list in this property to specify multiple methods. An example follows:

ClosePopUp="method 1", "method 2", "method 3"

The default value (method name) for each of the six applets follows:

  • ProtocolAccountRolldownToSite

  • ProtocolActivityRolldownToSite

  • ProtocolDocumentRolldownToSite

  • RegionAccountRolldownToSite

  • RegionActivityRolldownToSite

  • RegionDocumentRolldownToSite

You can use this property in applets that are associated with the CSSSWEFrRolePopup class.

HideInQueryMode

Any applet that uses one of the following classes or a class derived from these classes:

CSSSWEClinicalList Base

CSSSWEClinicalForm Base

This property hides the buttons that call the methods in this property. This property hides these buttons when end users click Query in the applet.

You can enter a comma-delimited list in this property to specify multiple methods. An example follows:

HideInQueryMode="ShowAll", "ShowCurrent", "CallCustomerMaster"

If the button calls the ShowPopup method, you do not have to include that method in this property.

History Target BC

(Internal)

Clinical Protocol Team Mvg Applet

Clinical Region Team Mvg Applet

This property specifies the target business component.

The default values follow:

  • Clinical Protocol Site Team Assignment History BC

  • Clinical Protocol Team Assignment History BC

  • Clinical Region Team Assignment History BC

The information about the positions added to or deleted from the team list is added to the specified business component.

Search Specification

Clinical Protocol Site Template Version Assoc Applet

This property configures the versions of the subject visit template that appear in the Site Management Versions MVG (multi value group).

Configure this property as follows:

  • To display only the versions of the subject visit templates with a status of Approved, set the value as follows:

    [Status Cd] = LookupValue("CLNCL_VERSION_STATUS","Approved")

  • To display the versions of the subject visit templates with a status of Reviewed or Approved, set the value as follows:

    [Status Cd] = LookupValue("CLNCL_VERSION_STATUS","Approved") OR [Status Cd] = LookupValue("CLNCL_VERSION_STATUS"," Reviewed")

The default configuration displays only subject visit templates with a status of Approved in the Site Management Versions MVG.

Popup Visibility Type

LS Clinical Site Bulk Payment Popup Applet

This property determines the site records that appear in the dialog box that appears when end users click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

The default value for this property is All. This value means that all site records in the Siebel Clinical application appear in the dialog box. This property can have the following alternate values, which are standard Siebel view modes:

  • Personal

  • Sales Rep

  • Manager

  • Organization

  • Sub-Organization

  • Group

  • Catalog

View modes determine the records that end users can see in a view that is associated with an underlying business component. For example, if you set this property value to Organization, then the end user who clicks the Generate button can see the site records for the protocol or region that are associated with the organization of the end user.

This property overrides the pop-up visibility of the underlying business component. The underlying business component must support the view mode associated with the value that you enter. For more information about view modes, see Siebel Security Guide.

WF.Abstract

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the value for the Abstract field that is passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

The input argument is a key-value combination. An example follows:

Abstract="Bulk payment status update"

This example shows the default value for this property, but you can change this value.

WF.AllowDismiss

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the value for the AllowDismiss field that is passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

The input argument is a key-value combination. An example follows:

AllowDismiss="Y"

This example shows the default value for this property, but you can change this value.

WF.AllUsers

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the value for the AllUsers field that is passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

The input argument is a key-value combination. An example follows:

AllUsers="N"

This example shows the default value for this property, but you can change this value.

WF.ListOfRecipient Divisions

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the values for the Recipient Division field that are passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

When a value in the Recipient Division field of the notification message matches a value in the Division field of a team record for a site, the end users associated with that division receive notifications of payments to that site. For information about setting up notification messages, see Siebel Applications Administration Guide.

The default value for this property is DivisionName(), but you can change this value.

The value for this property is a Siebel grammar expression that is similar to the expressions in calculated fields for business components. Because the destination field for this property is an MVG (multi value group), you can enter a comma-delimited list in this property to specify multiple values. An example follows:

"DivisionName()", "Home Office Division"

You can activate this property if necessary.

WF.ListOfRecipient Positions

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the values for the Recipient Position field that are passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

When a value in the Recipient Position field of the notification message matches a value in the Position field of a team record for a site, the end users associated with that position receive notifications of payments to that site. For information about setting up notification messages, see Siebel Applications Administration Guide.

The default value for this property is PositionName(), but you can change this value.

The value for this property is a Siebel grammar expression that is similar to the expressions in calculated fields for business components. Because the destination field for this property is an MVG (multi value group), you can enter a comma-delimited list in this property to specify multiple values. An example follows:

"PositionName()", "HQ - US Region"

You can activate this property if necessary.

WF.ListOfRecipientUsers

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the values for the Recipient User field that are passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

When a value in the Recipient User field of the notification message matches a value in the User ID field of a team record for a site, the end user associated with that user ID receives notifications of payments to that site. For information about setting up notification messages, see Siebel Applications Administration Guide.

The default value for this property is LoginName(), but you can change this value.

The value for this property is a Siebel grammar expression that is similar to the expressions in calculated fields for business components. Because the destination field for this property is an MVG (multi value group), you can enter a comma-delimited list in this property to specify multiple values. An example follows:

"LoginName()", "JDOE"

WF.ProcessName

LS Clinical Site Bulk Payment Popup Applet

This property specifies the name of the underlying workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen. Notification-related arguments (WF.Abstract, WF.AllowDismiss, and so on) are then passed as input arguments (Abstract, AllowDismiss, and so on) to this workflow.

The default value for this property is LS Clinical - Generate Bulk Payment Process, but you can change this value to a custom workflow.

WF.Severity

LS Clinical Site Bulk Payment Popup Applet

This property configures notifications for bulk payments by specifying the value for the Severity field that is passed as an input argument to the workflow that the GenerateBulkPayment method calls when you click the OK button in the LS Clinical Site Bulk Payment Applet. This applet appears when you click the Generate Payment button in the Payments view of the Protocols screen or the Regions screen.

The input argument is a key-value combination. An example follows:

Severity="Normal"

This example shows the default value for this property, but you can change this value to any value for the Severity field that has a Type field value of BRDCST_MSG_TYPE in the list of values and that is active in the list of values. Alternate values include: High, Urgent, and Urgent with Alert.

For applets that are associated with the CSSSWEFrRolePopup class and that have Clinical Protocol Site Bulk Operations as the underlying business component, you can create additional input arguments for the workflow that the GenerateBulkPayment method calls by creating additional applet properties as WF.field name, and recompiling the applet. For example, a custom property of WF.CustomerName might have the following input argument for the workflow:

CustomerName="Elixir Labs"

Field Properties in Siebel Clinical

The following information lists the field properties that you can use to enable and configure functionality for Siebel Clinical.

Table Field Properties in Siebel Clinical

Property

Parent Field

Description

Append All Activities

Enrollment Date

Screen Date

Rescreen Date

Note: This property is deprecated in version 8.1.1.9 and later.

This property configures whether or not users can copy the activities in the subject visit template multiple times.

Configure this property as follows:

  • Set the value to Y to allow users to copy the activities in the subject visit template multiple times.

  • Set the value to N to disallow users to copy the activities in the subject visit template multiple times.

The default property value for each parent field follows:

Enrollment Date = N

Screen Date = N

Rescreen Date = Y

Subject Consent Required

Screen Date

This property configures whether or not subject informed consent is mandatory when scheduling a clinical subject. When enabled, the Informed Consent Date field is checked for data when the user clicks Schedule.

Configure this property as follows:

  • To set the Informed Consent Date as a mandatory field when scheduling a clinical subject, set the value to Y.

  • To set the Informed Consent Date as an optional field when scheduling a clinical subject, set the value to N.

The default value is N.

Template Type Code]

Enrollment Date

Screen Date

Rescreen Date

Note: This property is deprecated in version 8.1.1.9 and later.

This property configures the subject visit template type that is used when applying a template.

The default property value for each parent field follows:

Enrollment Date = ‘Enrollment’

Screen Date = ‘Screening’

Rescreen Date =‘Re-Screening’

System Preferences in Siebel Clinical

The following information lists the system preferences that you can use to configure core functionality in Siebel Clinical Trial Management System and to integrate Siebel Clinical Trial Management System with third-party applications.

Table System Preferences in Siebel Clinical

System Preference

Functionality

CL Highest Preference SDV Rule

This setting determines the priority order in which to implement the 3 methods (Manual, Site, and Status) to change the SDV Required field of a subject record. Valid values for this system preference are Status and Manual. The default value is Status.

To understand the priority order for each value in this system preference, note the following scenario:

  • Site method: The Subject Auto-Select Rate field for the site associated with the subject is 50%. Thus, every other subject record initially has a SDV Required field of Yes.

  • Status method: A status rule set indicates that if the Status field of a subject record is Early Terminated, then the SDV Required field of the subject record is automatically changed to Yes. None of the Status fields in the subject records initially has a value of Early Terminated.

If you set this system preference to Status, then the 3 methods are implemented in the following priority order: Status, Manual, and Site. Note the following:

  • You can manually change the SDV Required field of a subject record from Yes to No because the manual method has a higher priority than the sitee method.

  • If you change the Status field of the subject record to Early Terminated, then the SDV Required field of the subject record automatically changes back to Yes because the status method has a higher priority than the manual method.

  • You cannot manually change the SDV Required field of the subject record back to No because the status method has a higher priority than the manual method.

  • If you change the value in the Subject Auto-Select Rate field for the site associated with the subject, then the SDV Required field cannot automatically change because the status method has a higher priority than the site method.

If you set this system preference to Manual, then the 3 methods are implemented in the following order: Manual, Status, and Site. Note the following:

  • You can manually change the SDV Required field of a subject record from Yes to No because the manual method has a higher priority than the status method and the site method.

  • If you change the Status field of the subject record to Early Terminated, then the SDV Required field does not automatically change back to Yes because the manual method has a higher priority than the status method.

  • If you change the value in the Subject Auto-Select Rate field for the site associated with the subject, then the SDV Required field cannot automatically change because the manual method has a higher priority than the site method.

CL – Verify TripReportApprover

This setting turns on or off approver verification for trip reports. When enabled, the User Verification screen is launched during the approval process for trip reports to verify the user login credentials of the approver. To enable approver verification for trip reports, set the value to Y. The value is set to N by default.

Clinical_Training_Commit_Freq

This setting determines how frequently updated site records are saved in the Siebel database when you run the batch job to publish training plans and associate training topics with the site records. The default value for this system preference is 10. This value indicates that each time 10 site records are updated in the batch job those site records are saved in the Siebel database.

If the value for this system preference is 10, if 92 site records must be updated in the batch job, and if a failure occurs during the job run, then the result of the batch job is that the number of site records saved to the Siebel database is a multiple of 10 (for example, 60 site records), and not 0 site records. If you run the batch job again, then only the remaining 32 updated site records are saved in the Siebel database.

Workflows in Siebel Clinical

The following information lists the required workflows for Siebel Clinical core functionality and for integrating Siebel Clinical with third-party applications. For more information about each workflow, see the corresponding functional area in this guide. You can use Siebel Business Process Designer to modify the workflows to suit your own business model. For information about configuring workflows, see Siebel Business Process Framework: Workflow Guide.

Table Workflows in Siebel Clinical

Workflow Name

Siebel Clinical Functionality

Clinical Assign Position From Protocol

Clinical Protocol

Clinical Assign Position From Region Rolldown

Clinical Region

Clinical Assign Position From Region

Clinical Region

Clinical Assign Position From Site Rollup

Clinical Site

Clinical Assign Position From Site

Clinical Site

Clinical Protocol Position History Update

Clinical Protocol

Clinical Region Delete Rollup

Clinical Region

Clinical Region First Site Initiation Date Upsert Rollup

Clinical Region

Clinical Region First Subject Enrolled Date Upsert Rollup

Clinical Region

Clinical Region Last Site Terminated Date Upsert Rollup

Clinical Region

Clinical Region Last Subject Off Study Date Upsert Rollup

Clinical Region

Clinical Region Position History Update

Clinical Region

Clinical Region Status Fields Rollup

Clinical Region

Clinical Remove Position From Protocol

Clinical Protocol

Clinical Remove Position From Region

Clinical Region

Clinical Remove Position From Site

Clinical Site

Clinical Rollup Batch Process

Clinical Site

Clinical Site Delete Rollup to Protocol

Clinical Site

Clinical Site Delete Rollup to Region

Clinical Site

Clinical Site Delete Rollup

Clinical Site

Clinical Site First Subject Enrolled Date Upsert Rollup

Clinical Subject

Clinical Site Initiation Completed Date Upsert Rollup

Clinical Site

Clinical Site Last Subject Off Study Date Upsert Rollup

Clinical Site

Clinical Site Position History Update

Clinical Site

Clinical Site Status Fields Rollup

Clinical Site

Clinical Site Termination Date Upsert Rollup (With Subject Info)

Clinical Site

Clinical Site Termination Date Upsert Rollup (Without Subject Info)

Clinical Site

Clinical Status Delete Rollup

Clinical Subject

Clinical Status Upsert Rollup

Clinical Subject

Clinical Subject Delete Rollup

Clinical Subject

LS Clinical - ApplyTemplates Process

Clinical Template

LS Clinical - DeleteNonAppVisits Process

Clinical Subject Visits

LS Clinical - SubjectVisits Process

Clinical Subject Visits

LS Clinical Contract Rollup

Clinical Contract

LS Clinical Create Inbox Item for New Trip Report Owner

Clinical Trip Report

LS Clinical Create Inbox Item for Trip Report Approver

Clinical Trip Report

LS Clinical Create Inbox Item for Trip Report Owner

Clinical Trip Report

LS Clinical Create Inbox Item for Trip Report Reviewer

Clinical Trip Report

LS Clinical Earned To Date Rollup

Clinical Payments

LS Clinical - Generate Bulk Payment Process

Clinical Payments

LS Clinical Get Site Snapshot Service

Clinical Trip Report

LS Clinical Set Study Plan Information

Clinical operations integration

LS Clinical Paid To Date Rollup

Clinical Payments

LS Clinical Payment Delete Rollup

Clinical Payments

LS Clinical Payments Outbound

Third-party payments application integration

LS Clinical Protocol Delete Rollup

Clinical Protocol

LS Clinical Protocol Site Get Sites

Clinical Site

LS Clinical Protocol Site Get User Position

Clinical Site

LS Clinical Protocol Training Rollup

Clinical Training

LS Clinical Questions Batch Clean-up

Clinical Trip Report

LS Clinical Region Training Rollup

Clinical Training

LS Clinical Site Accruals Rollup

Clinical Site

LS Clinical Site Subject Delete Accruals Rollup

Clinical Subject

LS Clinical State Validation

Third-party payments application integration

LS Clinical Total Contract Amount Rollup

Clinical operations integration

LS Clinical Training Implementation

Clinical Training

LS Clinical Trip Report Approval

Clinical Trip Report

LS Clinical VAT Amount Rollup

Clinical Payments

LS ClinicalProtocolSite Outbound - NewSite

Site visit data integration

LS ClinicalProtocolSite Outbound - UpdatedSite

Clinical Protocol

SWI LS Clinical Create Site Visit Geo Location

Site visit data integration

SWI LS Clinical Payments Inbound

Third-party payments application integration

SWI LS Clinical Query Protocol Site_Site Visits

Site visit data integration

SWI LS Clinical Subject Inbound - Activity

Clinical data management system integration

SWI LS Clinical Subject Inbound - Subject

Clinical data management system integration

SWI LS Clinical Subject Inbound

Clinical data management system integration

SWI - Protocol Number Lookup

Clinical data management system integration

Web Services in Siebel Clinical

You can customize the Web services in Siebel Clinical for integration with any third-party clinical application or for specific business requirements. The following information lists the Web services for mobile and external application integration. For more information about each Web service, see the corresponding integration chapter in this guide. For information about customizing Web services, see Siebel CRM Web Services Reference.

Table Web Services in Siebel Clinical

Web Service Name

Siebel Clinical Feature

ClinicalSubject

Clinical data capture integration

LS Clinical CRF Tracking Interface

Clinical operations integration

LS Clinical Protocol Site Interface Service

Clinical data capture integration

Clinical operations integration

LS Clinical Subject Information Interface Service

Clinical operations integration

LS Clinical Trip Report File Transfer Web Service

CTMS and eTMF integration

SWI LS Clinical Payments Inbound

Payments application integration

SWILSClinicalActivityTemplate

Mobile integration

SWILSClinicalCreateSiteVisitGeoLocation

Site visit data integration

SWILSClinicalGetEmployees

Mobile integration

SWILSClinicalGetSiteContacts

Mobile integration

SWILSClinicalGetSiteSnapshot

Mobile integration

SWILSClinicalGetSmartScriptDetails

Mobile integration

SWILSClinicalGetStateModelService

Mobile integration

SWILSClinicalGetSubjectVisitDetails

Mobile integration

SWILSClinicalInsertEmployees

Mobile integration

SWILSClinicalListOfValues

Mobile integration

SWILSClinicalProtocolSiteGetSites

Mobile integration

SWILSClinicalQueryProtocolSite_SiteVisits

Site visit data integration

SWILSClinicalSiteContactsTrainingInterfaceService

Training integration

SWILSClinicalTripReportInterfaceService

Mobile integration

SWILSClinicalTripReportTemplates

Mobile integration