1. 规则开发人员指南
  2. 规则帮助函数引用
  3. 格式设置和其他函数
  4. getValues( )

getValues( )

使用此辅助函数可按访问顺序以数组格式提取多个访问中一个或多个变量的值。

注意：

这是一个聚集函数。如果目标位于重复表单上，则为每个表单实例运行规则。

与两节形式一起使用时，可以使用 GetCurrentRFInstance( ) 将规则限制为仅对当前两节表单实例运行。

语法

getValues('var1', 'var2', ...)

参数

'var1', 'var2', ...
规则变量名称（定义访问、表单或项）。

返回值

在成功时返回 true；否则返回 false。

此外，在调用此函数期间，将使用得到的值重新定义规则变量：

注意：

如果没有与此变量相关的数据元素，则规则变量将重新定义为 null。因此，在将变量用于处理数据之前，应始终验证变量是否包含任何数组元素。
  • var1、var2...- 作为参数传入的每个变量都包含一个具有结果的数组。数组中的每一项（例如 var1[0]）包含以下内容：
    • var1[0].visitName - 访问的名称
    • var1[0].deleted - 如果删除重复表单实例，则为 true
    • var1[0].tableRowInstance - 重复表行实例，以防其位于表中
    • var1[0].branchName - 分支的名称
    • var1[0].eventType - 访问类型 - ScheduleAbleVisit、UnScheduleAbleVisit、事件等
    • var1[0].formRepeatNumber - 案例表单中的重复表单实例编号是重复表单
    • var1[0].value - 数据元素值，如果清除值，则为 null
    • var1[0].cycleNumber - 访问的周期编号，以防在周期内
    • var1[0].empty - 如果值已清除或从未以重复形式输入，则为 true
    • var1[0].treatmentArm - 治疗臂
  • 日期元素：
    • 如果变量是完整日期，则返回的变量值是 Date 对象。
    • 如果变量是部分日期，则返回的变量值是 C1Date 对象。

      提示：

      对于部分日期，值作为对象返回，必须使用日期部分（例如 item.value.day、item.value.month 等）提取，而不是仅使用 item.value。
      // Sample JSON response for a partial date item:
[
    {
        "visitName": "visit1",
        "deleted": false,
        "tableRowInstance": null,
        "branchName": null,
        "eventType": "ScheduleAbleVisit",
        "formRepeatNumber": null,
        "value": {
            "partialDate": true,
            "date": null,
            "day": "UNK",
            "month": 2,
            "year": 2021
        },
        "cycleNumber": null,
        "empty": false,
        "treatmentArm": null
    }
]
  • 选项控制元素：如果变量是选项控件（复选框、单选或下拉列表），则返回的变量值是 JSON 格式的字符串：
     "[{\"value\":\"3\",\"label\":\"TestLabel\"}]"
    这可以使用 JSON.parse 或 parseChoice( ) 进行解析。

使用提示

如果使用为任何访问定义的变量，则必须使用此辅助函数获取值并在表达式中使用它们。您无法直接在逻辑中使用变量。使用以下格式，其中 'variable' 是您的任何访问类型变量：
getValues('variable')
通过这种类型的变量定义，您可以处理在表单中收集的数据，这些表单与您要在其中创建规则的目标表单不在同一访问中。有关详细信息，请参阅定义规则变量。

限制

如果问题存在于多个访问中，则 getValues( ) 返回的数据量可能很大。这可能会影响数据提交的性能。

注意：

将变量传递到 getValues( ) 后，不能将其重新用作规则中其他位置的离散值。如果需要引用行的离散值并访问其他位置，则需要声明第二个变量。

示例 3-102 查看单个项的 getValues 函数调用的结果

// this can be helpful during rule development to view the results returned by the getValues function
// using a read-only text field as the target
 
var val = getValues("item1");
if (val == true) {
    return JSON.stringify(item1);
}
 
/* example results:
[
    {
        "visitName": "visit1",
        "deleted": false,
        "tableRowInstance": null,
        "branchName": null,
        "eventType": "ScheduleAbleVisit",
        "formRepeatNumber": null,
        "value": "Test",
        "cycleNumber": null,
        "empty": false,
        "treatmentArm": null
    },
    {
        "visitName": "visit2",
        "deleted": false,
        "tableRowInstance": null,
        "branchName": null,
        "eventType": "ScheduleAbleVisit",
        "formRepeatNumber": null,
        "value": "Test",
        "cycleNumber": null,
        "empty": false,
        "treatmentArm": null
    }
]
*/

示例 3-103 对所有访问的所有肿瘤直径值求和

var sumTotalLongestDiameter = -1;
  
function calculateTumor(item, index)
{
    if ( longestDiameter[index] !== null )
    {
        sumTotalLongestDiameter += longestDiameter[index].value;
    }
}
  
var rc = getValues("tumorID", "longestDiameter");
  
if ( rc === true )
{
    tumorID.forEach(calculateTumor);  
      
    // Set the value for the current row where this rule runs
    return sumTotalLongestDiameter;
}

示例 3-104 在所有访问中汇总肿瘤直径值，使用过滤功能排除筛查访问

