AddStudy
Description:
Adds one or more Study SDIs.
Input Properties
protocolid
Description:
Protocol used for the Study.
Required:
Yes
protocolversionid
Description:
Version of the Protocol
Required:
No
productsdcid
Description:
SDC used to create the Product SDIs.
Required:
Yes
productkeyid1
Description:
Identifiers of the Product SDIs
Required:
Yes
productkeyid2
Description:
Identifiers of the Product SDIs
Required:
Only for multi-key SDCs.
productkeyid3
Description:
Identifiers of the Product SDIs
Required:
Only for multi-key SDCs.
containertypeid
Description:
Identifier of the Container Type (if any are associated with the Study).
Required:
No
studystatus
Description:
Status associated with the Study you are adding.
Required:
Yes
keyid1
Description:
Identifiers of the SDIs.
Required:
Yes
auditreason
Description:
Audit reason recorded in the "Reason" column of the TraceLog table.
Required:
No
eventnotify
Description:
Determines whether or not (Y/N) an EventNotify Action is posted onto the ToDo List when this Action executes.
Deprecated:
As of version 7, Event Notify actions are no longer generated
templateid
Description:
Identifier of a single-key SDI Template.
Required:
Only if the new SDIs are based on a single-key SDI Template.
overrideautokey
Description:
Enables/disables (Y/N) Automatic Key Generation. If enabling, specify keyid1, keyid2, and keyid3 for each new SDI.
Required:
No
copies
Description:
Number of copies to make of the new SDI.
Required:
No (defaults to 1).
Comments:
  • This works whether or not you base the new SDIs on an SDI Template.
  • To make multiple copies of an SDI Template, enable Automatic Key Generation using the overrideautokey property.
adduserroles
Description:
Grants/blocks (Y/N) SDI access for all Roles assigned to the current user.
Required:
No
Comments:
  • Do not use this property if the new SDIs are based on an existing SDI Template. In this case, use the addtemplateroles property.
  • Role-Level Access must be enabled for the SDC.
  • Use this property only in a JSP, as the JSP can pass the connectionid to the Action (thereby identifying the current user).
addtemplateroles
Description:
Grants/blocks (Y/N) SDI access for all Roles assigned to the current user.
Required:
No
Comments:
  • Use this property only if the new SDIs are based on an existing SDI Template.
  • Role-Level Access must be enabled for the SDC.
  • Use this property only in a JSP, as the JSP can pass the connectionid to the Action (thereby identifying the current user).
applyworkitems
Description:
Determines how the Workitem is associated with the SDIs:
  • Y associates all Workitem Items, as well as the Workitem itself.
  • N associates only the Workitem.
Required:
No
forcenew
Description:
Determines whether or not a new Data Set is added when Template Workitems are applied. This overrides the Workitem definition:
  • Y enables the "Force New" option for Workitems, and overrides the "Force New" setting in the Workitem Maintenance Page. When adding Workitems to this SDI, enabling the "Force New" option always creates a new dataset. This will let you resolve Data Sets after you have deleted the Workitem, as each Workitem Item will be uniquely identified.
  • N uses the "Force New" setting in the Workitem Maintenance Page.
Required:
No
Output Properties
newkeyid1
Description:
Identifiers of the added SDIs.
Additional Information
Additional information concerning this Action:
None.
Copyright © 1999-2016 LABVANTAGE Solutions, Inc.