scenario

package
v0.5.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2020 License: MIT Imports: 40 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	ActionConnectWs               = "connectws"
	ActionOpenApp                 = "openapp"
	ActionOpenHub                 = "openhub"
	ActionElasticOpenHub          = "elasticopenhub"
	ActionElasticReload           = "elasticreload"
	ActionElasticUploadApp        = "elasticuploadapp"
	ActionElasticCreateCollection = "elasticcreatecollection"
	ActionElasticDeleteCollection = "elasticdeletecollection"
	ActionElasticHubSearch        = "elastichubsearch"
	ActionElasticDeleteApp        = "elasticdeleteapp"
	ActionElasticCreateApp        = "elasticcreateapp"
	ActionElasticShareApp         = "elasticshareapp"
	ActionElasticExportApp        = "elasticexportapp"
	ActionElasticGenerateOdag     = "elasticgenerateodag"
	ActionElasticDeleteOdag       = "elasticdeleteodag"
	ActionElasticDuplicateApp     = "elasticduplicateapp"
	ActionElasticExplore          = "elasticexplore"
	ActionElasticMoveApp          = "elasticmoveapp"
	ActionElasticPublishApp       = "elasticpublishapp"
	ActionGenerateOdag            = "generateodag"
	ActionDeleteOdag              = "deleteodag"
	ActionUploadData              = "uploaddata"
	ActionDeleteData              = "deletedata"
	ActionCreateSheet             = "createsheet"
	ActionCreateBookmark          = "createbookmark"
	ActionDeleteBookmark          = "deletebookmark"
	ActionApplyBookmark           = "applybookmark"
	ActionSetScript               = "setscript"
	ActionChangeSheet             = "changesheet"
	ActionStaticSelect            = "staticselect"
	ActionSelect                  = "select"
	ActionClearAll                = "clearall"
	ActionIterated                = "iterated"
	ActionThinkTime               = "thinktime"
	ActionRandom                  = "randomaction"
	ActionSheetChanger            = "sheetchanger"
	ActionDuplicateSheet          = "duplicatesheet"
	ActionReload                  = "reload"
	ActionProductVersion          = "productversion"
	ActionPublishSheet            = "publishsheet"
	ActionUnPublishSheet          = "unpublishsheet"
	ActionDisconnectApp           = "disconnectapp"
	ActionDeleteSheet             = "deletesheet"
	ActionPublishBookmark         = "publishbookmark"
	ActionUnPublishBookmark       = "unpublishbookmark"
	ActionSubscribeObjects        = "subscribeobjects"
	ActionUnsubscribeObjects      = "unsubscribeobjects"
	ActionListBoxSelect           = "listboxselect"
	ActionClickActionButton       = "clickactionbutton"
)

Variables

View Source 
var ElasticOdagEndpointConfiguration = OdagEndpointConfiguration{
	Main:            "api/v1/odaglinks",
	Requests:        "api/v1/odagrequests",
	EnabledEndpoint: "api/v1/odagisavailable",
}
View Source 
var WindowsOdagEndpointConfiguration = OdagEndpointConfiguration{
	Main:            "api/odag/v1/links",
	Requests:        "api/odag/v1/requests",
	EnabledEndpoint: "api/odag/v1/isodagavailable",
}

Functions

func AddAppToCollection 

func AddAppToCollection(settings CanAddToCollection, sessionState *session.State, actionState *action.State, appImportResponse elasticstructs.AppImportResponse, host string) error

func AddItemToCollectionService added in v0.5.0 

func AddItemToCollectionService(sessionState *session.State, actionState *action.State, appImportResponse elasticstructs.AppImportResponse, title string, host string) (map[string]interface{}, error)

func AddTag added in v0.5.0 

func AddTag(sessionState *session.State, actionState *action.State, itemId string, host string, collectionId string) error

func CheckActionError 

func CheckActionError(err error) (bool, error)

CheckActionError check action errors, returns true if error cause is aborted action, error containing any remaining error after flattening possible multi.Error

func ClearObjectSubscriptions added in v0.5.6 

func ClearObjectSubscriptions(sessionState *session.State)

ClearObjectSubscriptions and currently subscribed objects

func Contains 

func Contains(list []string, match func(s string) bool) bool

Contains check whether any element in the supplied list matches (match func(s string) bool)

func DebugPrintObjectSubscriptions added in v0.5.6 

func DebugPrintObjectSubscriptions(sessionState *session.State)

func DoSelect added in v0.5.3 

func DoSelect(sessionState *session.State, actionState *action.State, genObj *enigma.GenericObject, gob *enigmahandlers.Object, wrap, accept bool, dimension, min, max int, selectionType SelectionType)

func FetchDataConnectionId added in v0.5.8 

func FetchDataConnectionId(sessionState *session.State, actionState *action.State, host string, userSpecific bool) *session.RestRequest

func GetConnTestFuncs 

func GetConnTestFuncs() []func(*connection.ConnectionSettings, *session.State, *action.State) error

func GetCurrentSheet 

func GetCurrentSheet(uplink *enigmahandlers.SenseUplink) (*senseobjects.Sheet, error)

GetCurrentSheet from objects

func GetOdagSelectionBindings 

func GetOdagSelectionBindings(host string, odagLinkId string, sessionState *session.State,
	actionState *action.State, odagEndpoint string) ([]elasticstructs.OdagLinkBinding, error)

GetOdagSelectionBindings gets information about the ODAG link, including bindings

func GetSheetEntry added in v0.5.6 

func GetSheetEntry(sessionState *session.State, actionState *action.State, app *senseobjects.App, sheetid string) (*senseobjects.SheetNxContainerEntry, error)

func IndexOf added in v0.5.8 

func IndexOf(match string, stringSlice []string) (int, bool)

IndexOf returns index of first match in stringSlice or else -1

func MakeOdagRequest 

func MakeOdagRequest(sessionState *session.State, actionState *action.State, odagLinkBindings []elasticstructs.OdagLinkBinding, host string, odagEndpoint OdagEndpointConfiguration, odagLinkId string, postObject elasticstructs.IOdagPostRequest, connection *enigmahandlers.SenseUplink) error

func NewActionsSettings 

func NewActionsSettings(typ string) interface{}

NewActionsSettings of type

func RegisterAction 

func RegisterAction(act string, settings ActionSettings) error

RegisterAction register a custom action and override any existing with same name This should be done as early as possible and must be done before unmarshaling actions

func RegisterActionOverride 

func RegisterActionOverride(act string, settings ActionSettings) error

RegisterActionOverride register a custom action and override any existing with same name This should be done as early as possible and must be done before unmarshaling actions

func RegisterActions 

func RegisterActions(customActionMap map[string]ActionSettings) error

RegisterActions register custom actions. This should be done as early as possible and must be done before unmarshaling actions

func RegisterActionsOverride 

func RegisterActionsOverride(customActionMap map[string]ActionSettings) error

RegisterActionsOverride register custom actions and override any existing with same name This should be done as early as possible and must be done before unmarshaling actions

func RegisterConnFunc 

func RegisterConnFunc(connFunc func(*connection.ConnectionSettings, *session.State, *action.State) error) error

RegisterConnFunc registers a custom connection function This should be done as early as possible and must be done before unmarshaling actions

func RegisterConnFuncs 

func RegisterConnFuncs(connFuncs []func(*connection.ConnectionSettings, *session.State, *action.State) error) error

RegisterConnFuncs registers custom connection functions. This should be done as early as possible and must be done before unmarshaling actions

func RegisteredActions 

func RegisteredActions() []string

RegisteredActions returns a list of currently registered actions

func ResetDefaultActions 

func ResetDefaultActions()

ResetDefaultActions reset action list to default list. Used e.g. for tests overriding default actions

func ResetDefaultConnFuncs 

func ResetDefaultConnFuncs()

func SearchForSpaceByName added in v0.5.0 

func SearchForSpaceByName(sessionState *session.State, actionState *action.State, host, spaceName string) (*elasticstructs.Space, error)

