Update the test integration template - SV integration

You want to test the integration before using it in production, so you're going to first update the templates to create a test integration. After testing is complete, you will update the templates to establish the production integration.
Use the details in the table below to update the parent integration template for the SV integration.

Table 2-15 SV integration xml elements that require updates (Parent file: ClincalOneParent.xml)

XML element Details
StudyId

Enter the Oracle Clinical One Platform study GUID.

You can locate the GUID on the General tab under Study Settings. For more information, see Open the study's settings
Mode

If your intention is to test the integration, enter test.

Note: The mode aligns with the Oracle Clinical One Platform study container. You will update this to active when you're ready to Configure the production integration.

UserName

Enter your organization's ShortOrgID and the user name for the Oracle Clinical One Platform integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.

Use the following format when updating the integration template.
<UserName>ShortOrgID.Username</UserName>

For information about how to obtain your ShortOrgID, see How do I find my company's ShortOrgId?.

Use the details in the table below to update the following sub-integration templates:
  • NewSubjectIntegration_CTMS_SV_Std.xml
  • VisitScheduleIntegration_CTMS_SV_Std.xml

Table 2-16 SV integration xml elements that require updates (sub-integration files)

XML element Details
StudyId Enter the Oracle Clinical One Platform study GUID.
Mode

If your intention is to test the integration, enter test.

Note: The mode aligns with the Oracle Clinical One Platform study container. You will update this to active when you're ready to Configure the production integration.

C1UserCredentials Enter the Oracle Clinical One Platform credential key name. For more information, see Create Credentials.
C1UserName Enter the user name for the Oracle Clinical One Platform integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.
APIUserCredentials Enter the CTMS credential key name. For more information, see Create Credentials.
CtmsUserName

Enter the user name for the UAT CTMS integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.

Note: For the test integration, enter the user name created in the UAT Change Request (CR), and when the time comes, update this value to the user name created in the Production Change Request (CR).

Use the details in the table below to update the following sub-integration templates:
  • ScreeningIntegration_CTMS_SV_Std.xml
  • RandomizationIntegration_CTMS_SV_Std.xml
  • SubjectWithdrawIntegration_CTMS_SV_Std.xml
  • SubjectCompleteIntegration_CTMS_SV_Std.xml
  • SubjectTransferIntegration_CTMS_SV_Std.xml
  • ChangeSubjectNumberIntegration_CTMS_SV_Std.xml

Table 2-17 SV integration xml elements that require updates (sub-integration files)

XML element Details
StudyId Enter the Oracle Clinical One Platform study GUID.
Mode

If your intention is to test the integration, enter test.

Note: The mode aligns with the Oracle Clinical One Platform study container. You will update this to active when you're ready to Configure the production integration.

UserName Enter the user name for the Oracle Clinical One Platform integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.
RefName and Id
These elements are only applicable to the RandomizationIntegration_CTMS_SV_Std.xml integration template.
  • RefName: Enter the visit title.

    To get the visit title, open your study in design mode, then select the visit under the Scheduled Visits side panel. Use the value to the right at the top of the window.


    Study visit RefName value

  • Id: Enter the visit GUID.

    Use the Get visit information API to retrieve information about visits and the visit schedule, including the GUID. For more information, see the Get visit information API.

Refer to the following example if you need to configure multiple randomization visits.
<Visit>
 <RefName>Randomization_1</RefName>
 <Id>123456789</Id>
</Visit>
<Visit>
 <RefName>Randomization_2</RefName>
 <Id>987654321</Id>
</Visit>
APIUserCredentials Enter the CTMS credential key name. For more information, see Create Credentials.
CtmsUserName

Enter the user name for the UAT CTMS integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.

Note: For the test integration, enter the user name created in the UAT Change Request (CR), and when the time comes, update this value to the user name created in the Production Change Request (CR).

Use the details in the table below to update the following sub-integration template:
  • VisitDataDumpIntegration_CTMS_SV_Std.xml

Table 2-18 SV integration xml elements that require updates (sub-integration files)

XML element Details
StudyId Enter the Oracle Clinical One Platform study GUID.
Mode

If your intention is to test the integration, enter test.

Note: The mode aligns with the Oracle Clinical One Platform study container. You will update this to active when you're ready to Configure the production integration.

C1UserCredentials Enter the Oracle Clinical One Platform credential key name. For more information, see Create Credentials.
C1UserName Enter the user name for the Oracle Clinical One Platform integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.
APIUserCredentials Enter the CTMS credential key name. For more information, see Create Credentials.
CtmsUserName

Enter the user name for the UAT CTMS integration user created as a prerequisite. For more information, see Subject Visit (SV) Integration.

Note: For the test integration, enter the user name created in the UAT Change Request (CR), and when the time comes, update this value to the user name created in the Production Change Request (CR).

CtmsStudyName Enter the study name as defined in CTMS.

The next step is to Upload the integration template.

Parent topic: Update an integration template