var rc = getValues("tumorID", "longestDiameter");
  
//filter by visit name
function filterFunction(item) {
  return item.visitName  !== 'Screening';
}
  
var sumTotalLongestDiameter = -1;
  
function calculateTumor(item, index)
{
    if ( longestDiameter[index] !== null )
    {
        sumTotalLongestDiameter += longestDiameter[index].value;
    }
}
  
if ( rc === true )
{
    //exclude Screening visit
    var filterResult = tumorID.filter(filterFunction);
    filterResult.forEach(calculateTumor);
      
    // Set the value for the current row where this rule runs
    return sumTotalLongestDiameter;
}

示例 3-105 使用相同格式的目标和操作数查找上一个/下一个值

规则变量：
  • brDateForFunc - 引用日期的规则变量。
  • brDate - 引用日期的规则变量（与第一个引用不同名称的规则变量相同，以防应比较不同访问上的相同项）。 
var visitName = getCurrentVisitPropertyValue("visitid");
var currCycle = getCurrentCycle();var prevValue = null;
var prevValueFound = false;

function getPrevValue(item){
    if(prevValueFound) return;
    if(item.visitName==visitName && item.cycleNumber==currCycle){
        prevValueFound = true;        return;
    }
    if(item.eventType!='UnScheduleAbleVisit' && item.value!=null)
        prevValue = item.value;    
}    

var res = getValues('brDateForFunc');
if(res){
    brDateForFunc.forEach(getPrevValue);            
         //in case the next visit should be found the array should be reverted:
         //brDateForFunc.reverse().forEach(getPrevValue);  
       
//here should go the necessary logic to compare brDate with previous value which is now in variable prevValue
}

示例 3-106 使用不同表单上的目标和操作数查找下一个值或最接近的下一个值

规则变量：
  • aeDate - 引用 AE 表单上的日期的规则变量。
  • cycleDate1 - 引用第一次周期访问时的日期的规则变量。
  • cycleDate2 - 引用第二次周期访问日期的规则变量。
  • cycleCheck1 - 规则变量，引用第一次周期访问时的某个条件。
  • cycleCheck2 - 规则变量，引用第二个周期访问中的某个条件。
  • vsd - 具有“所有访问”选项的访问开始日期 
var lastStartedlVisit = null;
var lastVisitFound = false;
var cycleDate = null;
var cycleCheck = null;
var cycleNumber = null;

function getLastStartedlVisit(item){
    if(lastVisitFound || item.eventType=='UnScheduleAbleVisit') return;

      //condition may depend on where the point of comparison is, at some situation it can be <if(item.value==null)> or something else
    if(item.eventType=='AdverseEvent'){
        lastVisitFound = true;
        return;
    }     
if(item.value!=null) {
        lastStartedlVisit = item;
   }
}

function findItem(item, index){
    if(item.cycleNumber === cycleNumber){
        if(this.valueOf()=='cycleDate') cycleDate = item.value;
        if(this.valueOf()=='cycleCheck') cycleCheck = item.value;
    }
}

var res = getValues('vsd');
if(res){
    //the first visit before AE
    vsd.forEach(getLastStartedlVisit);
    
    //in case the next visit should be found the array should be reverted:
    //vsd.reverse().forEach(getLastStartedlVisit);
    
    cycleNumber = lastStartedlVisit.cycleNumber;
    res = getValues('cycleDate1');
    if( cycleDate1[cycleDate1.length-1].visitName == lastStartedlVisit.visitName){
       cycleDate1.forEach(findItem, 'cycleDate');
       res = getValues('cycleCheck1');
       cycleCheck1.forEach(findItem, 'cycleCheck');
   }
   else{
       res = getValues('cycleDate2');
       if( cycleDate2[cycleDate2.length-1].visitName == lastStartedlVisit.visitName){
             cycleDate2.forEach(findItem, 'cycleDate');
             res = getValues('cycleCheck2');
             cycleCheck2.forEach(findItem, 'cycleCheck');
       }
    }
}
//logMsg(JSON.stringify(aeDate))
//logMsg(JSON.stringify(cycleDate));
//logMsg(JSON.stringify(cycleCheck));
//logic to compare cycleDate cycleCheck and aeDate

示例 3-107 将日期与下次访问开始日期进行比较

规则变量：
  • brDate - 引用日期的规则变量。
  • vsd - 引用“所有访问”选项的访问开始日期的规则变量。 
var visitName = getCurrentVisitPropertyValue("visitid");
var currCycle = getCurrentCycle();
//logMsg(visitName);
//logMsg(currCycle);
//logMsg(brDate);
var nextValue = null;
var nextValueFound = false;

function getNextValue(item){
    if(nextValueFound) return;
    if(item.visitName==visitName && item.cycleNumber==currCycle){
       nextValueFound = true;
       return;
    }
    if(item.eventType!='UnScheduleAbleVisit' && item.value!=null)
          nextValue = item.value;
}

var res = getValues('vsd');
if(res){
      vsd.reverse().forEach(getNextValue);
      //logMsg(nextValue);
      //logMsg(brDate);
      //compare next vsd with cycle date: vsd
}

父主题：格式设置和其他函数