@salesforce/b2c-tooling-sdk / operations/jobs
operations/jobs
Job execution operations for B2C Commerce.
This module provides functions for running and monitoring jobs on B2C Commerce instances via OCAPI.
Core Job Functions
- executeJob - Start a job execution
- getJobExecution - Get the status of a job execution
- waitForJob - Wait for a job to complete
- searchJobExecutions - Search for job executions
- findRunningJobExecution - Find a running execution
- getJobLog - Retrieve job log file content
System Jobs
- siteArchiveImport - Import a site archive
- siteArchiveExport - Export a site archive
- siteArchiveExportToPath - Export and save to local path
Usage
typescript
import {
executeJob,
waitForJob,
searchJobExecutions,
siteArchiveImport,
siteArchiveExport,
} from '@salesforce/b2c-tooling-sdk/operations/jobs';
import { B2CInstance } from '@salesforce/b2c-tooling-sdk';
const instance = B2CInstance.fromEnvironment();
// Run a custom job and wait for completion
const execution = await executeJob(instance, 'my-job-id');
const result = await waitForJob(instance, 'my-job-id', execution.id);
// Search for recent job executions
const results = await searchJobExecutions(instance, {
jobId: 'my-job-id',
count: 10
});
// Import a site archive
await siteArchiveImport(instance, './my-import-data');
// Export site data
const exportResult = await siteArchiveExport(instance, {
global_data: { meta_data: true }
});Authentication
Job operations require OAuth authentication with appropriate OCAPI permissions for the /jobs and /job_execution_search resources.
Classes
Interfaces
- ExecuteJobOptions
- ExportDataUnitsConfiguration
- ExportGlobalDataConfiguration
- ExportSitesConfiguration
- JobExecutionSearchResult
- SearchJobExecutionsOptions
- SiteArchiveExportOptions
- SiteArchiveExportResult
- SiteArchiveImportOptions
- SiteArchiveImportResult
- WaitForJobOptions