If the sample does not exist and the autoaddsdi value passed is 'Y' ( YES ), the action creates the sample with the sampleid provided.
If no sample ID is provided, the auto key generation rule will be used to generate the sample id.
If a dataset does not exist and autoadddataset is 'Y', it will be created using the paramlist and variant.
If autoadddataset is passed as R (remeasure), a Dataset is added by remeasuring the max dataset of the sample.
if autoadddataset is Y and if autoaddsdiworkitem is Y and workitemid is provided then AddSDIWorkItem will be called to add the missing dataset.
If dataset is added by AddSDIWorkItem action, dataset number is always the sample's max dataset of the paramlist + 1.
if autoadddataset is Y and if autoaddsdiworkitem is Y and workitemid is not provided then error will be thrown as workitemid is required to be provided when autoaddsdiworkitem is Y(YES).
If the parameter does not exist, it will be added on the fly to dataset, if autoaddparameter property is Y.
If the parameter exists and replicateid is not matched and if the replicate is higher than existing max replicate of that parameter, it will be added if autoaddreplicate property is passed as Y.
If dataset is not provided, default dataset is considered as First Available.
If replicateid is not provided, default replicate will be considered as First Available.
Default dataset can be set as One (same for default replicate).
If replicateid was not provided, and default replicate is considered as First Available, then if a free replicate is available with the matching paramlistid, param etc, it is populated else it creates next higher replicate and populate it, provided AutoAddReplicate is set as ALWAYS.
If dataset no. not provided, default dataset is considered as First Available, then if a free dataitem available in any of the dataset, it is populated else it creates next higher dataset and populate it, only if AutoAddDataSet is set as ALWAYS.
If both AutoaddReplicate and AutoAddDataset are set as ALWAYS, autoAddReplicate gets priority.
Releasehandingrule property is set as E(ERROR) by default. If dataitem to be posted with the value is found to be in released state, it will throw error.
If releasehandingrule property is set as I(IGNORE), data will not be posted to released dataitem.
If releasehandingrule property is set as O(OVERRIDE), released dataitem will be overidden.
if autorelease is Y(Yes), value will be released, default N.
Any column value passed will get populated, if the column belongs to Primary(e.g. Sample), sdidata, sdiworkitem, sdidataitem and the object is added new by the action.
In the example below, sampledesc is populated in sample SDIs newly created, scheduleplanid is a valid column for sdiworkitem and sdidata, so if sdiworkitem is added, it will be populated.
It will be populated in sdidata if it is created by the action. If new dataitem is added, datatypes will get populated as numeric(N).
For an example showing how to pass multiple values into each property, please see the documentation for the EnterDataItem action.
Optional properties to control the save operation:
autoaddsdi = Y
autoadddataset = Y/R
autoaddsdiworkitem = Y
autoaddparameter = Y
autoaddreplicate = Y
releasehandlingrule = O/I/E
defaultdataset=First Available;
defaultreplicate=First Available;
autorelease = Y
Examples for populating additional columns:
sampledesc=desc1;desc2;desc3
datatypes=N;N;N
mandatoryflag=Y;N;N
scheduleplanid=s1;s2;s3
This Action internally calls the AddSDI action to add new SDI (known as the Primary).
Then it calls the AddDataSet, AddSDIWorkItem, RemeasureDataset, ExtendDataset and AddReplicate actions
to add any missing objects (provided the options are set).
This Action internally calls EnterDataItem which can change the values in the TransformValue, EnteredQualifier, and DisplayValue columns in the SDIDataItem table.
Like the EnterDataItem action, this action has no support for propsmatch ='N'.
As a best practice, each call to this action should represent a single dataitem. All the corresponding property values should refer to that dataitem only.
If any column for any row is empty, it is not filled in by the property value of its previous row. This is identical to the behavior of the EnterDataItem action
In this action, for the sdidataitem with blank replicateid, default replicate value will be considered as First Available and it can be also set as One by the action property defaultreplicate
In this action, for the sdidataitem with blank dataset no., default dataset value will be considered as First Available and it can be also set as One by the action property defaultdataset
If multiple values are posted for the same dataitem by specifying replicate and dataset or specifying default dataset and default replicate as one,
the last value will be persisted but there should be audit records available for each values posted to the dataitem.