JMP Clinical Study Manager API
Overview
The JMP Clinical Study Management API enables users to programmatically get information, add, update, and remove studies in the their JMP Clinical configurations. In conjunction with the operating system's batch scripting and scheduling functionality, it's possible to automate repetitive tasks on a schedule or in response to some external trigger (e.g. update/existence of a data file). This guide will describe the functions that are available in the API, as well as provide some simple examples of how they may be used in a batch scripted environment.
Note: The guide and usage of the API require the user has an understanding of the Study Management operations in JMP Clinical and at least minimum proficiency in JSL scripting.
Functions for Getting Information
The general usage pattern of the following functions is to supply the name of the study for which you want information. The only exception is the JMPClinicalStudyManagerAPI:getStudyList function, which takes no arguments and returns the list of the study names in the configuration. An operating system environment variable, JMPClinicalBatchConfiguration, can be set prior to launching JMP Clinical to set the active configuration. If that variable is not set, the last configuration used will be in effect.
All output for each operation is written to the JMP log. As such, when using the API in batch mode, the script writer will want to save the JMP log to a file at the end of the session. Another environment variable, JMPClinicalBatchLogPath, can be set prior to launching JMP Clinical to set the path where the log file should be written. It would be up to the script writer to utilize this variable when saving the path.
JMPClinicalStudyManagerAPI:getCurrentStudy
Returns the name of the current study.
Return -
If there is a current study, the study name (a string); otherwise Empty().
Syntax:
JMPClinicalStudyManagerAPI:getCurrentStudy = function({}, {},
JMPClinicalStudyManagerAPI:setCurrentStudy
Sets the current study to the one specified.
Arguments:
study - a string containing the name of the study to set as the current study, or Empty() to set the current study to <None>
Returns:
If the current study was succesfully set, 1; otherwise 0.
Syntax:
JMPClinicalStudyManagerAPI:setCurrentStudy = function({study}, {cs},
JMPClinicalStudyManagerAPI:getStudyList
Gets the list of studies for the current configuration (use the JMPClinicalBatchConfiguration environment variable)
Returns:
A List of the names of the studies
Syntax:
JMPClinicalStudyManagerAPI:getStudyList = function({},
JMPClinicalStudyManagerAPI:getStudyExists
Returns >=1 if study exists, 0 otherwise.
Arguments:
study - String - name of the study
Returns:
An integer
Syntax:
JMPClinicalStudyManagerAPI:getStudyExists = function({study},
JMPClinicalStudyManagerAPI:getSDTMFolder
Returns the path of the SDTM folder for the given study.
Arguments:
study - String - name of the study
Returns:
A String of the path for the SDTM folder
Syntax:
JMPClinicalStudyManagerAPI:getSDTMFolder = function({study},
JMPClinicalStudyManagerAPI:getSelectedSDTMDomains
Returns the list of selected SDTM domains for the given study.
Arguments:
study - String - name of the study
Returns:
List of the selected domains for the SDTM folder
Syntax:
JMPClinicalStudyManagerAPI:getSelectedSDTMDomains = function({study},
JMPClinicalStudyManagerAPI:getADaMFolder
Returns the path of the ADaM folder for the given study.
Arguments:
study - String - name of the study
Returns:
String of the path for the ADaM folder
Syntax:
JMPClinicalStudyManagerAPI:getADaMFolder = function({study},
JMPClinicalStudyManagerAPI:getSelectedADaMDomains
Returns the list of selected ADaM domains for the given study.
Arguments:
study - String - name of the study
Returns:
List of the selected domains for the ADaM folder
Syntax:
JMPClinicalStudyManagerAPI:getSelectedADaMDomains = function({study},
JMPClinicalStudyManagerAPI:getInitialDate
Returns the numeric date the given study was added.
Arguments:
study - String - name of the study
Returns:
Number (date). Use asDate(...) to get date representation
Syntax:
JMPClinicalStudyManagerAPI:getInitialDate = function({study},
JMPClinicalStudyManagerAPI:getLastUpdatedDate
Returns the numeric date the given study was last modified.
Arguments:
study - String - name of the study
Returns:
Number (date). Use asDate(...) to get date representation
Syntax:
JMPClinicalStudyManagerAPI:getLastUpdatedDate = function({study},
JMPClinicalStudyManagerAPI:getEnableSnapshot
Returns String for the snapshot status of the given study.
Arguments:
study - String - name of the study
Returns:
String "Yes" == snapshots are enabled, "No" == snapshots are not enabled
Syntax:
JMPClinicalStudyManagerAPI:getEnableSnapshot = function({study},
JMPClinicalStudyManagerAPI:getSnapshotNumber
Returns number for the snapshot of the given study.
Arguments:
study - String - name of the study
Returns:
A number of the snapshot. If snapshots aren't enabled, 0 is returned.
Syntax:
JMPClinicalStudyManagerAPI:getSnapshotNumber = function({study},
JMPClinicalStudyManagerAPI:getDomainList
Returns the list of domains for the given study.
Arguments:
study - String - name of the study
Returns:
A list of Strings of the domains
Syntax:
JMPClinicalStudyManagerAPI:getDomainList = function({study},
JMPClinicalStudyManagerAPI:getSizeOnDisk
Returns the number of MB on disk for all domains registered for the given study.
Arguments:
study - String - name of the study
Returns:
A number that is the number of MB used by the data files on disk for the given study
Syntax:
JMPClinicalStudyManagerAPI:getSizeOnDisk = function({study},
JMPClinicalStudyManagerAPI:getCreatedBy
Returns the userid that created the given study.
Arguments:
study - String - name of the study
Returns:
A string of the userid that added the study
Syntax:
JMPClinicalStudyManagerAPI:getCreatedBy = function({study},
JMPClinicalStudyManagerAPI:getLastUpdatedBy
Returns the userid that last updated the given study.
Arguments:
study - String - name of the study
Returns:
A string of the userid that last updated the study
Syntax:
JMPClinicalStudyManagerAPI:getLastUpdatedBy = function({study},
JMPClinicalStudyManagerAPI:getTestResultsLoadOnly
Returns the advanced option.
Arguments:
study - String - name of the study
Returns:
A String of the advanced option
Syntax:
JMPClinicalStudyManagerAPI:getTestResultsLoadOnly = function({study},
JMPClinicalStudyManagerAPI:getPartialDatesStartDateImputationMethod
Returns the advanced option.
Arguments:
study - String - name of the study
Returns:
A String of the advanced option
Syntax:
JMPClinicalStudyManagerAPI:getPartialDatesStartDateImputationMethod = function({study},
JMPClinicalStudyManagerAPI:getPartialDatesEndDateImputationMethod
Returns the advanced option.
Arguments:
study - String - name of the study
Returns:
A String of the advanced option
Syntax:
JMPClinicalStudyManagerAPI:getPartialDatesEndDateImputationMethod = function({study},
JMPClinicalStudyManagerAPI:getStudyDayValueDerivation
Returns the advanced option.
Arguments:
study - String - name of the study
Returns:
A String of the advanced option
Syntax:
JMPClinicalStudyManagerAPI:getStudyDayValueDerivation = function({study},
JMPClinicalStudyManagerAPI:getStudyDayAnchorDateForStudyDayCalculation
Returns the advanced option.
Arguments:
study - String - name of the study
Returns:
A String of the advanced option
Syntax:
JMPClinicalStudyManagerAPI:getStudyDayAnchorDateForStudyDayCalculation = function({study},
JMPClinicalStudyManagerAPI:getStudyPreference
Returns the given study preference for the given study.
Arguments:
study - String - name of the study
preference - String - name of the preference
Returns:
A <variable type> of the given preference for the given study
Syntax:
JMPClinicalStudyManagerAPI:getStudyPreference = function({study, preference},
JMPClinicalStudyManagerAPI:getAllStudyPreferences
Returns all study preferences for the given study.
Arguments:
study - String - name of the study
Returns:
An associative arrays of all preferences for the given study
Syntax:
JMPClinicalStudyManagerAPI:getAllStudyPreferences = function({study},
JMPClinicalStudyManagerAPI:setStudyPreference
Sets the given study preference to the given value for the given study.
Arguments:
study - String - name of the study
preference - String - name of the preference
value - <variable type> - value of the preference
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:setStudyPreference = function({study, preference, value},
JMPClinicalStudyManagerAPI:setAllStudyPreferences
Sets all preferences for the given study.
Arguments:
study - String - name of the study
preferenceValueAssociation - Associative Array - names and values of preferences
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:setAllStudyPreferences = function({study, preferenceValueAssociation},
JMPClinicalStudyManagerAPI:addStudy
Adds the study to current configuration (use the JMPClinicalBatchConfiguration environment variable).
Arguments:
studyName - String - name of the study
SDTMFolder - String - path to the SDTM data folder. Use "" if no SDTM data (at least one of SDTMFolder or ADaM must be specified)
selectedSDTMDomains - List - list of the selected domains for the SDTM folder. Use {} to take all possible domains
ADaMFolder - String - path to the ADaM data folder. Use "" if no ADaM data (at least one of SDTMFolder or ADaM must be specified)
selectedADaMDomains - List - list of the selected domains for the ADaM folder. Use {} to take all possible domains
makeCurrentStudy - Integer (0|1) - Use 1 to set the current study to studyName
testResultsLoadOnly - String ("STANDARD"|"ORIGINAL")
partialDatesStartDateImputationMethod - String ("FIRST"|"LAST")
partialDatesEndDateImputationMethod - String ("FIRST"|"LAST")
studyDayValueDerivation - String ("ALL"|"MISSING")
studyDayAnchorDateForStudyDayCalculation - String ("TREATMENT_START"|"REFERENCE_START")
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:addStudy = function({studyName="", SDTMFolder="", selectedSDTMDomains = {}, ADaMFolder="", selectedADaMDomains = {}, makeCurrentStudy=1, testResultsLoadOnly = "STANDARD", partialDatesStartDateImputationMethod = "FIRST", partialDatesEndDateImputationMethod = "LAST", studyDayValueDerivation = "MISSING", studyDayAnchorDateForStudyDayCalculation = "TREATMENT_START"}, {default local},
JMPClinicalStudyManagerAPI:addStudies
Adds the studies to current configuration (use the JMPClinicalBatchConfiguration environment variable).
Arguments:
listOfAddStudyArgumentLists - Each element of this list is a list corresponding to the arguments to pass to JMPClinicalStudyManagerAPI:addStudy().
See JMPClinicalStudyManagerAPI:addStudy() for more details.
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:addStudies = function({listOfAddStudyArgumentLists = {}},
JMPClinicalStudyManagerAPI:refreshStudies
Refreshes the metadata of the studies in the current configuration (use the JMPClinicalBatchConfiguration environment variable).
Arguments:
StudyNames - String, or List of Strings - name of the study, or names of the studies, to refresh
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:refreshStudies = function({studyNames = {}},
JMPClinicalStudyManagerAPI:deleteStudies
Deletes the studies from the current configuration (use the JMPClinicalBatchConfiguration environment variable).
Arguments:
studyNames - String, or List of Strings - name of the study, or names of the studies, to delete
keepOnDelete - String - "PREF" (default) honor the preference for keeping notes even after delete, "NO" override the preference and do not keep notes, "YES" override the preference and keep notes
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:deleteStudies = function({studyNames, keepOnDelete="PREF"},
JMPClinicalStudyManagerAPI:updateSnapStudy
Updates the snapshot of the study in the current configuration (use the JMPClinicalBatchConfiguration environment variable).
Arguments:
selectedStudy - String - name of the study
snapshotNumber - integer - the new snapshot number
newSdtmSourceDataFolder - String - path to the new SDTM data folder. Use "" if no SDTM data (at least one of newSdtmSourceDataFolder or newAdamSourceDataFolder must be specified)
newSelectedSDTMDomains - List - list of the selected domains for the new SDTM folder. Use {} to take all possible domains
newAdamSourceDataFolder - String - path to the new ADaM data folder. Use "" if no ADaM data (at least one of newSdtmSourceDataFolder or newAdamSourceDataFolder must be specified)
newSelectedADaMDomains - List - list of the selected domains for the new ADaM folder. Use {} to take all possible domains
cb_trt_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Treatment Variables"
cb_spid_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Sponsor-Defined Identifier"
cb_seq_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Sequence Number"
cb_dom_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Domain"
cb_grp_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Group ID"
cb_ref_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Reference ID"
cb_lnk_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Link ID"
cb_lnkg_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Link Group ID"
Returns:
N/A
Syntax:
JMPClinicalStudyManagerAPI:updateSnapStudy = function({selectedStudy="", snapshotNumber=., newSdtmSourceDataFolder="", newAdamSourceDataFolder="", cb_trt_val=1, cb_spid_val=1, cb_seq_val=1, cb_dom_val=1, cb_grp_val=1, cb_ref_val=1, cb_lnk_val=1, cb_lnkg_val=1},
JMPClinicalStudyManagerAPI:getValueOrderDomains
Returns the list of domains registered by the custom value order and color system, for the given study.
Arguments:
study - String - name of the study
Returns:
A list of domains
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderDomains = function({study},
JMPClinicalStudyManagerAPI:getValueOrderDomainLabel
Returns the domain label registered by the custom value order and color system, for the given study and domain.
Arguments:
study - String - name of the study
domain - String - name of the domain
Returns:
A String of the domain label
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderDomainLabel = function({study, domain},
* JMPClinicalStudyManagerAPI:getValueOrderDomainVariables
Returns the list of variables registered by the custom value order and color system, for the given study and domain.
Arguments:
study - String - name of the study
domain - String - name of the domain
Returns:
A list of variables
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderDomainVariables = function({study, domain},
JMPClinicalStudyManagerAPI:getValueOrderVariableLabel
Returns the variable label registered by the custom value order and color system, for the given study, domain, and variable.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
Returns:
A String of the variable label
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderVariableLabel = function({study, domain, variable},
JMPClinicalStudyManagerAPI:getValueOrderVariableColorTheme
Returns the value color theme of the variable registered by the custom value order and color system, for the given study, domain, and variable.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
Returns:
A String of the color theme name
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderVariableColorTheme = function({study, domain, variable},
JMPClinicalStudyManagerAPI:getValueOrderVariableColorOverrides
Returns the value color overrides of the variable registered by the custom value order and color system, for the given study, domain, and variable.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
returnRGB - integer - if 0 (default), returns JMP internal color values (single integers); if 1, returns RGB ({red, green, blue}) color values (three numbers) in the 0-to-1 range; if 2, returns RGB in the 0-to-255 range
Returns:
An associative array (variable value (String), color (number)) of the color overrides
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderVariableColorOverrides = function({study, domain, variable, returnRGB = 0},
);
JMPClinicalStudyManagerAPI:getValueOrderVariableLegendPreview
Returns the value order and colors of the variable registered by the custom value order and color system, for the given study, domain, and variable.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
returnRGB - integer - if 0 (default), returns JMP internal color value (integer); if 1, returns RGB ({red, green, blue}) color values (three numbers) in the 0-to-1 range; if 2, returns RGB in the 0-to-255 range
Returns:
An ordered list (according to value order) of associative arrays specifying color (variable value (String), color (number))
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderVariableLegendPreview = function({study, domain, variable, returnRGB = 0},
JMPClinicalStudyManagerAPI:getValueOrderVariableSortState
Returns the sort state of value order of the variable registered by the custom value order and color system, for the given study, domain, and variable.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
Returns:
A String of the value order sort state
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderVariableSortState = function({study, domain, variable},
JMPClinicalStudyManagerAPI:getValueOrderVariableValueOrder
Returns the value order of the variable registered by the custom value order and color system, for the given study, domain, and variable.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
Returns:
A list of the value order
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderVariableValueOrder = function({study, domain, variable},
JMPClinicalStudyManagerAPI:getValueOrderValueColorOverride
Returns any value color override of the value of the variable registered by the custom value order and color system, for the given study, domain, variable, and value.
Arguments:
study - String - name of the study
domain - String - name of the domain
variable - String - name of the variable
value - String - name of the value
returnRGB - integer - if 0 (default), returns JMP internal color value (integer); if 1, returns RGB ({red, green, blue}) color values (three numbers) in the 0-to-1 range; if 2, returns RGB in the 0-to-255 range
Returns:
A number of the color override for the value (if an override does not exist for the value, missing (.) is returned)
Syntax:
JMPClinicalStudyManagerAPI:getValueOrderValueColorOverride = function({study, domain, variable, value, returnRGB = 0},
JMPClinicalStudyManagerAPI:setValueOrderVariableColorTheme
Sets the value color theme of the variable registered by the custom value order and color system, for the given studies, domain, and variable.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain -OR- "_All_" to specify all domains and variables in each specified study
variable - String - name of the variable (ignored if domain argument = "_All_")
theme - String - name of the color theme -OR- a special action: "_Reset_": reset to default
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderVariableColorTheme = function({studies, domain, variable, theme},
JMPClinicalStudyManagerAPI:setValueOrderVariableColorOverrides
Sets the value color overrides of the variable registered by the custom value order and color system, for the given studies, domain, and variable.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain -OR- "_All_" to specify all domains and variables in each specified study
variable - String - name of the variable (ignored if domain argument = 1)
overrides - associative array - level names (keys) and color values (values) of the level color overrides (either internal values (integer) or RGB (list of three numbers) or color name (String)) -OR- String specifying a special action: "_Clear_" clear (no overrides), "_Reset_" reset to default, "_All_" mark all existing level colors as overrides
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderVariableColorOverrides = function({studies, domain, variable, overrides},
JMPClinicalStudyManagerAPI:setValueOrderVariableSortState
Sets the sort state of value order of the variable registered by the custom value order and color system, for the given studies, domain, and variable.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain -OR- "_All_" to specify all domains and variables in each specified study
variable - String - name of the variable (ignored if domain argument = 1)
sortstate - String - name of the value order sort state -OR- a special action: "_Reset_" reset to default
Returns:
None
side effect - also sorts the level values accordingly
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderVariableSortState = function({studies, domain, variable, sortstate},
JMPClinicalStudyManagerAPI:setValueOrderVariableValueOrder
Sets the value order of the variable registered by the custom value order and color system, for the given studies, domain, and variable.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain
variable - String - name of the variable
valueorder - list - level names of the variable in any specified order (all levels must be present and must match case exactly)
Returns:
None
side effect - also sets the sort state to "Ad Hoc"
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderVariableValueOrder = function({studies, domain, variable, valueorder},
JMPClinicalStudyManagerAPI:setValueOrderValueColorOverride
Sets the value color override of the value of the variable registered by the custom value order and color system, for the given studies, domain, variable, and value.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain
variable - String - name of the variable
value - String - name of the value
override - number - the color value of the specified level value (either internal value (integer) or RGB (list of three numbers) or color name (String))
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderValueColorOverride = function({studies, domain, variable, value, override
JMPClinicalStudyManagerAPI:applyAllTreatmentValueOrder
Copies the value order preferences from one treatment variable to all, in variables registered by the custom value order and color system.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain from which to copy from
variable - String - name of the variable from which to copy from
applyOrder - integer - specifies (0) do not copy order preferences, (1) copy order preferences
applyColor - integer - specifies (0) do not copy color preferences, (1) copy color preferences
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:applyAllTreatmentValueOrder = function({studies, domain, variable, applyOrder = 0, applyColor = 1},
JMPClinicalStudyManagerAPI:swapValueColor
Swaps the value color of two levels within a variable registered by the custom value order and color system, for the given studies, domain, and variable.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain
variable - String - name of the variable
value1 - String - name of one value
value2 - String - name of another value
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:swapValueColor = function({studies, domain, variable, value1, value2},
JMPClinicalStudyManagerAPI:addValueOrderDomain
Registers a domain with the custom value order and color system, for the given studies and domain.
CAUTION: Use at your own risk.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain to add
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:addValueOrderDomain = function({studies, domain},
JMPClinicalStudyManagerAPI:deleteValueOrderDomain
Unregisters a domain with the custom value order and color system, for the given studies and domain.
CAUTION: Use at your own risk.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain to delete
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:deleteValueOrderDomain = function({studies, domain},
JMPClinicalStudyManagerAPI:addValueOrderVariable
Registers a variable with the custom value order and color system, for the given studies and domain.
CAUTION: Use at your own risk.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain to add
variable - String - name of the variable to add
values (optional) - list - names of the values to add
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:addValueOrderVariable = function({studies, domain, variable, values = {}},
JMPClinicalStudyManagerAPI:deleteValueOrderVariable
Unregisters a variable with the custom value order and color system, for the given studies and domain.
CAUTION: Use at your own risk.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain
variable - String - name of the variable to delete
values (optional) - list - names of the values to delete (if any values are specified, only these values (and not the variable) will be deleted)
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:deleteValueOrderVariable = function({studies, domain, variable, values = {}),
JMPClinicalStudyManagerAPI:setValueOrderDomainLabel
Sets the domain label registered by the custom value order and color system, for the given studies and domain.
CAUTION: This function should only be used when adding custom domains to the value order and color system. Use at your own risk.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain
newDomainLabel - String - new label of the domain
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderDomainLabel = function({studies, domain, newDomainLabel},
JMPClinicalStudyManagerAPI:setValueOrderVariableLabel
Sets the variable label registered by the custom value order and color system, for the given studies domain, and variable.
CAUTION: This function should only be used when adding custom variables to the value order and color system. Use at your own risk.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
domain - String - name of the domain
variable - String - name of the variable
newVariableLabel - String - new label of the variable
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:setValueOrderVariableLabel = function({studies, domain, variable, newVariableLabel},
JMPClinicalStudyManagerAPI:resetAllValueOrderInfo
Resets all information in the custom value order and color system, for the given studies.
CAUTION: All custom value order and color settings for the specified studies will be reset to factory defaults.
Arguments:
studies - list - names (Strings) of the studies -OR- String - name of the study
Returns:
None
Syntax:
JMPClinicalStudyManagerAPI:resetAllValueOrderInfo = function({studies},
JMPClinicalStudyManagerAPI:loadStudyADSLDataTable
Loads the ADSL table into memory.
Arguments:
study - String - name of the study
Returns:
Table Reference - data table reference for the ADSL table for the study
Throws:
Exception if study specified doesn't exist
Syntax:
JMPClinicalStudyManagerAPI:loadStudyADSLDataTable = function({study}, {},
if (!JMPClinicalStudyManagerAPI:getStudyExists(study),
throw(JMPClinicalStudyManagerAPI:InvalidStudyArgumentException);