engine

Jul 27, 2024

Changes in this version

+ const InMemAppMethod

+ func HyperCubeDiff(path string, from, to *enigma.HyperCube) (*util.Diff, *util.Result)

+ type AppsHealthInfo struct

+ ActiveDocs []string

+ Calls int64

+ InMemoryDocs []string

+ LoadedDocs []string

+ Selections int64

+ type CPUHealthInfo struct

+ Total int

+ type CacheHealthInfo struct

+ Added int64

+ BytesAdded int64

+ Hits int64

+ Lookups int64

+ Replaced int64

type Cluster

+ Logger *zerolog.Logger

type Config

+ Cookie http.CookieJar

+ func (cfg Config) GetHttpsBaseUrl() (*url.URL, *util.Result)

type Conn

+ func NewConnFromCluster(c *Cluster, appId string) (*Conn, *util.Result)

+ func NewConnFromRAC(c *rac.RestApiClient, appId string) (*Conn, *util.Result)

+ type FilterOptions struct

+ ObjectBlackList []string

+ ObjectWhiteList []string

+ SheetBlackList []string

+ func (f *FilterOptions) BuildMap()

+ func (f *FilterOptions) IsObjectBlackListed(object string) bool

+ func (f *FilterOptions) IsObjectWhiteListed(object string) bool

+ func (f *FilterOptions) IsSheetBlackListed(sheet string) bool

+ type HealthInfo struct

+ Apps AppsHealthInfo

+ Cache CacheHealthInfo

+ Cpu CPUHealthInfo

+ Mem MemHealthInfo

+ Saturated bool

+ Session SessionHealthInfo

+ Started string

+ Users UsersHealthInfo

+ Version string

+ type HttpClient struct

+ BaseUrl *url.URL

+ ExtraHeaders http.Header

+ Logger *zerolog.Logger

+ func NewHttpClient(cfg Config) (*HttpClient, *util.Result)

+ func (c *HttpClient) Do(method string, endpoint string, params map[string]string, body interface{}) ([]byte, *util.Result)

+ func (c *HttpClient) DoRequest(req *http.Request) ([]byte, *util.Result)

+ func (c *HttpClient) Get(endpoint string, params map[string]string) ([]byte, *util.Result)

+ func (c *HttpClient) GetHealthInfo() (*HealthInfo, *util.Result)

+ func (c *HttpClient) GetUrl(endpoint string) string

+ func (c *HttpClient) NewRequest(method string, endpoint string, params map[string]string, body interface{}) (*http.Request, *util.Result)

+ type MemHealthInfo struct

+ Allocated float64

+ Committed float64

+ Free float64

+ type MixedConfig struct

+ AppId string

+ OnPrem *Config

+ OnPremCluster *Cluster

+ QCS *rac.Config

+ func (mc MixedConfig) Connect() (*Conn, *util.Result)

type ObjWalkEntry

+ Config *MixedConfig

+ SheetId string

+ SheetName string

type ObjWalkFunc

+ func NewRecurObjWalkFuncSync[T any](walker ObjWalkFunc[T]) ObjWalkFunc[T]

type ObjWalkResult

+ ObjectTitle *string

+ SheetId string

+ SheetName string

+ func RecurWalkObjectSync[T any](e ObjWalkEntry, walker ObjWalkFunc[T]) (*ObjWalkResult[T], *util.Result)

+ type SessionHealthInfo struct

+ Active int

+ Total int

+ type UsersHealthInfo struct

+ Active int

+ Total int

+ type WalkOptions struct

+ Filter *FilterOptions

+ IgnoreError bool

+ MaxWorkers int

+ OpendocRetries int

+ RetryDelay int

+ Sync bool

+ func DefaultWalkOptions() *WalkOptions

+ func WalkOptionsForHuge() *WalkOptions

Dec 18, 2023

Changes in this version

+ const HashAppMethod

+ const HashUserMethod

