Contents
-
Writing Tachyon Instructions
-
Getting started with TIMS
-
Installing TIMS
-
Running instructions in Tachyon for the first time
-
Instruction Definition Reference
-
SCALE User Guide
-
Functions and Methods Reference
-
Tachyon Agent Methods
-
Agent.CheckForUpdates
-
Agent.Echo
-
Agent.GetConnectionInformation
-
Agent.GetDiagnostics
-
Agent.GetExtensibility
-
Agent.GetInstructionStatistics
-
Agent.GetKeyFiles
-
Agent.GetSummary
-
Agent.Log
-
Agent.Sleep
-
Agent.Stagger
-
ContentDistribution.Stage
-
ContentDistribution.StageAndExecute
-
Device.GetCriticality
-
Device.GetDisks
-
Device.GetInboundMappedDriveHistory
-
Device.GetInboundPrinters
-
Device.GetLocation
-
Device.GetOutboundMappedDriveHistory
-
Device.GetOutboundPrinters
-
Device.GetProcessors
-
Device.GetSummary
-
Device.SetCriticality
-
Device.SetLocation
-
Discovery.LookupNetBiosNames
-
Discovery.ScanPortsOnDevices
-
Discovery.SendArpRequest
-
FileContent.AppendText
-
FileContent.FindAndAppend
-
FileContent.FindAndDelete
-
FileContent.FindAndReplace
-
FileContent.GetTorrentAnnounceUris (deprecated)
-
FileContent.GetTorrentDescribedFiles (deprecated)
-
FileContent.GetTorrentInfo (deprecated)
-
FileContent.WriteText
-
FileSystem.CreateTempFile
-
FileSystem.DeleteFileByName
-
FileSystem.FindDirectoryByName
-
FileSystem.FindFileByName
-
FileSystem.FindFileBySizeAndHash
-
FileSystem.GetDigitalSignature
-
FileSystem.GetDirectoryHash
-
FileSystem.GetFile
-
FileSystem.GetFileByLine
-
FileSystem.GetFileDetails
-
FileSystem.GetFileHash
-
FileSystem.GetFilePermissions
-
FileSystem.GetFilesInDirectory
-
FileSystem.GetFilesInFolder (deprecated)
-
FileSystem.GetHash (deprecated)
-
FileSystem.GetVersionInfo
-
FileSystem.PathExists
-
Http.Post
-
Interaction.GetActiveResponses
-
Interaction.GetInteractionState
-
Interaction.GetResponseHistory
-
Interaction.GetSessions
-
Interaction.GetWindows
-
Interaction.InvalidateResponse
-
Interaction.SetDoNotDisturb
-
Interaction.ShowAnnouncement
-
Interaction.ShowNotification
-
Interaction.ShowQuestion
-
Interaction.ShowSurvey
-
Inventory.GetTables
-
Method Notes
-
Mobile.GetEmailAddress
-
Mobile.GetEncryptionStatus
-
Mobile.GetLocation
-
Mobile.GetMobileSummary
-
Mobile.GetPasswordQuality
-
Mobile.IsGPSEnabled
-
Mobile.IsPrintingSupported
-
NativeServices.GetWmiNames
-
NativeServices.RegistryDeleteKey
-
NativeServices.RegistryDeleteUserKey
-
NativeServices.RegistryDeleteUserValues
-
NativeServices.RegistryDeleteValue
-
NativeServices.RegistryEnumerateKeys
-
NativeServices.RegistryEnumerateUserKeys
-
NativeServices.RegistryEnumerateUserValues
-
NativeServices.RegistryEnumerateValues
-
NativeServices.RegistryGetUserValues
-
NativeServices.RegistryGetValue
-
NativeServices.RegistryKeyExists
-
NativeServices.RegistrySetUserValues
-
NativeServices.RegistrySetValue
-
NativeServices.RegistryUserKeyExists
-
NativeServices.RegistryUserValueExists
-
NativeServices.RegistryValueExists
-
NativeServices.RunCommand
-
NativeServices.RunWmiInstanceMethod
-
NativeServices.RunWmiQuery
-
NativeServices.RunWmiStaticMethod
-
Network.GetArpEntries
-
Network.GetConnections
-
Network.GetDnsEntriesByAddress
-
Network.GetIpAddress (deprecated)
-
Network.GetIpAddresses
-
Network.GetListeningEndpoints
-
Network.GetNetworkSummary
-
Network.GetWiFiNetworks
-
Network.SetAirplaneMode
-
Network.SetBlueToothMode
-
Network.SetWiFiMode
-
Nomad.CachedPkgStatus
-
Nomad.FindBestPkgCache
-
Nomad.GetCachedPkgDetails
-
Nomad.GetCmContentLocations
-
Nomad.GetVariable
-
Nomad.JobsStatus
-
Nomad.Pause
-
Nomad.PauseJobQueue
-
Nomad.Resume
-
Nomad.ResumeJobQueue
-
Nomad.RunPkgStatusRequest
-
Nomad.RunSsdQuery
-
Nomad.Status
-
Nomad.Stop
-
OperatingSystem.ControlService
-
OperatingSystem.GetInstalledUpdates
-
OperatingSystem.GetProcesses
-
OperatingSystem.GetRunningApps
-
OperatingSystem.GetServiceInfo
-
OperatingSystem.GetSummary
-
OperatingSystem.GetUpdatesPendingReboot
-
OperatingSystem.GetUpdateSummary
-
OperatingSystem.KillProcess
-
OperatingSystem.KillProcesses
-
Patch.Deploy
-
Patch.GetStatus
-
Patch.List
-
Patch.TestConnection
-
Policy.ForceStatusReport
-
Policy.GetEventSubscriptions
-
Policy.GetRuleEvaluationHistory
-
Policy.GetRules
-
Policy.GetStatistics
-
Policy.GetSummary
-
Policy.Invalidate
-
Scripting.Run
-
Scripting.RunText
-
Security.CheckSimpleIoc (deprecated)
-
Security.DeleteCertificates
-
Security.GetCertificates
-
Security.GetQuarantineStatus
-
Security.ModifyQuarantineWhitelist
-
Security.QuarantineDevice
-
Security.UnquarantineDevice
-
Software.GetInstallations
-
Software.GetUserInstallations
-
Software.Uninstall
-
Storage.Check
-
Storage.Delete
-
Storage.Get
-
Storage.GetRemote
-
Storage.List
-
Storage.Set
-
Tagging.Check
-
Tagging.Clear
-
Tagging.Count
-
Tagging.Delete
-
Tagging.Get
-
Tagging.GetAll
-
Tagging.Set
-
Users.FindLocalGroupMember
-
Users.GetInboundConnectionHistory
-
Users.GetLocalGroupMembers
-
Users.GetLoggedOnUsers
-
Users.GetOutboundConnectionHistory
-
Users.GetPrimaryUser
-
Utilities.GenerateSequence
-
Utilities.JsonFromTable
-
Utilities.SplitLines
-
Utilities.TableFromJson
-
Agent.CheckForUpdates
-
Tachyon Agent Built-in Functions
-
Tachyon Agent Built-in Keywords
-
Tachyon Agent SQL Functions
-
Tachyon Agent Methods
-
Custom Response Visualizations
-
Training Lab Guide - Advanced
-
Getting started with TIMS
-
Integrating with Tachyon
-
Tachyon .NET Consumer SDK
-
Tachyon PowerShell Toolkit
-
Index
Method | ShowSurvey |
---|---|
Module | Interaction |
Library | Core |
Action | Display a pop-up survey to one or more user sessions. The pop-up includes questions text followed by a set of selectable choices, and an optional free text box. |
Parameters |
If set to |
In synchronous mode the method will only return once all user sessions have responded or have timed out. | |
The table consists of rows of Text strings, and optionally a Color value. An Icon may also be optionally associated with each entry. | |
| |
FreeTextLabel (string, optional, default "Anything more you'd like to tell us? "): If AllowFreeText is true , then this can be used to set an alternative label for the free text field of the survey. | |
| |
This is used to uniquely identify the survey, and prevent repeat showing of the same survey. | |
Question (string): Question text that will be displayed as part of this survey. Max 128 characters. | |
The maximum value allowed is 129600 minutes (90 days). Default is 0 which means survey maximum validity period of 90 days will apply. Response validity is a way to avoid repeatedly presenting a user with the same survey. When a user provides an answer to a survey, the response they give is deemed to be "valid" for the duration specified here. You may then use the Interaction.GetActiveResponses method to test whether there is already a valid answer for a particular user/survey; if there is, you may wish to avoid calling Interaction.ShowSurvey and instead use their existing answer. Once the response validity period has elapsed, the response is no longer marked as valid, and will not appear in the table returned by Interaction.GetActiveResponses. You can force the one or more responses to be invalidated for a user/survey immediately by using the Interaction.InvalidateResponse method. | |
Minimum value is 30 seconds, maximum value is 900 seconds. | |
In synchronous mode this is not relevant and should not be supplied. | |
UserName (string, optional): Username of the session to which this survey should be directed. If Username is not supplied then the survey will be directed at all active user sessions. | |
Return values |
|
Response (string): Text of the selected choice. | |
Values are: "dismissed", "responded", "snoozed", "timed out", "invalid". | |
The highest ordered choice (first in the table of choices) will have a response value of 1. | |
UserName (string): Username of the logon session associated with this response. | |
Example | @a = SELECT "Very Happy" AS Text, "green" AS Color, "far-fa-grin-squint" AS Icon UNION ALL SELECT "Happy" AS Text, "#bf930f" AS Color, "far-fa-smile" as Icon UNION ALL SELECT "Indifferent" AS Text, "blue" AS Color, "far-fa-meh" as Icon UNION ALL SELECT "Quite unhappy" AS Text, "orange" AS Color, "far-fa-frown" as Icon UNION ALL SELECT "Very Unhappy" AS Text, "red" AS Color, "far-fa-tired" as Icon; // Synchronous survey to a single user session. Interaction.ShowSurvey(Async:false, Choices : @a, Name:"User Experience Survey", Question : "How happy are you with your user experience?", UserName:"acme\\development", AllowFreeText: true, FreeTextLabel: "Please elaborate"); // Asynchronous survey to all user sessions on this device and include a free text box. Interaction.ShowSurvey(Async:true, Choices : @a, Name:"User Experience Survey", Question : "How happy are you with your user experience?", AllowFreeText: true, FreeTextLabel: "Please elaborate", Topic:"MyExperienceSurvey"); |
Platforms |
|
Notes | Available from v5.1. In order of appearance, these are: far-fa-grin-squint.png fas-fa-battery-full.png far-fa-hourglass.png fas-fa-thermometer-full.png fas-fa-thumbs-up.png |