Documentation ¶
Index ¶
- Constants
- func RegisterNewTask(cmdName string, creator TaskRunnerCreator)
- type ApplyBMTask
- type ClearAllTask
- type CmdTaskBase
- type DuplicateTask
- type ExecEnv
- func (env *ExecEnv) CleanUp()
- func (env *ExecEnv) CreateLogger() error
- func (env *ExecEnv) GetBookmarkMap() *util.Result
- func (env *ExecEnv) GetDimensionByName(name string) (*engine.SessionDimensionLayout, bool)
- func (env *ExecEnv) GetMasterItemsMap() *util.Result
- func (env *ExecEnv) GetMeasureByName(name string) (*engine.SessionMeasureLayout, bool)
- func (env *ExecEnv) HasBookmark(title string) bool
- func (env *ExecEnv) LogErr(ctx string, err error) error
- func (env *ExecEnv) LogErrMsg(ctx, msg string) error
- func (env *ExecEnv) LogErrorResult(res *util.Result) error
- func (env *ExecEnv) Logger() *zerolog.Logger
- func (env *ExecEnv) Stash(key string, v interface{})
- func (env *ExecEnv) SyncBookmark(title string) (bool, *util.Result)
- func (env *ExecEnv) Unstash(key string) (interface{}, bool)
- type ExecEnvOption
- type FuncCmdBase
- type FuncCmdDef
- type IFuncCmd
- type MetaInfo
- type ReportTask
- type Request
- type Script
- type ScriptStep
- type SelectTask
- type SetVarTask
- type TaskRunner
- func NewApplyBMTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- func NewClearAllTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- func NewDuplicateTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- func NewReportTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- func NewSelectTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- func NewSetVarTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- func NewTaskRunner(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
- type TaskRunnerCreator
Constants ¶
View Source
const CMD_NAME_APPLY_BM = "apply_bm"
View Source
const CMD_NAME_CLEAR_ALL = "clear_all"
View Source
const CMD_NAME_DUPLICATE = "duplicate"
View Source
const CMD_NAME_REPORT = "report"
View Source
const CMD_NAME_SELECT = "select"
View Source
const CMD_NAME_SET_VAR = "set_var"
Variables ¶
This section is empty.
Functions ¶
func RegisterNewTask ¶
func RegisterNewTask(cmdName string, creator TaskRunnerCreator)
Types ¶
type ApplyBMTask ¶
type ApplyBMTask struct { *CmdTaskBase BmTitle string }
func (*ApplyBMTask) Run ¶
func (t *ApplyBMTask) Run() *util.Result
type ClearAllTask ¶
type ClearAllTask struct {
*CmdTaskBase
}
func (*ClearAllTask) Run ¶
func (t *ClearAllTask) Run() *util.Result
type CmdTaskBase ¶
type CmdTaskBase struct { Script *Script Def *FuncCmdDef Name string Logger *zerolog.Logger }
func NewCmdTaskBase ¶
func NewCmdTaskBase(s *Script, d *FuncCmdDef, n string) *CmdTaskBase
func (CmdTaskBase) LogCurrentSelection ¶
func (b CmdTaskBase) LogCurrentSelection()
func (CmdTaskBase) Validate ¶
func (b CmdTaskBase) Validate() *util.Result
type DuplicateTask ¶ added in v0.5.1
type DuplicateTask struct { *CmdTaskBase AppId string NewAppName string }
func (*DuplicateTask) Run ¶ added in v0.5.1
func (t *DuplicateTask) Run() *util.Result
type ExecEnv ¶
type ExecEnv struct { EngineConn *engine.Conn Doc *enigma.Doc QrsClient *qrs.Client AppID string Log *zerolog.Logger `json:"-"` // contains filtered or unexported fields }
func NewExecEnv ¶
func NewExecEnv(cfg *engine.Config, appid string, logger *zerolog.Logger, opts ...ExecEnvOption) (*ExecEnv, *util.Result)
NewExecEnv Note: please call CleanUp() afterwards to close engine connection properly. Script.Run() calls CleanUp() automatically
func (*ExecEnv) CreateLogger ¶
func (*ExecEnv) GetBookmarkMap ¶
func (*ExecEnv) GetDimensionByName ¶ added in v0.4.1
func (env *ExecEnv) GetDimensionByName(name string) (*engine.SessionDimensionLayout, bool)
func (*ExecEnv) GetMasterItemsMap ¶ added in v0.4.0
func (*ExecEnv) GetMeasureByName ¶ added in v0.4.1
func (env *ExecEnv) GetMeasureByName(name string) (*engine.SessionMeasureLayout, bool)
func (*ExecEnv) HasBookmark ¶
type ExecEnvOption ¶ added in v0.5.1
func WithQrsClient ¶ added in v0.5.1
func WithQrsClient(c *qrs.Client) ExecEnvOption
type FuncCmdBase ¶
type FuncCmdBase struct { MetaInfo `json:",inline" yaml:",inline"` Def *FuncCmdDef `json:"def,omitempty" yaml:"def,omitempty"` Env *ExecEnv `json:"env,omitempty" yaml:"env,omitempty"` }
TODO: remove FuncCmdBase and use MetaInfo directly
type FuncCmdDef ¶
type FuncCmdDef struct { Cmd string `json:"cmd,omitempty" yaml:"cmd,omitempty"` Target string `json:"target,omitempty" yaml:"target,omitempty"` Args []string `json:"args,omitempty" yaml:"args,omitempty"` FieldValues []*enigma.FieldValue `json:"field_values,omitempty" yaml:"field_values,omitempty"` Report *report.Report `json:"report,omitempty" yaml:"report,omitempty"` }
type ReportTask ¶ added in v0.5.1
type ReportTask struct { *CmdTaskBase Report report.Report }
func (*ReportTask) Run ¶ added in v0.5.1
func (t *ReportTask) Run() *util.Result
type Request ¶
type Request struct { Script *Script Tasks []TaskRunner }
type Script ¶
type Script struct { FuncCmdBase `json:",inline" yaml:",inline"` AppID *string `json:"app_id,omitempty" yaml:"app_id,omitempty"` Setup []*FuncCmdDef `json:"setup,omitempty" yaml:"setup,omitempty"` Steps []*ScriptStep `json:"steps,omitempty" yaml:"steps,omitempty"` Cleanup []*FuncCmdDef `json:"cleanup,omitempty" yaml:"cleanup,omitempty"` }
func (*Script) CreateExecEnv ¶
func (*Script) GenerateTaskRunners ¶
func (ts *Script) GenerateTaskRunners() ([]TaskRunner, *util.Result)
type ScriptStep ¶
type ScriptStep struct { FuncCmdBase `json:",inline" yaml:",inline"` Function []*FuncCmdDef `json:"function,omitempty" yaml:"function,omitempty"` }
func (*ScriptStep) GenerateTaskRunners ¶
func (tc *ScriptStep) GenerateTaskRunners(ts *Script) ([]TaskRunner, *util.Result)
type SelectTask ¶
type SelectTask struct { *CmdTaskBase FieldName string FieldValues []*enigma.FieldValue }
func (*SelectTask) Run ¶
func (t *SelectTask) Run() *util.Result
type SetVarTask ¶
type SetVarTask struct { *CmdTaskBase VarName string VarValue string }
func (*SetVarTask) Run ¶
func (t *SetVarTask) Run() *util.Result
type TaskRunner ¶
func NewApplyBMTask ¶
func NewApplyBMTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
func NewClearAllTask ¶
func NewClearAllTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
func NewDuplicateTask ¶ added in v0.5.1
func NewDuplicateTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
func NewReportTask ¶ added in v0.5.1
func NewReportTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
func NewSelectTask ¶
func NewSelectTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
func NewSetVarTask ¶
func NewSetVarTask(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
func NewTaskRunner ¶
func NewTaskRunner(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
type TaskRunnerCreator ¶
type TaskRunnerCreator func(s *Script, d *FuncCmdDef, n string) (TaskRunner, *util.Result)
Click to show internal directories.
Click to hide internal directories.