+ const RandomMethod

+ type Cluster struct

+ Method string

+ Nodes []*Config

+ func (c Cluster) PickOneFor(appid, uid string) *Config

Oct 24, 2023

Changes in this version

+ type ObjWalkEntry struct

+ AppId *string

+ Doc *enigma.Doc

+ Info *enigma.NxInfo

+ Item *NxContainerEntry

+ Logger *zerolog.Logger

+ Parent *enigma.NxInfo

type ObjWalkResult

+ Parent *enigma.NxInfo

type ObjWalker

+ Entry ObjWalkEntry

Oct 16, 2023

Changes in this version

+ type PagingMethod func(rect enigma.Rect) []*enigma.NxPage

Oct 8, 2023

Changes in this version

type Config

+ func (c Config) GetAppUrl() (string, *util.Result)

Oct 1, 2023

Changes in this version

+ func CapSize(sz *enigma.Size, cap enigma.Size)

+ func FlattenObject(obj *ObjWalkResult[T], m ListWalkResult[T])

+ func GetHyperCube(obj *enigma.GenericObject, sz enigma.Size) (*enigma.HyperCube, *util.Result)

type AppWalkResult

+ func AppSnapshotDiff(from, to AppWalkResult[ObjectSnapshot]) (AppWalkResult[util.Diff], *util.Result)

type ListWalkResult

+ func FlattenList(list ListWalkResult[T]) ListWalkResult[T]

type ObjWalkResult

+ func ObjSnapshoter(doc *enigma.Doc, info, parent *enigma.NxInfo, _logger *zerolog.Logger) (*ObjWalkResult[ObjectSnapshot], *util.Result)

type ObjectSnapshot

+ HyperCube *enigma.HyperCube

+ func (from *ObjectSnapshot) Diff(to *ObjectSnapshot) (*util.Diff, *util.Result)

Sep 21, 2023

Changes in this version

+ const ANY_LIST

+ const BM_LIST

+ const DIM_LIST

+ const MEASURE_LIST

+ const SHEET_LIST

+ const VAR_LIST

+ var ObjectListNameMap = map[string]string

type AppLayoutMeta

+ func (l *AppLayoutMeta) RemoveVolatileFields()

+ type AppProperties struct

+ CreatedDate *string

+ ModifiedDate *string

+ func (p *AppProperties) RemoveVolatileFields()

+ type AppWalkResult map[string]ListWalkResult[T]

+ func RecursiveGetSnapshots(doc *enigma.Doc, _logger *zerolog.Logger) (AppWalkResult[ObjectSnapshot], *util.Result)

+ func WalkApp(doc *enigma.Doc, walkers ListWalkFuncMap[T], _logger *zerolog.Logger) (AppWalkResult[T], *util.Result)

+ type AppWalker struct

+ Logger *zerolog.Logger

+ Walkers ListWalkFuncMap[T]

+ func (w *AppWalker[T]) Walk(doc *enigma.Doc) (AppWalkResult[T], *util.Result)

+ func (w *AppWalker[T]) WalkSheets(doc *enigma.Doc, walker ObjWalkFuncEx[T]) (AppWalkResult[T], *util.Result)

+ type ListWalkFuncMap map[string]ObjWalkFunc[T]

+ type ListWalkResult map[string]*ObjWalkResult[T]

+ type ObjWalkFunc func(doc *enigma.Doc, item NxContainerEntry, _logger *zerolog.Logger) (*ObjWalkResult[T], *util.Result)

+ func NewRecurObjWalkFunc(walker ObjWalkFuncEx[T]) ObjWalkFunc[T]

+ type ObjWalkFuncEx func(doc *enigma.Doc, info, parent *enigma.NxInfo, _logger *zerolog.Logger) (*ObjWalkResult[T], *util.Result)

+ type ObjWalkResult struct

+ ChildResults []*ObjWalkResult[T]

+ Info *enigma.NxInfo

