AddEvent
Description:
Creates or finds an Event SDI, then returns its identifier.
Input Properties
participantid
Description:
Identifier of the Participant to which to add the new Visit Event.
Required:
Only if eventtype is Visit.
visiteventid
Description:
Identifier of the parent Visit Event to which to add the new Timepoint Event.
Required:
Only if eventtype is Timepoint.
eventlabel
Description:
Event labels to select the Event definition.
Required:
Yes.
eventdt
Description:
Event dates specifying when the Events occured.
Required:
Only for reoccuring events.
eventstatus
Description:
Statuses to be set for the new Events. Defaults to Completed.
Required:
No.
visitedsite
Description:
Identifiers of the Study Sites which the Participant visited for a Visit Event.
Required:
No.
visiteddepartment
Description:
Identifier of the Department associated with the Study Site which the Participant visited for a Visit Event. Used to determine the Visited Site Id.
Required:
No.
visitedsitename
Description:
List of site descriptions. Used to determine Visited site
Required:
no
adhocevtflag
Description:
Adhoc Event flag (Y|N). Defaults to N.
Required:
No.
Comments:
A value of Yes specifies that the Event referred to in the eventlabel property may not be one currently defined for the Protocol, and if the Event cannot be found then a new ad-hoc Event should be created for the Participant. A value of No will generate an error if the eventlabel is not found in the Protocol.
eventtype
Description:
Type of the Event to create. Must be either Visit or Timepoint.
Required:
Yes.
eventdefid
Description:
List of Event definitions (identifiers of the Events defined in the Protocol).
Required:
No.
Comments:
An Event is generated by the Action for the specified Event definition ids.
auditreason
Description:
Auditing information recorded in the "Reason" column of the TraceLog table.
Required:
No.
auditactivity
Description:
Auditing information recorded in the "Activity" column of the TraceLog table.
Required:
No.
auditsignedflag
Description:
Auditing information recorded in the "SignedFlag" column of the TraceLog table.
Required:
No.
Output Properties
neweventid
Description:
Identifier of the newly added LV_ParticipantEvent SDI or the found LV_ParticipantEvent SDI. If more than one SDI has been added or found, this is a semicolon-delimited list.
Additional Information
Additional information concerning this Action:
Before creating a new Event, the Action looks for the relevant Event definition in the Protocol.
If the event definition is not found and the value of argument "adhocevtflag" is "Yes", this Action creates an adhoc Event (that is, a participantevent without an Event definition is created). This Action creates either a Visit or a Timepoint Event based on the value of the eventtype argument.

Mandatory inputs:
1. If the eventtype argument passed to the action is "Visit", participantid, and eventlabel are mandatory inputs.
2. If the eventtype argument is "Timepoint", visiteventid (eventid of parent visit), and eventlabel are mandatory inputs.

A list of extra LV_PartcipantEvent user fields can be passed to the Action in the event_ format (where is the user field of the LV_ParticpantEvent SDC).

This Action is invoked to find/create a participant event (visit or timepoint) when receiving the sample via a TISM page or when the Form is submitted. All multi-value arguments must have the same number of semicolon-separated values.

You can add multiple visit events of a participant by entering multiple values for event labels. Use a semicolon to separate each value. For example, consider the following Input Properties:
participantid = p01
eventlabel = 1month;2month
eventdt = 4/6/2009
adhocevtflag = Yes
eventtype = Visit
event_usercol = Test
This adds 2 visit events with labels 1month & 2month.
In this case, all the arguments except eventlabel are expanded to match the width of eventlabel argument.
In addition, the action also updates the value of "usercol" column of the ParticipantEvent SDC to test.

This Action affects records in the LV_ParticipantEvent SDC table.

Copyright © 1999-2016 LABVANTAGE Solutions, Inc.