Page History

...

1. The template code may be copied to the analysis and represented as analysis-specific code in the programmingCode attribute of the analyses. The copy process may or may not involve updating the code.
   1. If the template code is already executable, it may be copied, unmodified, into the analyses that use the method. In this situation, if any parameters are associated with the template code, any of these that require analysis-specific values would also need be copied to the analysis and updated to show the analysis-specific value used for execution of the code for the analysis. The analysis-specific value associated with each of these "runtime parameters" would be applied during execution of the code for the analysis.
   2. If the template code contains "replacement parameters" (i.e., the code contains identifiable placeholder strings that are expected to be replaced with analysis-specific parameter values in order to produce executable, analysis-specific, nonparameterized code), the placeholders in the code for each parameter would be replaced with the analysis-specific values during the copying process. In this situation, sponsors may choose to record the analysis-specific values applied during the copying process as parameter values associated with the resultant analysis-specific programming code. Alternatively, only the template code parameters (which include a specification for the expected analysis-specific value) could be retained.
2. Instead of copying template programming code into every analysis that uses the analysis method, sponsors may choose to implement template programming code by implied reference only. In this situation, the template programming code is not copied into each analysis; it remains defined only in the analysis method, being retrieved for each analysis (via the method identifier) only at the time of execution. If the template programming code is parameterized (with either replacement parameters or with runtime parameters), analysis-specific parameter values would need to be applied to the template code as part of the execution.
   1. If any parameter contains a specification indicating how to obtain the analysis-specific parameter value programmatically (e.g., it contains either a single, prespecified "default" value or a reference to a metadata attribute that provides the analysis-specific parameter value), it does not need to be represented within the analysis definition (although sponsors may choose to copy the parameter to the analysis to have a record of the parameter value being applied during execution).
   2. If a parameter does not contain a specification indicating how to obtain the analysis-specific parameter value programmatically (e.g., it does not have either a single, prespecified "default" or a reference to a metadata attribute that provides the analysis-specific value), the parameter must be copied to the analysis and updated to indicate the analysis-specific value applied during execution.

Provision of programming code for analyses, either directly in an analysis definition or via use of template programming code, is not required; sponsors may choose to include programming code to support their regulatory or operational requirements. When specified, template programming code for each analysis method is represented as an instance of AnalysisProgrammingCodeTemplate class and, in each instance:

• The context attribute

  Jira
  showSummary false server Issue Tracker (JIRA) serverId 85506ce4-3cb3-3d91-85ee-f633aaaf4a45 key ARSP-24

  is used to specify the name and version of the computer language used for the programming statements.
• The template programming statements may be provided by either:
  • storing the statements directly in the code attribute of the AnalysisProgrammingCodeTemplate class, or
  • referencing a template programming code document in the documentRef attribute of the AnalysisProgrammingCodeTemplate class (see the DocumentReference section for more information about programming code document references).

...

• • • • Provide sufficient supporting information so that it is obvious to the receiver how template parameter values are applied during execution of analyses, or
      • Record all analysis-specific parameter values with each analysis.

...