+ Meta *NxMeta

+ Result *T

+ func RecurWalkObject(doc *enigma.Doc, entry NxContainerEntry, parent *enigma.NxInfo, ...) (*ObjWalkResult[T], *util.Result)

+ type ObjWalker struct

+ Logger *zerolog.Logger

+ Walker ObjWalkFuncEx[T]

+ func (w *ObjWalker[T]) Walk(doc *enigma.Doc, info *enigma.NxInfo) (*ObjWalkResult[T], *util.Result)

type ObjectPropeties

+ func (p *ObjectPropeties) RemoveVolatileFields()

+ type ObjectSnapshot struct

+ Description *string

+ Digest string

+ Properties json.RawMessage

+ Title *string

Aug 26, 2023

Changes in this version

+ var SessionMeasureListDefData = []byte(`{"qMeasure": "/qMeasure"}`)

+ type SessionDimensionData struct

+ Dim *enigma.NxLibraryDimension

+ DimInfos []*enigma.GenericDimensionInfo

+ Title *string

+ type SessionDimensionLayout struct

+ Dim *enigma.NxLibraryDimension

+ DimInfos []*enigma.GenericDimensionInfo

+ Info *enigma.NxInfo

+ Meta *NxMeta

+ type SessionMeasureData struct

+ Measure *enigma.NxLibraryMeasure

+ Title *string

+ type SessionMeasureLayout struct

+ Info *enigma.NxInfo

+ Measure *enigma.NxLibraryMeasure

+ Meta *NxMeta

+ func GetMeasureList(doc *enigma.Doc) ([]*SessionMeasureLayout, *util.Result)

Jun 21, 2023

Changes in this version

+ const AUTH_MODE_CERT

+ const AUTH_MODE_DESKTOP

+ const AUTH_MODE_JWT

+ const CONNECTION

+ const MASTER_OBJECT

+ const STORY

+ const ST_CLOUD

+ const ST_ON_PREM

+ var ConnCtx context.Context

+ var CreateObjMethods = map[string]string

+ var DestroyObjMethods = map[string]string

+ var GetObjMethods = map[string]string

+ var PAGE_MAX_CELLS int = 4096

+ var SessionBookmarkListDef = []byte(...)

+ var SessionDimListDefData = []byte(...)

+ var SessionObjDef = []byte(...)

+ func CreateChild(doc *enigma.Doc, parentInfo enigma.NxInfo, prop json.RawMessage) (reflect.Value, error)

+ func CreateObject(doc *enigma.Doc, qtype string, prop json.RawMessage) (reflect.Value, error)

+ func DestroyObject(doc *enigma.Doc, qtype string, qid string) (reflect.Value, error)

+ func GetCurrentSelection(doc *enigma.Doc, stateName string) (*enigma.SelectionObject, *util.Result)

+ func GetHyperCubeData(obj *enigma.GenericObject, sz enigma.Size) ([]*enigma.NxDataPage, *util.Result)

+ func GetHyperCubePivotData(obj *enigma.GenericObject, sz enigma.Size) ([]*enigma.NxPivotPage, *util.Result)

+ func GetListObject(doc *enigma.Doc, stateName, fieldName string) (*enigma.ListObject, *util.Result)

+ func GetObject(doc *enigma.Doc, qtype string, qid string) (reflect.Value, error)

+ func GetTitle(parentInfo *enigma.NxInfo, obj *ObjectPropeties, logger *zerolog.Logger) (*string, *string)

+ func GetTitleEx(obj enigma.GenericObject, objLayout ObjectLayoutEx) (*string, *string, *util.Result)

+ func HasMethodOn(any reflect.Value, name string) bool

+ func Invoke(any interface{}, name string, args ...interface{}) (Results []reflect.Value, err error)

+ func Invoke1ErrOn(any reflect.Value, name string, args ...interface{}) error

+ func Invoke1Res1Err(any interface{}, name string, args ...interface{}) (Result reflect.Value, err error)

