Member Junction
    Preparing search index...

    Interface ActionRunScope

    An agent run's scope, as BaseAgent hands it to each action dispatch (RunActionParams.RunScope). null fields mean the run carries no such scope; the whole object is absent outside an agent run.

    interface ActionRunScope {
        PrimaryScopeEntityName?: string;
        PrimaryScopeRecordID: string;
        SearchScopeIDs?: string[];
        SecondaryScopes?: Record<string, ActionRunScopeValue>;
    }
    Index

    Properties

    PrimaryScopeEntityName? PrimaryScopeRecordID SearchScopeIDs? SecondaryScopes?

    Properties

    PrimaryScopeEntityName?: string

    The primary scope entity's name (e.g. 'Organizations'), or null when the run names none.

    PrimaryScopeRecordID: string

    The run's tenant: the record ID within the primary scope entity, or null when the run has none.

    SearchScopeIDs?: string[]

    The search scopes the run's host assigned (ExecuteAgentParams.SearchScopeIDs); absent when it assigned none. When set, Scoped Search searches only these, and the host's assignment stands in for the calling agent's own SearchScopeAccess and assigned-scope list, and the plain Search action refuses. The user's own permission on the scope still applies.

    SecondaryScopes?: Record<string, ActionRunScopeValue>

    The run's secondary dimensions (with the agent's configured defaults applied), or null when it has none.

    Settings

    Member Visibility

    On This Page

    Properties