@servicenow/sdk - v4.9.0
    Preparing search index...

    Interface DataLookupMatchRule<S, M>

    A match rule that identifies which row in the matcher table corresponds to the source record. The source record's sourceField value is compared against the matcher table's matcherField value.

    Each match rule is its own dl_definition_rel_match record on the instance and must have its own $id so the same sys_id is used across all build environments.

    interface DataLookupMatchRule<
        S extends TableName = TableName,
        M extends TableName = TableName,
    > {
        $id: string | number | ExplicitKey<string>;
        exactMatch?: boolean;
        matcherField:
            | string & {}
            | "sys_created_on"
            | "sys_created_by"
            | "sys_updated_on"
            | "sys_updated_by"
            | "sys_id"
            | "sys_mod_count"
            | keyof (
                Tables[M]["extends"] extends E
                    ? Tables[E] extends { schema: object }
                        ? Schema<M> & (
                            Tables[E]["extends"] extends E
                                ? Tables[E] extends { schema: object }
                                    ? Schema<E> & (
                                        Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { schema: object; } ? Schema<E> & (Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { ...; } ? Schema<...> & ... 1 more ... & PlatformColumns : Schema<...> : Schema<...>) & PlatformColumns : Schema<...> : Schema<...>
                                    ) & PlatformColumns
                                    : Schema<E>
                                : Schema<E>
                        ) & PlatformColumns
                        : Schema<M>
                    : Schema<M>
            );
        sourceField:
            | string & {}
            | "sys_created_on"
            | "sys_created_by"
            | "sys_updated_on"
            | "sys_updated_by"
            | "sys_id"
            | "sys_mod_count"
            | keyof (
                Tables[S]["extends"] extends E
                    ? Tables[E] extends { schema: object }
                        ? Schema<S> & (
                            Tables[E]["extends"] extends E
                                ? Tables[E] extends { schema: object }
                                    ? Schema<E> & (
                                        Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { schema: object; } ? Schema<E> & (Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { ...; } ? Schema<...> & ... 1 more ... & PlatformColumns : Schema<...> : Schema<...>) & PlatformColumns : Schema<...> : Schema<...>
                                    ) & PlatformColumns
                                    : Schema<E>
                                : Schema<E>
                        ) & PlatformColumns
                        : Schema<S>
                    : Schema<S>
            );
    }

    Type Parameters

    Index

    Properties

    $id exactMatch? matcherField sourceField

    Properties

    $id: string | number | ExplicitKey<string>
    exactMatch?: boolean

    When true, requires an exact value match between source and matcher fields. When false (default), allows fuzzy or range-based matching.

    matcherField:
        | string & {}
        | "sys_created_on"
        | "sys_created_by"
        | "sys_updated_on"
        | "sys_updated_by"
        | "sys_id"
        | "sys_mod_count"
        | keyof (
            Tables[M]["extends"] extends E
                ? Tables[E] extends { schema: object }
                    ? Schema<M> & (
                        Tables[E]["extends"] extends E
                            ? Tables[E] extends { schema: object }
                                ? Schema<E> & (
                                    Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { schema: object; } ? Schema<E> & (Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { ...; } ? Schema<...> & ... 1 more ... & PlatformColumns : Schema<...> : Schema<...>) & PlatformColumns : Schema<...> : Schema<...>
                                ) & PlatformColumns
                                : Schema<E>
                            : Schema<E>
                    ) & PlatformColumns
                    : Schema<M>
                : Schema<M>
        )

    Field on the matcher table to compare against the source field value.

    sourceField:
        | string & {}
        | "sys_created_on"
        | "sys_created_by"
        | "sys_updated_on"
        | "sys_updated_by"
        | "sys_id"
        | "sys_mod_count"
        | keyof (
            Tables[S]["extends"] extends E
                ? Tables[E] extends { schema: object }
                    ? Schema<S> & (
                        Tables[E]["extends"] extends E
                            ? Tables[E] extends { schema: object }
                                ? Schema<E> & (
                                    Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { schema: object; } ? Schema<E> & (Tables[E]["extends"] extends infer E extends string ? Tables[E] extends { ...; } ? Schema<...> & ... 1 more ... & PlatformColumns : Schema<...> : Schema<...>) & PlatformColumns : Schema<...> : Schema<...>
                                ) & PlatformColumns
                                : Schema<E>
                            : Schema<E>
                    ) & PlatformColumns
                    : Schema<S>
                : Schema<S>
        )

    Field on the source table whose value is used to find a matching row in the matcher table.

    Settings

    Member Visibility

    On This Page

    Properties