+ func Invoke1Res1ErrOn(any reflect.Value, name string, args ...interface{}) (Result reflect.Value, err error)

+ func InvokeOn(any reflect.Value, name string, args ...interface{}) (Results []reflect.Value, err error)

+ func Paging(rect enigma.Rect) []*enigma.NxPage

+ func PivotPaging(rect enigma.Rect) []*enigma.NxPage

+ func RecursiveCreateObject(doc *enigma.Doc, prop ObjectPropeties, parent *enigma.NxInfo) (*enigma.GenericObject, *util.Result)

+ func SetStringVariable(doc *enigma.Doc, name string, value string) error

+ func SetVariable(doc *enigma.Doc, name string, value string) error

+ type AppLayoutMeta struct

+ CreatedDate string

+ DynamicColor string

+ FileName string

+ HasData bool

+ HasScript bool

+ ID string

+ IsBDILiveMode bool

+ IsOpenedWithoutData bool

+ IsSessionApp bool

+ LastReloadTime string

+ LocaleInfo *enigma.LocaleInfo

+ Meta *AppMeta

+ Modified bool

+ ModifiedDate string

+ Privileges []string

+ Prop *enigma.NxAppProperties

+ PublishTime string

+ Published bool

+ ReadOnly bool

+ StateNames []string

+ Thumbnail *enigma.StaticContentUrl

+ Title string

+ type AppMeta struct

+ Name string

+ Prop *enigma.NxAppProperties

+ type AppObjectList struct

+ Items []*NxContainerEntry

+ type AuditLogEntry struct

+ Command string

+ Context string

+ Description string

+ EngineTimestamp AuditLogTimeStamp

+ EngineVersion string

+ Hostname string

+ Id string

+ Id2 string

+ Message string

+ ObjectId string

+ ObjectName string

+ Origin string

+ ProductVersion string

+ ProxyPackageId string

+ ProxySessionId string

+ RequestSequenceId string

+ Result string

+ Service string

+ SessionId string

+ Timestamp AuditLogTimeStamp

+ UserDirectory string

+ UserId string

+ func ReadAuditLogFile(file string) ([]AuditLogEntry, *util.Result)

+ type AuditLogTimeStamp struct

+ func (date *AuditLogTimeStamp) UnmarshalCSV(csv string) (err error)

+ type AuthMethod string

+ type BookmarkEntry struct

+ Data json.RawMessage

+ Info *enigma.NxInfo

+ Meta *BookmarkMeta

+ func GetBookmarks(doc *enigma.Doc) ([]*BookmarkEntry, *util.Result)

+ type BookmarkList struct

+ Items []*NxContainerEntry

+ type BookmarkMeta struct

+ Title string

+ type ColumnInfo struct

+ ApprMaxGlyphCount int

+ AttrDimInfo []*enigma.NxAttrDimInfo

+ AttrExprInfo []*enigma.NxAttrExprInfo

+ Error *enigma.NxValidationError

+ FallbackTitle string

+ NumFormat *enigma.FieldAttributes

+ func NewColumnInfoFromDimension(dim *enigma.NxDimensionInfo) *ColumnInfo

+ func NewColumnInfoFromMeasure(m *enigma.NxMeasureInfo) *ColumnInfo

+ type Config struct

+ AppID string

+ AuthMode AuthMethod

+ Certs crypto.Certificates

+ EngineURI string

+ HubURI *HubUri

+ JWT string

+ QRSBaseURI string

+ RandomProxySession bool

+ ServerType ServerType

+ SharedFolderRoot *string

+ UserDirectory string

+ UserName string

+ func (cfg *Config) QCSEngineURIAppendAppID(appid string) *util.Result

+ func (cfg Config) IsCloud() bool

+ func (cfg Config) IsDesktop() bool

+ func (cfg Config) IsOnPrem() bool

+ type Conn struct

+ Cfg Config

