auth::sync::job::start (public)

 auth::sync::job::start [ -job_id job_id ] -authority_id authority_id \
    [ -interactive ] [ -creation_user creation_user ]

Defined in packages/acs-authentication/tcl/sync-procs.tcl

Record the beginning of a job.

Switches:

-job_id (optional)

-authority_id (required)

The ID of the authority you're trying to sync

-interactive (optional, boolean)

Set this if this is an interactive job, i.e. it's initiated by a user.

-creation_user (optional)

Returns:

job_id An ID for the new batch job. Used when calling other procs in this API.

Author:

Lars Pind <lars@collaboraid.biz>

Testcases:

sync_start_end, sync_actions, sync_snapshot, auth_sync_process_ims_implementations

Source code:

    db_transaction {
        if { $job_id eq "" } {
            set job_id [db_nextval "auth_batch_jobs_job_id_seq"]
        }

        if { $interactive_p && $creation_user eq "" } {
            set creation_user [ad_conn user_id]
        }

        set interactive_p [db_boolean $interactive_p]

        db_dml job_insert {
            insert into auth_batch_jobs
            (job_id, interactive_p, creation_user, authority_id)
            values
            (:job_id, :interactive_p, :creation_user, :authority_id)
        }

    }

    # See the cache, we're going to need it shortly
    auth::sync::job::get_authority_id_seed -job_id $job_id -authority_id $authority_id

    return $job_id

Generic XQL file:

packages/acs-authentication/tcl/sync-procs.xql

PostgreSQL XQL file:

packages/acs-authentication/tcl/sync-procs-postgresql.xql

Oracle XQL file:

packages/acs-authentication/tcl/sync-procs-oracle.xql