SearchForSpaceByName looks for space in artifact map or tries to request from server, returns space ID

Types

type AbortedError 

type AbortedError struct{}

AbortedError action was aborted

func (AbortedError) Error 

func (err AbortedError) Error() string

Implement error interface

type Action 

type Action struct {
	ActionCore
	Settings ActionSettings `json:"settings,omitempty" doc-key:"config.scenario.settings"`
}

Action simulated user action

func (*Action) AppStructureAction added in v0.5.2 

func (act *Action) AppStructureAction() (*AppStructureInfo, []Action)

AppStructureAction returns if this action should be included when getting app structure and any additional sub actions which should also be included

func (*Action) Execute 

func (act *Action) Execute(sessionState *session.State, connectionSettings *connection.ConnectionSettings) error

Execute scenario action

func (*Action) IsContainerAction added in v0.5.7 

func (act *Action) IsContainerAction() bool

IsContainerAction returns true if action settings implements ContainerAction interface

func (*Action) UnmarshalJSON 

func (act *Action) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal action

func (*Action) Validate 

func (act *Action) Validate() error

Validate scenario action

type ActionCore 

type ActionCore struct {
	Type     string `json:"action" doc-key:"config.scenario.action"`
	Label    string `json:"label" doc-key:"config.scenario.label"`
	Disabled bool   `json:"disabled" doc-key:"config.scenario.disabled"`
}

type ActionSettings 

type ActionSettings interface {
	// Execute action
	Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())
	// Validate action
	Validate() error
}

ActionSettings scenario action interface for mandatory methods

type ActionType 

type ActionType int

ActionType type of action 

const (
	// ThinkTime wait for a random duration
	ThinkTime ActionType = iota
	// SheetObjectSelection selecting in a random object on the current sheet
	SheetObjectSelection
	// ChangeSheet changing to a random sheet
	ChangeSheet
	// ClearAll clearing all selections
	ClearAll
)

func (ActionType) GetEnumMap 

func (value ActionType) GetEnumMap() *enummap.EnumMap

func (ActionType) MarshalJSON 

func (value ActionType) MarshalJSON() ([]byte, error)

MarshalJSON marshal ActionType

func (ActionType) String added in v0.5.7 

func (value ActionType) String() string

func (*ActionType) UnmarshalJSON 

func (value *ActionType) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal ActionType

type ActionTypeSettings 

type ActionTypeSettings struct {
	// Type of action
	Type ActionType `json:"type" doc-key:"randomaction.actions.type"`
	// Uniform likelihood for action (weight)
	Weight int `json:"weight" doc-key:"randomaction.actions.weight"`
	// Overrides override arbitrary properties of the settings corresponding to this action
	Overrides map[string]interface{} `json:"overrides,omitempty" doc-key:"randomaction.actions.overrides"`
	// contains filtered or unexported fields
}

ActionTypeSettings settings for specific ActionType

type AffectsAppObjectsAction added in v0.5.2 

type AffectsAppObjectsAction interface {
	AffectsAppObjectsAction(appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)
}

AffectsAppObjectsAction is an interface that should be implemented by all actions that affect the availability of selectable objects for app structure consumption. App structure of the current app is passed as an argument. The return is * added *config.AppStructurePopulatedObjects - objects to be added to the selectable list by this action * removed []string - ids of objects that are removed (including any children) by this action * clearObjects bool - clears all objects except bookmarks and sheets

type AppStructureAction added in v0.5.2 

type AppStructureAction interface {
	AppStructureAction() (*AppStructureInfo, []Action)
}

AppStructureAction returns if this action should be included when doing an "get app structure" from script, IsAppAction tells the scenario to insert a "getappstructure" action after that action using data from sessionState.CurrentApp. A list of Sub action to be evaluated can also be included

type AppStructureInfo added in v0.5.2 

type AppStructureInfo struct {
	IsAppAction bool
	Include     bool
}

AppStructureActionContainer

type ApplyBookmarkSettings 

type ApplyBookmarkSettings struct {
	BookMarkSettings
}

ApplyBookmarkSettings apply bookmark settings

