SurveyFeatureLaunchSurvey Method

public void LaunchSurvey(
	CodeMethodInvokeContext context,
	string surveyScheduleUId,
	string scopeVariables,
	string surveySettings,
	int deadlineDays,
	out int surveyId
)

Parameters

context

Type: Omada.OE.ModelCodeMethodInvokeContext

surveyScheduleUId

Type: SystemString
UId of a predefined Survey Schedule data object which defines the survey to be launched

scopeVariables

Type: SystemString
Maps values from the Action object to the scope variables in the survey. The mapping string has the following format: [Scope variable name as defined in Survey template starting with @]=[System name of property or fixed field on Action object]; The following Fixed fields are supported: Id Type Number DisplayName CreateTime CreatedBy ChangeTime ChangedBy DeleteTime DeletedBy Locked Example of a mapping string if the Action object is an Identity: @identity=Id;@firstName=FirstName. If empty, the values for the scope variables of the survey will be retrieved from the Survey Schedule object. If not empty and the Survey Schedule contains values for the scope variables as well, the scope variable mapping will override the predefined values in the Survey Schedule

surveySettings

Type: SystemString
Maps values from the Action object to the survey settings in the survey. The mapping string has the following format: [Survey setting name as defined in Survey template]=[System name of property or fixed field on Action object]; The following Fixed fields are supported: Id Type Number DisplayName CreateTime CreatedBy ChangeTime ChangedBy DeleteTime DeletedBy Locked Example of mapping string if the Action object is an Identity: identity=Id;firstName=FirstName If empty, the values for the survey settings of the survey will be retrieved from the Survey Schedule object. If not empty and the Survey Schedule contains values for the survey settings as well, the survey settings mapping will override the predefined values on the Survey Schedule

deadlineDays

Type: SystemInt32
The deadline of the survey will be set from the day the survey is launched plus the number of days provided in this parameter If a value is provided, the deadline on the Survey schedule object will not be used

surveyId

Type: SystemInt32
Out parameter containing the id of the launched survey

Reference