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

    Interface DataLookupSetRule<S, M>

    A setter rule that defines which field value to copy from a matched matcher table row back to the source record.

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

    interface DataLookupSetRule<
        S extends TableName = TableName,
        M extends TableName = TableName,
    > {
        $id: string | number | ExplicitKey<string>;
        alwaysReplace?: 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>
            );
        targetField:
            | 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 alwaysReplace? matcherField targetField

    Properties

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

    When true, overwrites the target field even if it already has a value. When false (default), leaves the target field unchanged if it already has a value.

    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 that provides the value to copy to the source record.

    targetField:
        | 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 that receives the looked-up value.

    Settings

    Member Visibility

    On This Page

    Properties