+ Global *enigma.Global

+ func NewConn(cfg Config) (con *Conn, err error)

+ type ContainerChildInfo struct

+ ContainerChildId string

+ QExtendsId string

+ ShowCondition string

+ Title string

+ Visualization string

+ type ContainerChildItem struct

+ Entry *enigma.NxContainerEntry

+ Info *ContainerChildInfo

+ type DimensionList struct

+ Items []*NxContainerEntry

+ func GetDimensionList(doc *enigma.Doc) (*DimensionList, *util.Result)

+ type HubUri struct

+ Host string

+ IsSecure bool

+ Port int

+ Prefix string

+ type MeasureList struct

+ Items []*NxContainerEntry

+ type NxContainerEntry struct

+ Data json.RawMessage

+ Info *enigma.NxInfo

+ Meta *NxMeta

+ func GetObjectList(doc *enigma.Doc, ctx context.Context, objType string) ([]*NxContainerEntry, error)

+ type NxMeta struct

+ Approved bool

+ CreatedDate *string

+ Description *string

+ DynamicColor *string

+ ModifiedDate *string

+ Privileges []string

+ PublishTime *string

+ Published bool

+ Title *string

+ type ObjectChildEx struct

+ Id string

+ IsMaster bool

+ Label string

+ RefId string

+ type ObjectLayoutEx struct

+ Children []*ObjectChildEx

+ ColumnInfos []*ColumnInfo

+ Footnote string

+ Subtitle string

+ Title string

+ Totals *ObjectLayoutTotals

+ func GetObjectLayoutEx(obj *enigma.GenericObject) (*ObjectLayoutEx, *util.Result)

+ type ObjectLayoutTotals struct

+ Label string

+ Position string

+ Show bool

+ type ObjectPropeties struct

+ ChildInfos []*ObjectPropeties

+ Info *enigma.NxInfo

+ Meta *NxMeta

+ Properties json.RawMessage

+ func GetSheetsObjectProperties(doc *enigma.Doc) ([]*ObjectPropeties, *util.Result)

+ func RecursiveGetProperties(doc *enigma.Doc, entry NxContainerEntry) (*ObjectPropeties, error)

+ func (p *ObjectPropeties) GetChild(id string) (*ObjectPropeties, bool)

+ type ServerType string

+ type SessionBookmark struct

+ Bookmark *enigma.NxBookmark

+ Info *enigma.NxInfo

+ Meta *NxMeta

+ SelectionFields string

+ SheetId string

+ func GetSessionBookmarks(doc *enigma.Doc) ([]SessionBookmark, *util.Result)

+ type SessionObjectLayout struct

+ AppObjectList *AppObjectList

+ BookmarkList *BookmarkList

+ ChildList *enigma.ChildList

+ DimensionList *DimensionList

+ EmbeddedSnapshot *enigma.EmbeddedSnapshot

+ Error *enigma.NxLayoutErrors

+ ExtendsId string

+ ExtensionList *enigma.ExtensionList

+ FieldList *enigma.FieldList

+ HasSoftPatches bool

+ HyperCube *enigma.HyperCube

+ Info *enigma.NxInfo

+ ListObject *enigma.ListObject

+ MeasureList *MeasureList

+ MediaList *enigma.MediaList

+ Meta *NxMeta

+ NxLibraryDimension *enigma.NxLibraryDimension

+ NxLibraryMeasure *enigma.NxLibraryMeasure

+ SelectionInfo *enigma.NxSelectionInfo

+ SelectionObject *enigma.SelectionObject

+ StateName string

+ StaticContentUrl *enigma.StaticContentUrl

+ TreeData *enigma.TreeData

+ UndoInfo *enigma.UndoInfo

+ VariableList *VariableList

+ func GetSessionObjectLayout(doc *enigma.Doc) (*SessionObjectLayout, *util.Result)

+ type VariableList struct

+ Items []*NxContainerEntry