Configuring Pipeline Pilot Study Design and Tracking

You can configure your Pipeline Pilot Study Design and Tracking installation to work with Foundation Hub and the Study Design and Tracking app.

This task shows you how to:

See Also
Installing Pipeline Pilot Study Design and Tracking
Installation Roadmap

Configure Pipeline Pilot Global Properties

You can configure the Study Design and Tracking Pipeline Pilot protocols to work with other BIOVIA applications and communicate with 3DEXPERIENCE platform services. By default, Pipeline Pilot works with the Foundation Hub registered BIOVIA applications.

  1. Open the Pipeline Pilot Admin Portal and select the Setup | Global Properties page.
  2. Choose BIOVIA/Study Design and Tracking from the Package list.
  3. Select each global property that you need to change and enter the appropriate value.
    Global PropertyDescription
    CISProURL

    The CISPro server.

    This is the same URL as the CISPro server registered on Foundation Hub.

    Setting this property expedites requests to the CISPro API, bypassing calls to the Foundation Hub API.
    Platform3DPassportURL

    The 3DEXPERIENCE server.

    This defines the default value for the 3DPassport URL in the Audit Report protocol.
    PlatformTenant

    The name of the tenant in a multitenant cloud platform environment, used for authentication and for calls to the 3DEXPERIENCE Study Design and Tracking API.
    StudyIdFormat

    The format to use for study identifiers. For more information, seeConfiguring the Study Identifier.
    StudyServiceURL

    The 3DSpace service used by Study Design and Tracking on the 3DEXPERIENCE server.

    This defines as the default value for the Study Service URL in the Audit Report protocol.
    TimeWindowsEnabled

    Whether to enable custom rules for time windows. For more information, see Configuring Rules for Time Windows.
    TimeWindowsConfigFile

    If TimeWindowsEnabled is "true", the location of the configuration file that defines the custom rules for time windows.
  4. Click Update.

The Study Design and Tracking Pipeline Pilot protocols use the specified URLs.

Configure Foundation Hub Vocabularies for Study Design and Tracking

You can use a Pipeline Pilot Study Design and Tracking protocol tool to create the study Type vocabulary and its values in Foundation Hub.

  1. On the Protocols tab of the Pipeline Pilot Client, expand the Web Applications/Study folder and double-click Create or Update Vocabularies.

    • The Name parameter is "Study Focus". This corresponds to the Type for a study in the Study Design and Tracking app.
    • There is a default Description.
    • The Category is "Study". Do not change this.

  2. Edit the vocabulary Description if required.

    This text is not available in the Study Design and Tracking app.

  3. Review the list of Entries, add, edit, or remove items as required.
  4. If you need to create or update other Foundation Hub vocabularies, you can duplicate the Vocabulary 1 group of parameters:
    1. For the Vocabularies group, click .
    2. On the parameter group management dialog, click to duplicate the Vocabulary 1 group as required. Click OK.
    3. In the Vocabulary 2 group of parameters, change the values of the parameters as required for the Foundation Hub vocabulary you want to create or edit.
  5. Click to run the protocol.

When the protocol run has completed, a report opens describing its outcome.

Configuring Rules for Time Windows

You can define rules for the size of time windows to apply at any time points in all studies for your Study Design and Tracking application. These rules determine the range of the time window and the units of the range, according to the value and units of the time point.

Context: The time window rule employed for any time point depends on how the time point is defined in the study in the Study Design and Tracking app. For example, your study Test Design might use time points of 3 hours, 5 days, 10 weeks, and 12 months. The time window rules applied are different for each time point as the units are different, define your rules so that equivalent periods use equivalent time windows.

You can activate the use of custom time window rules using the TimeWindowsEnabled package global property in the Pipeline Pilot Study Design and Tracking package. You can specify the rules to define the acceptable time windows in a CSV file, whose location is defined in the TimeWindowsConfigFile package global property. For more information on the format of the time windows CSV file, see the Pipeline Pilot Study Design and Tracking User Guide in the Pipeline Pilot Help Center.

  1. Open the Pipeline Pilot Admin Portal and select the Setup | Global Properties page.
  2. Choose BIOVIA/Study Design and Tracking from the Package list.
  3. Select the TimeWindowsEnabled global property and specify "true".
  4. Select the TimeWindowsConfigFile global property and specify the full path to the location of the CSV configuration file on the Pipeline Pilot Server machine.
  5. Click Update.

The time windows for studies use your custom rules.

Configuring the Study Identifier

You can configure the format of the unique identifier assigned to studies during initial saving.

Context: When a user initially saves a study, it receives a unique identifier. The Summary tab of the study displays this value as the Study Id. The default format of the identifier is STAB-<index>, where the index increments with each new study. You can customize the format of the identifier for all studies, according to your company's requirements. Until you specify your custom format, all saved studies receive the default format identifier. For examples of formats and identifiers, see the Pipeline Pilot Study Design and Tracking User Guide in the Pipeline Pilot Help Center.

  1. Open the Pipeline Pilot Admin Portal and select the Setup | Global Properties page.
  2. Choose BIOVIA/Study Design and Tracking from the Package list.
  3. Select the StudyIdFormat global property and specify "true".

    You can use any combination of the following format elements, in any order:

    • %APPCONTEXT% - the type of study. For stability studies, this is STAB.
    • %USERNAME% - the username of the user saving the study.
    • %DATE% - the calendar date the study's initial save.
    • separators - you can separate the identifier's elements with other characters according to your requirements, such as -, _, :, and /.
    The identifier's format always ends with a - and an index.

  4. Click Update.

Your custom identifier format is used for all saved studies from now on. If you change the format later, the identifiers of previously saved studies are not updated.