func (ApplyBookmarkSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings ApplyBookmarkSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (ApplyBookmarkSettings) Execute 

func (settings ApplyBookmarkSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute ApplyBookmarkSettings action (Implements ActionSettings interface)

func (ApplyBookmarkSettings) Validate 

func (settings ApplyBookmarkSettings) Validate() error

Validate ApplyBookmarkSettings action (Implements ActionSettings interface)

type BookMarkSettings added in v0.5.0 

type BookMarkSettings struct {
	Title session.SyncedTemplate `json:"title" displayname:"Bookmark title" doc-key:"bookmark.title"`
	ID    string                 `json:"id" displayname:"Bookmark ID" doc-key:"bookmark.id" appstructure:"active:bookmark"`
}

type BookmarkDeletionModeEnum 

type BookmarkDeletionModeEnum int

BookmarkDeletionModeEnum defines what bookmarks to remove 

const (
	// SingleBookmark delete specified bookmark
	SingleBookmark BookmarkDeletionModeEnum = iota
	// MatchingBookmarks delete all bookmarks in app
	MatchingBookmarks
	// AllBookmarks delete all bookmarks in app
	AllBookmarks
)

func (BookmarkDeletionModeEnum) GetEnumMap 

func (value BookmarkDeletionModeEnum) GetEnumMap() *enummap.EnumMap

func (BookmarkDeletionModeEnum) MarshalJSON 

func (value BookmarkDeletionModeEnum) MarshalJSON() ([]byte, error)

MarshalJSON marshal BookmarkDeletionModeEnum type

func (*BookmarkDeletionModeEnum) UnmarshalJSON 

func (value *BookmarkDeletionModeEnum) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal BookmarkDeletionModeEnum

type CanAddToCollection 

type CanAddToCollection struct {
	Title      session.SyncedTemplate `json:"title" displayname:"Title" doc-key:"elasticuploadapp.title"`
	Stream     session.SyncedTemplate `json:"stream" displayname:"Stream name" doc-key:"elasticuploadapp.stream"`
	StreamGUID string                 `json:"streamguid" displayname:"Stream ID" doc-key:"elasticuploadapp.streamguid"`
}

type ChangeSheetSettings 

type ChangeSheetSettings struct {
	ID string `json:"id" displayname:"Sheet ID" doc-key:"changesheet.id" appstructure:"active:sheet"`
}

ChangeSheetSettings settings for change sheet action

func (ChangeSheetSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings ChangeSheetSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (ChangeSheetSettings) Execute 

func (settings ChangeSheetSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute change sheet action

func (ChangeSheetSettings) Validate 

func (settings ChangeSheetSettings) Validate() error

Validate change sheet action

type ClearAllSettings 

type ClearAllSettings struct{}

ClearAllSettings clear all selections action

func (ClearAllSettings) Execute 

func (settings ClearAllSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute ClearAll action (Implements ActionSettings interface)

func (ClearAllSettings) Validate 

func (settings ClearAllSettings) Validate() error

Validate ClearAll action (Implements ActionSettings interface)

type ClickActionButtonSettings added in v0.5.8 

type ClickActionButtonSettings struct {
	// ID object id
	ID string `json:"id" appstructure:"active:action-button" displayname:"Button ID" doc-key:"clickactionbutton.id"`
}

ClickActionButtonSettings implements the ActionSettings and ContainerAction interfaces. Executing this action replicates the behaviour of clicking an "action-button" in Sense.

func (ClickActionButtonSettings) Execute added in v0.5.8 

func (settings ClickActionButtonSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute button-actions contained by sense action-button

func (ClickActionButtonSettings) IsContainerAction added in v0.5.8 

func (settings ClickActionButtonSettings) IsContainerAction()

IsContainerAction implements ContainerAction interface and sets container action logging to original action entry

func (ClickActionButtonSettings) Validate added in v0.5.8 

func (settings ClickActionButtonSettings) Validate() error

Validate filter pane select action

type ContainerAction 

type ContainerAction interface {
	IsContainerAction()
}

ContainerAction Implement this interface on action settings to mark an action as a container action containing other actions. A container action will not log result as a normal action, instead result will be logged as level=info, infotype: containeractionend Returns if action is to be considered a container action. ContainerAction can't be used in conjunction with StartActionOverrider interface

type CreateBookmarkSettings 

type CreateBookmarkSettings struct {
	BookMarkSettings
	Description     string `json:"description" displayname:"Bookmark description" doc-key:"createbookmark.description"`
	NoSheetLocation bool   `json:"nosheet" displayname:"Exclude sheet location" doc-key:"createbookmark.nosheet"`
	SaveLayout      bool   `json:"savelayout" displayname:"Save layout" doc-key:"createbookmark.savelayout"`
}

CreateBookmarkSettings create bookmark settings

func (CreateBookmarkSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings CreateBookmarkSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (CreateBookmarkSettings) Execute 

func (settings CreateBookmarkSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute CreateBookmarkSettings action (Implements ActionSettings interface)

func (CreateBookmarkSettings) Validate 

func (settings CreateBookmarkSettings) Validate() error

Validate CreateBookmarkSettings action (Implements ActionSettings interface)

type CreateSheetSettings 

type CreateSheetSettings struct {
	ID          string `json:"id" displayname:"Sheet ID" doc-key:"createsheet.id"`
	Title       string `json:"title" displayname:"Sheet title" doc-key:"createsheet.title"`
	Description string `json:"description" displayname:"Sheet description" doc-key:"createsheet.description"`
}

CreateSheetSettings settings for creating a sheet

func (CreateSheetSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings CreateSheetSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (CreateSheetSettings) Execute 

func (settings CreateSheetSettings) Execute(sessionState *session.State,
	actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute implements ActionSettings interface

func (CreateSheetSettings) Validate 

func (settings CreateSheetSettings) Validate() error

Validate implements ActionSettings interface

type DeleteBookmarkSettings 

type DeleteBookmarkSettings struct {
	BookMarkSettings
	DeletionMode BookmarkDeletionModeEnum `json:"mode" displayname:"Deletion mode" doc-key:"deletebookmark.mode"`
}

DeleteBookmarkSettings create bookmark settings

func (DeleteBookmarkSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings DeleteBookmarkSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (DeleteBookmarkSettings) Execute 

func (settings DeleteBookmarkSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute DeleteBookmarkSettings action (Implements ActionSettings interface)

func (DeleteBookmarkSettings) Validate 

func (settings DeleteBookmarkSettings) Validate() error

Validate DeleteBookmarkSettings action (Implements ActionSettings interface)

type DeleteDataSettings 

type DeleteDataSettings struct {
	Filename string `json:"filename" displayname:"Filename" doc-key:"deletedata.filename"`
	Path     string `json:"path" displayname:"Path" doc-key:"deletedata.path"`
}

DeleteDataSettings specify data file to delete

func (DeleteDataSettings) Execute 

func (settings DeleteDataSettings) Execute(
	sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string,
	reset func(),
)

Execute action (Implements ActionSettings interface)

func (DeleteDataSettings) Validate 

func (settings DeleteDataSettings) Validate() error

Validate action (Implements ActionSettings interface)

type DeleteOdagSettings 

type DeleteOdagSettings struct {
	Name session.SyncedTemplate `json:"linkname" displayname:"ODAG link name" doc-key:"deleteodag.linkname"`
}

DeleteOdagSettings settings for DeleteOdag

func (DeleteOdagSettings) Execute 

func (settings DeleteOdagSettings) Execute(sessionState *session.State, actionState *action.State,
	connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute DeleteOdagSettings action (Implements ActionSettings interface)

func (DeleteOdagSettings) Validate 

func (settings DeleteOdagSettings) Validate() error

Validate DeleteOdagSettings action (Implements ActionSettings interface)

type DeleteSheetSettings 

type DeleteSheetSettings struct {
	DeletionMode SheetDeletionModeEnum `json:"mode" displayname:"Deletion mode" doc-key:"deletesheet.mode"`
	Title        string                `json:"title" displayname:"Sheet title" doc-key:"deletesheet.title"`
	ID           string                `json:"id" displayname:"Sheet ID" doc-key:"deletesheet.id" appstructure:"active:sheet"`
}

DeleteBookmarkSettings create bookmark settings

func (DeleteSheetSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings DeleteSheetSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (DeleteSheetSettings) Execute 

func (settings DeleteSheetSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute DeleteSheetSettings action (Implements ActionSettings interface)

func (DeleteSheetSettings) Validate 

func (settings DeleteSheetSettings) Validate() error

Validate DeleteSheetSettings action (Implements ActionSettings interface)

type DeletionModeEnum 

type DeletionModeEnum int

DeletionModeEnum defines what apps to remove 

const (
	// Single delete context app
	Single DeletionModeEnum = iota
	// Everything delete every visible app
	Everything
	// ClearCollection delete all contents of a given collection
	ClearCollection
)

func (DeletionModeEnum) GetEnumMap 

func (value DeletionModeEnum) GetEnumMap() *enummap.EnumMap

func (DeletionModeEnum) MarshalJSON 

func (value DeletionModeEnum) MarshalJSON() ([]byte, error)

MarshalJSON marshal DeletionModeEnum type

func (*DeletionModeEnum) UnmarshalJSON 

func (value *DeletionModeEnum) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal DeletionModeEnum

type DestinationSpace added in v0.5.0 

type DestinationSpace struct {
	// DestinationSpaceId ID for destination space
	DestinationSpaceId string `json:"destinationspaceid" displayname:"Destination space ID" doc-key:"destinationspace.destinationspaceid"`
	// DestinationSpaceName name for destination space
	DestinationSpaceName string `json:"destinationspacename" displayname:"Destination space name" doc-key:"destinationspace.destinationspacename"`
}

func (DestinationSpace) ResolveDestinationSpace added in v0.5.0 

func (settings DestinationSpace) ResolveDestinationSpace(sessionState *session.State, actionState *action.State, host string) (*elasticstructs.Space, error)

type DisconnectAppSettings 

type DisconnectAppSettings struct{}

DisconnectAppSettings

func (DisconnectAppSettings) Execute 

func (settings DisconnectAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute

func (DisconnectAppSettings) Validate 

func (settings DisconnectAppSettings) Validate() error

Validate

type DuplicateSheetSettings 

type DuplicateSheetSettings struct {
	// ID of object to clone
	ID string `json:"id" displayname:"Sheet ID" doc-key:"duplicatesheet.id" appstructure:"active:sheet"`
	// ChangeSheet after cloning
	ChangeSheet bool `json:"changesheet" displayname:"Change to sheet after creation" doc-key:"duplicatesheet.changesheet"`
	// Save object changes after clone
	Save bool `json:"save" displayname:"Save sheet" doc-key:"duplicatesheet.save"`
	// CloneID
	CloneID string `json:"cloneid" displayname:"Cloned sheet ID" doc-key:"duplicatesheet.cloneid"`
}

DuplicateSheetSettings clone object settings

func (DuplicateSheetSettings) AffectsAppObjectsAction added in v0.5.2 

func (settings DuplicateSheetSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (DuplicateSheetSettings) Execute 

func (settings DuplicateSheetSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute clone object

func (DuplicateSheetSettings) Validate 

func (settings DuplicateSheetSettings) Validate() error

Validate clone object settings

type ElasticCreateAppSettings 

type ElasticCreateAppSettings struct {
	CanAddToCollection
}

ElasticCreateAppSettings specify app to create

func (ElasticCreateAppSettings) Execute 

func (settings ElasticCreateAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute action (Implements ActionSettings interface)

func (ElasticCreateAppSettings) Validate 

func (settings ElasticCreateAppSettings) Validate() error

Validate action (Implements ActionSettings interface)

type ElasticCreateCollectionSettings 

type ElasticCreateCollectionSettings struct {
	Name        session.SyncedTemplate `json:"name" displayname:"Collection name" doc-key:"elasticcreatecollection.name"`
	Description string                 `json:"description" displayname:"Collection description" doc-key:"elasticcreatecollection.description"`
	Private     bool                   `json:"private" displayname:"Private collection" doc-key:"elasticcreatecollection.private"`
}

ElasticCreateCollectionSettings settings for new collection

func (ElasticCreateCollectionSettings) Execute 

func (settings ElasticCreateCollectionSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute ElasticCreateCollectionSettings action (Implements ActionSettings interface)

func (ElasticCreateCollectionSettings) Validate 

func (settings ElasticCreateCollectionSettings) Validate() error

Validate ElasticCreateCollectionSettings action (Implements ActionSettings interface)

type ElasticDeleteAppCoreSettings 

type ElasticDeleteAppCoreSettings struct {
	DeletionMode   DeletionModeEnum `json:"mode" displayname:"Deletion mode" doc-key:"elasticdeleteapp.mode"`
	CollectionName string           `json:"collectionname" displayname:"Collection name" doc-key:"elasticdeleteapp.collectionname"`
}

ElasticDeleteAppCoreSettings

type ElasticDeleteAppSettings 

type ElasticDeleteAppSettings struct {
	session.AppSelection
	ElasticDeleteAppCoreSettings
}

ElasticDeleteAppSettings specify app to delete

func (ElasticDeleteAppSettings) Execute 

func (settings ElasticDeleteAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute EfeDeleteApp action (Implements ActionSettings interface)

func (*ElasticDeleteAppSettings) UnmarshalJSON 

func (settings *ElasticDeleteAppSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals delete app settings from JSON

func (ElasticDeleteAppSettings) Validate 

func (settings ElasticDeleteAppSettings) Validate() error

Validate EfeDeleteApp action (Implements ActionSettings interface)

type ElasticDeleteCollectionSettings 

type ElasticDeleteCollectionSettings struct {
	CollectionName string `json:"name" displayname:"Collection name" doc-key:"elasticdeletecollection.name"`
	DeleteContents bool   `json:"deletecontents" displayname:"Delete collection contents" doc-key:"elasticdeletecollection.deletecontents"`
}

func (ElasticDeleteCollectionSettings) Execute 

func (settings ElasticDeleteCollectionSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, setEfeDeleteCollectionStart func())

Execute ElasticDeleteCollectionSettings action (Implements ActionSettings interface)

func (ElasticDeleteCollectionSettings) Validate 

func (settings ElasticDeleteCollectionSettings) Validate() error

Validate ElasticDeleteCollectionSettings action (Implements ActionSettings interface)

type ElasticDeleteOdagSettings 

type ElasticDeleteOdagSettings struct {
	DeleteOdagSettings
}

ElasticDeleteOdagSettings settings for ElasticDeleteOdag

func (ElasticDeleteOdagSettings) Execute 

func (settings ElasticDeleteOdagSettings) Execute(sessionState *session.State, actionState *action.State,
	connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute ElasticDeleteOdagSettings action (Implements ActionSettings interface)

func (ElasticDeleteOdagSettings) Validate 

func (settings ElasticDeleteOdagSettings) Validate() error

Validate ElasticDeleteOdagSettings action (Implements ActionSettings interface)

type ElasticDuplicateAppSettings 

type ElasticDuplicateAppSettings struct {
	session.AppSelection
	CanAddToCollection
	ElasticDuplicateAppSettingsCore
}

ElasticUploadAppSettings specify app to upload

func (ElasticDuplicateAppSettings) Execute 

func (settings ElasticDuplicateAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute action (Implements ActionSettings interface)

func (*ElasticDuplicateAppSettings) UnmarshalJSON 

func (settings *ElasticDuplicateAppSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals duplicate app settings from JSON

func (ElasticDuplicateAppSettings) Validate 

func (settings ElasticDuplicateAppSettings) Validate() error

Validate action (Implements ActionSettings interface)

type ElasticDuplicateAppSettingsCore 

type ElasticDuplicateAppSettingsCore struct {
	SpaceID string `json:"spaceid" displayname:"Space ID" doc-key:"elasticduplicateapp.spaceid"`
}

ElasticDuplicateAppSettingsCore Currently used ElasticDuplicateAppSettingsCore (as opposed to deprecated settings)

type ElasticExploreSettings 

type ElasticExploreSettings struct {
	// KeepCurrent keep current artifact map and fill with results from explore action
	KeepCurrent bool `json:"keepcurrent" displayname:"Keep current" doc-key:"elasticexplore.keepcurrent"`
	// DoPaging page through all items
	DoPaging bool `json:"paging" displayname:"Do paging" doc-key:"elasticexplore.paging"`
	// Sorting SortingMode of items, defaults to SortingModeDefault
	Sorting SortingMode `json:"sorting" displayname:"Sorting mode" doc-key:"elasticexplore.sorting"`
	// Owner OwnerMode, defaults to OwnerModeAll
	Owner OwnerMode `json:"owner" displayname:"Owner mode" doc-key:"elasticexplore.owner"`
	// SpaceName only get items which members of this space, cannot be used together with SpaceID
	SpaceName session.SyncedTemplate `json:"space" displayname:"Space name" doc-key:"elasticexplore.space"`
	// SpaceId only get items which members of this space, cannot be used together with SpaceName
	SpaceId string `json:"spaceid" displayname:"Space ID" doc-key:"elasticexplore.spaceid"`
	// CollectionIds filter on these tag (collection) ids
	CollectionIds []string `json:"tagids" displayname:"Tag IDs" doc-key:"elasticexplore.tagids"`
	// CollectionNames filter on these tag (collection) names
	CollectionNames []string `json:"tags" displayname:"Tag names" doc-key:"elasticexplore.tags"`
}

ElasticExploreSettings fills artifact map with apps to be used in simulation

func (ElasticExploreSettings) AppStructureAction added in v0.5.2 

func (settings ElasticExploreSettings) AppStructureAction() (*AppStructureInfo, []Action)

AppStructureAction implements AppStructureAction interface

func (ElasticExploreSettings) Execute 

func (settings ElasticExploreSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute ElasticExplore action

func (ElasticExploreSettings) Validate 

func (settings ElasticExploreSettings) Validate() error

Validate ElasticExplore action

type ElasticExportAppSettings 

type ElasticExportAppSettings struct {
	session.AppSelection
	ElasticExportAppSettingsCore
}

ElasticExportAppSettings

func (ElasticExportAppSettings) Execute 

func (settings ElasticExportAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute ElasticExportApp

func (*ElasticExportAppSettings) UnmarshalJSON 

func (settings *ElasticExportAppSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals export app settings from JSON

func (ElasticExportAppSettings) Validate 

func (settings ElasticExportAppSettings) Validate() error

Validate ElasticExportApp

type ElasticExportAppSettingsCore 

type ElasticExportAppSettingsCore struct {
	NoData     bool                   `json:"nodata" displayname:"Export without data" doc-key:"elasticexportapp.nodata"`
	FileName   session.SyncedTemplate `json:"exportname" displayname:"Export filename" displayelement:"savefile" doc-key:"elasticexportapp.filename"`
	SaveToFile bool                   `json:"savetofile" displayname:"Save to file" doc-key:"elasticexportapp.savetofile"`
}

ElasticExportAppSettingsCore Currently used ElasticExportAppSettings (as opposed to deprecated settings)

type ElasticGenerateOdagSettings 

type ElasticGenerateOdagSettings struct {
	GenerateOdagSettings
}

GenerateOdagSettings settings for GenerateOdag

func (ElasticGenerateOdagSettings) Execute 

func (settings ElasticGenerateOdagSettings) Execute(sessionState *session.State, actionState *action.State,
	connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute ElasticGenerateOdagSettings action (Implements ActionSettings interface)

func (ElasticGenerateOdagSettings) Validate 

func (settings ElasticGenerateOdagSettings) Validate() error

Validate ElasticGenerateOdagSettings action (Implements ActionSettings interface)

type ElasticHubSearchSettings 

type ElasticHubSearchSettings struct {
	ElasticHubSearchSettingsCore
	// contains filtered or unexported fields
}

ElasticHubSearchSettings settings for search

func (ElasticHubSearchSettings) Execute 

func (settings ElasticHubSearchSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute EfeHubSearch action (Implements ActionSettings interface)

func (*ElasticHubSearchSettings) UnmarshalJSON 

func (settings *ElasticHubSearchSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal ElasticHubSearchSettings settings

func (ElasticHubSearchSettings) Validate 

func (settings ElasticHubSearchSettings) Validate() error

Validate EfeHubSearch action (Implements ActionSettings interface)

type ElasticHubSearchSettingsCore 

type ElasticHubSearchSettingsCore struct {
	SearchMode  SearchModeEnum  `json:"searchfor" displayname:"Search for" doc-key:"elastichubsearch.searchfor"`
	QuerySource QuerySourceEnum `json:"querysource" displayname:"Query source" doc-key:"elastichubsearch.querysource"`
	Query       string          `json:"query" displayname:"Query" doc-key:"elastichubsearch.query"`
	Filename    string          `json:"queryfile" displayname:"Query file" displayelement:"file" doc-key:"elastichubsearch.queryfile"`
}

ElasticHubSearchSettingsCore specify app to reload

type ElasticMoveAppSettings added in v0.5.0 

type ElasticMoveAppSettings struct {
	session.AppSelection
	DestinationSpace
}

ElasticMoveAppSettings settings for moving an app between spaces

func (ElasticMoveAppSettings) Execute added in v0.5.0 

func (settings ElasticMoveAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute action (Implements ActionSettings interface)

func (*ElasticMoveAppSettings) UnmarshalJSON added in v0.5.0 

func (settings *ElasticMoveAppSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals ElasticMoveAppSettings from JSON

func (ElasticMoveAppSettings) Validate added in v0.5.0 

func (settings ElasticMoveAppSettings) Validate() error

Validate action (Implements ActionSettings interface)

type ElasticOpenHubSettings 

type ElasticOpenHubSettings struct{}

func (ElasticOpenHubSettings) AppStructureAction added in v0.5.2 

func (openHub ElasticOpenHubSettings) AppStructureAction() (*AppStructureInfo, []Action)

AppStructureAction implements AppStructureAction interface

func (ElasticOpenHubSettings) Execute 

func (openHub ElasticOpenHubSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute open Efe hub

func (*ElasticOpenHubSettings) UnmarshalJSON 

func (openHub *ElasticOpenHubSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal ElasticOpenHubSettings

func (ElasticOpenHubSettings) Validate 

func (openHub ElasticOpenHubSettings) Validate() (err error)

Validate open Efe hub settings

type ElasticPublishAppSettings added in v0.5.0 

type ElasticPublishAppSettings struct {
	session.AppSelection
	DestinationSpace
	ElasticPublishAppSettingsCore
}

ElasticPublishAppSettings settings for moving an app between spaces

func (ElasticPublishAppSettings) Execute added in v0.5.0 

func (settings ElasticPublishAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute action (Implements ActionSettings interface)

func (*ElasticPublishAppSettings) UnmarshalJSON added in v0.5.0 

func (settings *ElasticPublishAppSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals ElasticMoveAppSettings from JSON

func (ElasticPublishAppSettings) Validate added in v0.5.0 

func (settings ElasticPublishAppSettings) Validate() error

Validate action (Implements ActionSettings interface)

type ElasticPublishAppSettingsCore added in v0.5.0 

type ElasticPublishAppSettingsCore struct {
	ClearTags bool `json:"cleartags" displayname:"Clear existing tags" doc-key:"elasticpublishapp.cleartags"`
}

type ElasticReloadCore 

type ElasticReloadCore struct {
	// PollInterval time in-between polling for reload status
	PollInterval helpers.TimeDuration `json:"pollinterval" displayname:"Poll interval" doc-key:"elasticreload.pollinterval"`
	SaveLog      bool                 `json:"log" displayname:"Save log" doc-key:"elasticreload.log"`
}

ElasticReloadCore Currently used ElasticReloadCore (as opposed to deprecated settings)

type ElasticReloadSettings 

type ElasticReloadSettings struct {
	session.AppSelection
	ElasticReloadCore
}

ElasticReloadSettings specify app to reload

func (ElasticReloadSettings) Execute 

func (settings ElasticReloadSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute EfeReload action (Implements ActionSettings interface)

func (*ElasticReloadSettings) UnmarshalJSON 

func (settings *ElasticReloadSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals reload settings from JSON

func (ElasticReloadSettings) Validate 

func (settings ElasticReloadSettings) Validate() error

Validate EfeReload action (Implements ActionSettings interface)

type ElasticShareAppSettings 

type ElasticShareAppSettings struct {
	Title   session.SyncedTemplate `json:"title" displayname:"App title" doc-key:"elasticshareapp.title"`
	AppGUID string                 `json:"appguid" displayname:"App GUID" doc-key:"elasticshareapp.appguid"`
	Groups  []string               `json:"groups" displayname:"Groups" doc-key:"elasticshareapp.groups"`
}

ElasticShareAppSettings

func (ElasticShareAppSettings) Execute 

func (settings ElasticShareAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute ElasticShareAppSettings

func (ElasticShareAppSettings) Validate 

func (settings ElasticShareAppSettings) Validate() error

Validate ElasticShareAppSettings

type ElasticUploadAppSettings 

type ElasticUploadAppSettings struct {
	ChunkSize  int64      `json:"chunksize" displayname:"Chunk size (bytes)" doc-key:"elasticuploadapp.chunksize"`
	MaxRetries int        `json:"retries" displayname:"Number of retries on failed chunk upload" doc-key:"elasticuploadapp.retries"`
	Mode       UploadMode `json:"mode" displayname:"Upload mode" doc-key:"elasticuploadapp.mode"`
	Filename   string     `json:"filename" displayname:"Filename" displayelement:"file" doc-key:"elasticuploadapp.filename"`
	// Deprecated: This property will be removed. DestinationSpace should be used instead, keeping entry here for some time to make sure scripts get validation error
	SpaceID string `json:"spaceid" displayname:"Space ID" doc-key:"elasticuploadapp.spaceid"`
	DestinationSpace
	CanAddToCollection
}

ElasticUploadAppSettings specify app to upload

func (ElasticUploadAppSettings) Execute 

func (settings ElasticUploadAppSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute action (Implements ActionSettings interface)

func (ElasticUploadAppSettings) Validate 

func (settings ElasticUploadAppSettings) Validate() error

Validate action (Implements ActionSettings interface)

type Enum 

type Enum interface {
	GetEnumMap() *enummap.EnumMap
}

Enum interface should be implemented on types used fields of action struct if: 1. Type is derived from one integer type. Example: `type MyType int` 2. Type has natural string representations for its values. Typically you should consider implementing Enum when declaring global constants of a user defined integer type.

type GenerateOdagSettings 

type GenerateOdagSettings struct {
	Name session.SyncedTemplate `json:"linkname" displayname:"ODAG link name" doc-key:"generateodag.linkname"`
}

GenerateOdagSettings settings for GenerateOdag

func (GenerateOdagSettings) Execute 

func (settings GenerateOdagSettings) Execute(sessionState *session.State, actionState *action.State,
	connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute ElasticDeleteCollectionSettings action (Implements ActionSettings interface)

func (GenerateOdagSettings) Validate 

func (settings GenerateOdagSettings) Validate() error

Validate GenerateOdagSettings action (Implements ActionSettings interface)

type IteratedSettings 

type IteratedSettings struct {
	Iterations int      `json:"iterations" displayname:"Iterations" doc-key:"iterated.iterations"`
	Actions    []Action `json:"actions" displayname:"Actions" doc-key:"iterated.actions"`
}

IteratedSettings parallel action settings

func (IteratedSettings) AppStructureAction added in v0.5.2 

func (action IteratedSettings) AppStructureAction() (*AppStructureInfo, []Action)

AppStructureAction implements AppStructureAction interface

func (IteratedSettings) Execute 

func (action IteratedSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute iterated actions

func (IteratedSettings) IsContainerAction 

func (action IteratedSettings) IsContainerAction()

IsContainerAction implements ContainerAction interface and sets container action logging to original action entry

func (IteratedSettings) Validate 

func (action IteratedSettings) Validate() error

Validate iterated actions

type ListBoxSelectSettings added in v0.5.7 

type ListBoxSelectSettings struct {
	// ID object id
	ID string `json:"id" appstructure:"active:listbox" displayname:"Listbox ID" doc-key:"listboxselect.id"`
	// Type selection type
	Type ListBoxSelectType `json:"type" displayname:"Selection type" doc-key:"listboxselect.type"`
	// Accept true - confirm selection. false - abort selection
	Accept bool `json:"accept" displayname:"Accept selection" doc-key:"listboxselect.accept"`
	// Wrap selection with Begin / End selection requests
	Wrap bool `json:"wrap" displayname:"Wrap selection" doc-key:"listboxselect.wrap"`
}

ListBoxSelectSettings selection settings

func (ListBoxSelectSettings) Execute added in v0.5.7 

func (settings ListBoxSelectSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute filter pane select action

func (ListBoxSelectSettings) Validate added in v0.5.7 

func (settings ListBoxSelectSettings) Validate() error

Validate filter pane select action

type ListBoxSelectType added in v0.5.7 

type ListBoxSelectType int

ListBoxSelectType type of selection 

const (
	// All select all
	All ListBoxSelectType = iota
	// Possible select possible
	Possible
	// Alternative select alternative
	Alternative
	// Excluded select excluded
	Excluded
)

func (ListBoxSelectType) GetEnumMap added in v0.5.7 

func (ListBoxSelectType) GetEnumMap() *enummap.EnumMap

func (ListBoxSelectType) MarshalJSON added in v0.5.7 

func (value ListBoxSelectType) MarshalJSON() ([]byte, error)

MarshalJSON marshal filter pane selection type

func (ListBoxSelectType) String added in v0.5.7 

func (value ListBoxSelectType) String() string

String representation of ListBoxSelectType

func (*ListBoxSelectType) UnmarshalJSON added in v0.5.7 

func (value *ListBoxSelectType) UnmarshalJSON(json []byte) error

UnmarshalJSON unmarshal filter pane selection type

type OdagEndpointConfiguration 

type OdagEndpointConfiguration struct {
	Main            string
	Requests        string
	EnabledEndpoint string
}

type OpenAppSettings 

type OpenAppSettings struct {
	session.AppSelection
}

OpenAppSettings app and server settings

func (OpenAppSettings) AffectsAppObjectsAction added in v0.5.2 

func (openApp OpenAppSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface

func (OpenAppSettings) AppStructureAction added in v0.5.2 

func (openApp OpenAppSettings) AppStructureAction() (*AppStructureInfo, []Action)

AppStructureAction implements AppStructureAction interface

func (OpenAppSettings) Execute 

func (openApp OpenAppSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, setOpenStart func())

Execute open app

func (OpenAppSettings) GetConnectWsAction 

func (openApp OpenAppSettings) GetConnectWsAction(wsLabel string, connectFunc func() (string, error)) Action

func (*OpenAppSettings) UnmarshalJSON 

func (openApp *OpenAppSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshals open app settings from JSON

func (OpenAppSettings) Validate 

func (openApp OpenAppSettings) Validate() error

Validate open app scenario item

type OpenHubSettings 

type OpenHubSettings struct{}

OpenHubSettings settings for OpenHub

func (OpenHubSettings) AppStructureAction added in v0.5.2 

func (openHub OpenHubSettings) AppStructureAction() (*AppStructureInfo, []Action)

AppStructureAction implements AppStructureAction interface

func (OpenHubSettings) Execute 

func (openHub OpenHubSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, setHubStart func())

Execute execute the action

func (OpenHubSettings) Validate 

func (openHub OpenHubSettings) Validate() error

Validate open app scenario item

type OwnerMode 

type OwnerMode int
const (
	OwnerModeAll OwnerMode = iota
	OwnerModeMe
	OwnerModeOthers
)

OwnerMode

func (OwnerMode) GetEnumMap 

func (owner OwnerMode) GetEnumMap() *enummap.EnumMap

GetEnumMap for owner mode

func (OwnerMode) MarshalJSON 

func (owner OwnerMode) MarshalJSON() ([]byte, error)

MarshalJSON marshal OwnerMode

func (*OwnerMode) UnmarshalJSON 

func (owner *OwnerMode) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal OwnerMode

type ProductVersionSettings 

type ProductVersionSettings struct {
	// Log product version to log file as InfoType ProductVersion
	Log bool `json:"log" displayname:"Log product version" doc-key:"productversion.log"`
}

ProductVersionSettings settings for ProductVersion action

func (ProductVersionSettings) Execute 

func (settings ProductVersionSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute ProductVersion action (Implements ActionSettings interface)

func (ProductVersionSettings) Validate 

func (settings ProductVersionSettings) Validate() error

Validate ProductVersion action (Implements ActionSettings interface)

type PublishBookmarkSettings added in v0.5.0 

type PublishBookmarkSettings struct {
	BookMarkSettings
}

func (PublishBookmarkSettings) Execute added in v0.5.0 

func (settings PublishBookmarkSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute CreateBookmarkSettings action (Implements ActionSettings interface)

func (PublishBookmarkSettings) Validate added in v0.5.0 

func (settings PublishBookmarkSettings) Validate() error

Validate PublishBookmarkSettings action (Implements ActionSettings interface)

type PublishSheetMode 

type PublishSheetMode int

PublishSheetMode specifies the mode for publishing the sheets 

const (
	// AllSheets publishes all of the sheets in the opened app
	AllSheets PublishSheetMode = iota
	// SheetIDs publishes sheets specified in the sheetIds array
	SheetIDs
)

func (PublishSheetMode) GetEnumMap 

func (value PublishSheetMode) GetEnumMap() *enummap.EnumMap

func (PublishSheetMode) MarshalJSON 

func (value PublishSheetMode) MarshalJSON() ([]byte, error)

MarshalJSON marshal PublishSheetMode type

func (*PublishSheetMode) UnmarshalJSON 

func (value *PublishSheetMode) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal PublishSheetMode

type PublishSheetSettings 

type PublishSheetSettings struct {
	Mode     PublishSheetMode `json:"mode" displayname:"Publish mode" doc-key:"publishsheet.mode"`
	SheetIDs []string         `json:"sheetIds" displayname:"Sheet IDs" doc-key:"publishsheet.sheetIds"`
}

PublishSheetSettings contains details for publishing sheet(s)

func (PublishSheetSettings) Execute 

func (publishSheetSettings PublishSheetSettings) Execute(sessionState *session.State,
	actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute performs the publish sheet action

func (PublishSheetSettings) Validate 

func (publishSheetSettings PublishSheetSettings) Validate() error

Validate checks the settings of the publish sheet action

type QuerySourceEnum 

type QuerySourceEnum int

QuerySourceEnum defines source of query 

const (
	// QueryString queries from string or file
	QueryString QuerySourceEnum = iota
	// FromFile queries read from file
	FromFile
)

func (QuerySourceEnum) GetEnumMap 

func (value QuerySourceEnum) GetEnumMap() *enummap.EnumMap

func (QuerySourceEnum) MarshalJSON 

func (value QuerySourceEnum) MarshalJSON() ([]byte, error)

MarshalJSON marshal SearchModeEnum type

func (*QuerySourceEnum) UnmarshalJSON 

func (value *QuerySourceEnum) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal QuerySourceEnum

type RandomActionSettings 

type RandomActionSettings struct {
	RandomActionSettingsCore
	// contains filtered or unexported fields
}

RandomActionSettings RandomAction settings

func (RandomActionSettings) Execute 

func (settings RandomActionSettings) Execute(sessionState *session.State, state *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute random action/-s. Implements ActionSetting interface

func (RandomActionSettings) IsContainerAction 

func (settings RandomActionSettings) IsContainerAction()

IsContainerAction implements ContainerAction interface and sets container action logging to original action entry

func (*RandomActionSettings) UnmarshalJSON 

func (settings *RandomActionSettings) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal ActionType

func (RandomActionSettings) Validate 

func (settings RandomActionSettings) Validate() error

Validate random action settings. Implements ActionSetting interface

type RandomActionSettingsCore 

type RandomActionSettingsCore struct {
	// List of the different actions and their weights
	ActionTypes []ActionTypeSettings `json:"actions" displayname:"Actions" doc-key:"randomaction.actions"`
	// ThinkTime in between random actions
	InterThinkTimeSettings *ThinkTimeSettings `json:"thinktimesettings,omitempty" doc-key:"randomaction.thinktimesettings"`
	// Number of random actions to execute
	Iterations int `json:"iterations" displayname:"Iterations" doc-key:"randomaction.iterations"`
}

RandomActionSettingsCore RandomAction settings

type ReloadModeEnum 

type ReloadModeEnum int

ReloadModeEnum determines error handling mode 

const (
	// 0: for default mode.
	DefaultReloadMode ReloadModeEnum = iota
	// 1: for ABEND; the reload of the script ends if an error occurs.
	Abend
	// 2: for ignore; the reload of the script continues even if an error is detected in the script.
	Ignore
)

func (ReloadModeEnum) GetEnumMap 

func (value ReloadModeEnum) GetEnumMap() *enummap.EnumMap

func (ReloadModeEnum) MarshalJSON 

func (value ReloadModeEnum) MarshalJSON() ([]byte, error)

MarshalJSON marshal ReloadModeEnum type

func (*ReloadModeEnum) UnmarshalJSON 

func (value *ReloadModeEnum) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal ReloadModeEnum

type ReloadSettings 

type ReloadSettings struct {
	ReloadMode ReloadModeEnum `json:"mode" displayname:"Reload mode" doc-key:"reload.mode"`
	Partial    bool           `json:"partial" displayname:"Partial reload" doc-key:"reload.partial"`
	SaveLog    bool           `json:"log" displayname:"Save log" doc-key:"reload.log"`
}

ReloadSettings loop through sheets in an app

func (ReloadSettings) Execute 

func (settings ReloadSettings) Execute(sessionState *session.State,
	actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute implements ActionSettings interface

func (ReloadSettings) Validate 

func (settings ReloadSettings) Validate() error

Validate implements ActionSettings interface

type SearchModeEnum 

type SearchModeEnum int

SearchModeEnum defines what to search for 

const (
	// Collections search collections
	Collections SearchModeEnum = iota
	// Apps search apps
	Apps
	// Both search both collections and apps
	Both
)

func (SearchModeEnum) GetEnumMap 

func (value SearchModeEnum) GetEnumMap() *enummap.EnumMap

func (SearchModeEnum) MarshalJSON 

func (value SearchModeEnum) MarshalJSON() ([]byte, error)

MarshalJSON marshal SearchModeEnum type

func (*SearchModeEnum) UnmarshalJSON 

func (value *SearchModeEnum) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal SearchModeEnum

type SelectionSettings 

type SelectionSettings struct {
	// ID object id
	ID string `json:"id" displayname:"Object ID" doc-key:"select.id" appstructure:"active:!sheet"`
	// Type selection type
	Type SelectionType `json:"type" displayname:"Selection type" doc-key:"select.type"`
	// Accept true - confirm selection. false - abort selection
	Accept bool `json:"accept" displayname:"Accept selection" doc-key:"select.accept"`
	// WrapSelections
	WrapSelections bool `json:"wrap" displayname:"Wrap selections" doc-key:"select.wrap"`
	// Min minimum amount of values to select
	Min int `json:"min" displayname:"Minimum amount of values to select" doc-key:"select.min"`
	// Max maximum amount of values to select
	Max int `json:"max" displayname:"Maximum amount of values to select" doc-key:"select.max"`
	// Dimension in which dimension to select (defaults to 0)
	Dimension int `json:"dim" displayname:"Dimension to select in" doc-key:"select.dim"`
}

SelectionSettings selection settings

func (SelectionSettings) Execute 

func (settings SelectionSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute select action

func (SelectionSettings) Validate 

func (settings SelectionSettings) Validate() error

Validate select action

type SelectionType 

type SelectionType int

SelectionType type of selection 

const (
	// RandomFromAll random from all values
	RandomFromAll SelectionType = iota
	// RandomFromEnabled random from white values
	RandomFromEnabled
	// RandomFromExcluded random from grey values
	RandomFromExcluded
	// RandomDeselect random deselect from selected values
	RandomDeselect
)

func (SelectionType) GetEnumMap 

func (value SelectionType) GetEnumMap() *enummap.EnumMap

func (SelectionType) IsExcludedOrDeselect 

func (value SelectionType) IsExcludedOrDeselect() bool

IsExcludedOrDeselect true if type is RandomDeselect or RandomFromExcluded

func (SelectionType) MarshalJSON 

func (value SelectionType) MarshalJSON() ([]byte, error)

MarshalJSON marshal selection type

func (SelectionType) String 

func (value SelectionType) String() string

String representation of StaticSelectionType

func (*SelectionType) UnmarshalJSON 

func (value *SelectionType) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal selection type

type SetScriptSettings 

type SetScriptSettings struct {
	Script string `json:"script" displayname:"Script" displayelement:"textarea" doc-key:"setscript.script"`
}

SetScriptSettings set script

func (SetScriptSettings) Execute 

func (settings SetScriptSettings) Execute(sessionState *session.State,
	actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute implements ActionSettings interface

func (SetScriptSettings) Validate 

func (settings SetScriptSettings) Validate() error

Validate implements ActionSettings interface

type SheetChangerSettings 

type SheetChangerSettings struct {
	// contains filtered or unexported fields
}

SheetChangerSettings loop through sheets in an app

func (SheetChangerSettings) Execute 

func (settings SheetChangerSettings) Execute(sessionState *session.State,
	actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute implements ActionSettings interface

func (SheetChangerSettings) IsContainerAction 

func (settings SheetChangerSettings) IsContainerAction()

IsContainerAction implements ContainerAction interface and sets container action logging to original action entry

func (SheetChangerSettings) Validate 

func (settings SheetChangerSettings) Validate() error

Validate implements ActionSettings interface

type SheetDeletionModeEnum 

type SheetDeletionModeEnum int

BookmarkDeletionModeEnum defines what bookmarks to remove 

const (
	// SingleSheet delete specified sheet
	SingleSheet SheetDeletionModeEnum = iota
	// MatchingSheets delete sheets matching name
	MatchingSheets
	// AllUnpublished delete all unpublished sheets in app
	AllUnpublished
)

func (SheetDeletionModeEnum) GetEnumMap 

func (value SheetDeletionModeEnum) GetEnumMap() *enummap.EnumMap

func (SheetDeletionModeEnum) MarshalJSON 

func (value SheetDeletionModeEnum) MarshalJSON() ([]byte, error)

MarshalJSON marshal SheetDeletionModeEnum type

func (*SheetDeletionModeEnum) UnmarshalJSON 

func (value *SheetDeletionModeEnum) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal SheetDeletionModeEnum

type SortingMode 

type SortingMode int
const (
	// SortingModeDefault default sorting mode, should be changed if client changes its default
	SortingModeDefault   SortingMode = iota //-createdAt
	SortingModeUpdatedAt                    //-updatedAt
	SortingModeCreatedAt                    //-createdAt
	SortingModeName                         //-name
)

SortingMode

func (SortingMode) GetEnumMap 

func (sorting SortingMode) GetEnumMap() *enummap.EnumMap

GetEnumMap for sorting mode

func (SortingMode) MarshalJSON 

func (sorting SortingMode) MarshalJSON() ([]byte, error)

MarshalJSON marshal SortingMode

func (*SortingMode) UnmarshalJSON 

func (sorting *SortingMode) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal SortingMode

func (SortingMode) Value 

func (sorting SortingMode) Value() string

Value of SortingMode for URL parameters

type StaticSelectSettings 

type StaticSelectSettings struct {
	//ID object id
	ID string `json:"id" displayname:"Object ID" doc-key:"staticselect.id" appstructure:"active:!sheet"`
	//Path object selection path
	Path string `json:"path" displayname:"Object selection path" doc-key:"staticselect.path"`
	//Rows to select
	Rows []int `json:"rows" displayname:"Rows to select" doc-key:"staticselect.rows"`
	//Cols columns to select
	Cols []int `json:"cols" displayname:"Columns to select" doc-key:"staticselect.cols"`
	//Type selection type
	Type StaticSelectionType `json:"type" displayname:"Selection type" doc-key:"staticselect.type"`
	//Accept true - confirm selection. false - abort selection
	Accept bool `json:"accept" displayname:"Accept selection" doc-key:"staticselect.accept"`
	//WrapSelections
	WrapSelections bool `json:"wrap" displayname:"Wrap selections" doc-key:"staticselect.wrap"`
}

StaticSelectSettings selection settings

func (StaticSelectSettings) Execute 

func (settings StaticSelectSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute static selection

func (StaticSelectSettings) Validate 

func (settings StaticSelectSettings) Validate() error

Validate static selection settings

type StaticSelectionType 

type StaticSelectionType int

StaticSelectionType type of selection 

const (
	// HyperCubeCells select in hypercube
	HyperCubeCells StaticSelectionType = iota
	// ListObjectValues select in listbox
	ListObjectValues
)

func (StaticSelectionType) GetEnumMap 

func (value StaticSelectionType) GetEnumMap() *enummap.EnumMap

func (StaticSelectionType) MarshalJSON 

func (value StaticSelectionType) MarshalJSON() ([]byte, error)

MarshalJSON marshal selection type

func (*StaticSelectionType) UnmarshalJSON 

func (value *StaticSelectionType) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal selection type

type SubscribeObjectsSettings added in v0.5.6 

type SubscribeObjectsSettings struct {
	ClearCurrent bool     `json:"clear" displayname:"Clear" doc-key:"subscribeobjects.clear"`
	IDs          []string `json:"ids" displayname:"ID's'" doc-key:"subscribeobjects.ids"` // todo add appstructure:"" when array is supported filling with all objects
}

func (SubscribeObjectsSettings) AffectsAppObjectsAction added in v0.5.6 

func (settings SubscribeObjectsSettings) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface, returns: * added *config.AppStructurePopulatedObjects - objects to be added to the selectable list by this action * removed []string - ids of objects that are removed (including any children) by this action * clearObjects bool - clears all objects except bookmarks and sheets

func (SubscribeObjectsSettings) Execute added in v0.5.6 

func (settings SubscribeObjectsSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute implements ActionSettings interface

func (SubscribeObjectsSettings) Validate added in v0.5.6 

func (settings SubscribeObjectsSettings) Validate() error

Validate implements ActionSettings interface

type ThinkTimeSettings 

type ThinkTimeSettings struct {
	helpers.DistributionSettings
}

ThinkTimeSettings think time settings

func (ThinkTimeSettings) Execute 

func (settings ThinkTimeSettings) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute simulated think time

func (ThinkTimeSettings) LogDetails 

func (settings ThinkTimeSettings) LogDetails() string

LogDetails log think time settings

func (ThinkTimeSettings) Validate 

func (settings ThinkTimeSettings) Validate() error

Validate think time settings

type UnPublishBookmarkSettings added in v0.5.0 

type UnPublishBookmarkSettings struct {
	BookMarkSettings
}

func (UnPublishBookmarkSettings) Execute added in v0.5.0 

func (settings UnPublishBookmarkSettings) Execute(sessionState *session.State, actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute CreateBookmarkSettings action (Implements ActionSettings interface)

func (UnPublishBookmarkSettings) Validate added in v0.5.0 

func (settings UnPublishBookmarkSettings) Validate() error

Validate PublishBookmarkSettings action (Implements ActionSettings interface)

type UnPublishSheetSettings 

type UnPublishSheetSettings struct {
	Mode     PublishSheetMode `json:"mode" displayname:"Un-publish mode" doc-key:"unpublishsheet.mode"`
	SheetIDs []string         `json:"sheetIds" displayname:"Sheet IDs" doc-key:"unpublishsheet.sheetIds"`
}

UnPublishSheetSettings specifies un-publish sheet settings

func (UnPublishSheetSettings) Execute 

func (unPublishSheetSettings UnPublishSheetSettings) Execute(sessionState *session.State,
	actionState *action.State, connectionSettings *connection.ConnectionSettings, label string, reset func())

Execute performs the un-publish sheet action

func (UnPublishSheetSettings) Validate 

func (unPublishSheetSettings UnPublishSheetSettings) Validate() error

Validate checks the settings of the un-publish sheet action

type UnsubscribeObjects added in v0.5.6 

type UnsubscribeObjects struct {
	// IDs to unsubscribe to
	IDs []string `json:"ids" displayname:"ID's'" doc-key:"unsubscribeobjects.ids"` // todo add appstructure:"" when array is supported filling with subscribed objects
	// Clear unsubscribes to all objects
	Clear bool `json:"clear" displayname:"Clear" doc-key:"unsubscribeobjects.clear"`
}

func (UnsubscribeObjects) AffectsAppObjectsAction added in v0.5.6 

func (settings UnsubscribeObjects) AffectsAppObjectsAction(structure appstructure.AppStructure) ([]*appstructure.AppStructurePopulatedObjects, []string, bool)

AffectsAppObjectsAction implements AffectsAppObjectsAction interface, returns: * added *config.AppStructurePopulatedObjects - objects to be added to the selectable list by this action * removed []string - ids of objects that are removed (including any children) by this action * clearObjects bool - clears all objects except bookmarks and sheets

func (UnsubscribeObjects) Execute added in v0.5.6 

func (settings UnsubscribeObjects) Execute(sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string, reset func())

Execute implements ActionSettings interface

func (UnsubscribeObjects) Validate added in v0.5.6 

func (settings UnsubscribeObjects) Validate() error

Validate implements ActionSettings interface

type UploadDataSettings 

type UploadDataSettings struct {
	Filename string `json:"filename" displayname:"Filename" displayelement:"file" doc-key:"uploaddata.filename"`
	Path     string `json:"destinationpath" displayname:"Destination path" doc-key:"uploaddata.destinationpath"`
}

UploadDataSettings specify data file to upload

func (UploadDataSettings) Execute 

func (settings UploadDataSettings) Execute(
	sessionState *session.State, actionState *action.State, connection *connection.ConnectionSettings, label string,
	reset func(),
)

Execute action (Implements ActionSettings interface)

func (UploadDataSettings) Validate 

func (settings UploadDataSettings) Validate() error

Validate action (Implements ActionSettings interface)

type UploadMode 

type UploadMode int
const (
	// Tus chunked upload using the tus protocol
	Tus UploadMode = iota
	// Legacy upload using a POST payload
	Legacy
)

func (UploadMode) GetEnumMap 

func (value UploadMode) GetEnumMap() *enummap.EnumMap

func (UploadMode) MarshalJSON 

func (value UploadMode) MarshalJSON() ([]byte, error)

MarshalJSON marshal ThinkTime type

func (*UploadMode) UnmarshalJSON 

func (value *UploadMode) UnmarshalJSON(arg []byte) error

UnmarshalJSON unmarshal DistributionType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.