Configuring the remote store Data Load utility scheduler job

You can use the HCL Commerce Administration Console to schedule a Data Load utility job for your site.

About this task

Complete this task to update the database with your store data. This task applies to the following scenarios:
  • Complete this task once, after you create your custom store, so that your store data is loaded into the database.
  • Complete this task on a schedule to update the database with frequently-updated data. This can also be automated by uploading files over SFTP and then periodically retrieving them. For more information, see the proceeding task, Adding a remote store SFTP transport.
Note: If feasible, back up the database before performing the update.

Procedure

  1. Open the Administration Console, and select Site on the Administration Console Site/Store Selection page.
  2. Click Configuration > Scheduler. A list of jobs that are scheduled to run is displayed.
  3. On the Scheduler Status Display page, click New.
  4. From the New Scheduled Job page, select RemoteStoreDataload in the Job command drop-down list.
  5. In the Job parameters field, enter the required parameters.
    For example: sdk=true&localDirectory=C:/IBM/WCDE9/storepublish/generateData/
    sdk
    Set to true if you want to load the data file from a local directory. Set to false if you want to load your data ZIP file from a remote FTP server. The default value is false.
    localDirectory
    Specifies the local data directory where the data is located. This value is required if sdk is set to true.
    • HCL Commerce DeveloperFor example, to populate your store's data that was generated in the preceding task, Creating your custom store in your programming environment, set this parameter to the following value:
      • WCDE_installdir/storepublish/generateData/DataDirectory

    • To populate store data within a runtime environment, this value that is set will be relative to the /SETUP/app/dataload directory.

      For example, a value of DataDirectory will load files from the /SETUP/app/dataload/DataDirectory in the Transaction server Docker container.

    remoteDirectory
    Specifies the remote data directory where the data is located on the FTP server. This value is required if sdk is set to false.
    For example, to populate the generated data into the runtime environment over FTP:
    1. Create a ZIP file of the following directory: WCDE_installdir/storepublish/generateData/DataDirectory. This directory was generated in the preceding task, Creating your custom store in your programming environment.
    2. Upload the ZIP file to the remote store's FTP server, such as /dataload/runtime/storecreationdata. Ensure that only one ZIP file exists in the target folder.
    3. With the sdk parameter set to false, set the remoteDirectory parameter to the remote directory. For example, /dataload/runtime/storecreationdata
    When the scheduled Data Load is run, the ZIP file is fetched, extracted, and populate the data.
  6. Set the remaining properties for the scheduled job:
    OptionDescription
    Start date and Start time Provide the date and time this job starts running. The time must be entered in the 24-hour clock format.
    Associated user Type the user on whose behalf this job is run. By default, the user ID of the current user is entered in this field. Set the value of this field to be the same as the value in the LOGONID column of the USERREG database table.
    Allowed host Type the name of the host that runs this job. If this parameter is omitted, the job can be run by any host. This parameter is only needed if the scheduler is running on multiple hosts and if a job must be restricted to one of them. Use the following form to specify the host name: name.domain.
    Schedule interval Type the number of seconds between successive runs of this job. If this parameter is omitted, the job is run only 1 time.

    To run the job scheduler daily at a fixed time. Click the Fixed Time check box, and leave the Schedule interval field blank. Enabling Fixed Time ensures a job runs at a specified time, even with Daylight Saving Time changes.
    Job attempts and Seconds to retry Type the number of times the scheduler is to retry the job if it fails and the number of seconds before a failed job is retried. Both field must be present to retry a job.
    Scheduler policy Specify the policy to be used by the scheduler when the job fails to run. Select whether the job is run one time and the next run occurs in the future, or whether the job runs as many times as necessary to recover all missed runs.
    Job priority Type a number to be associated with the priority of this job. This value is inserted into the SCCPRIORITY column of the SCHCONFIG table. A greater number indicates a higher priority job.
    Application type Select the application schedule pool that the job is a part of. The purpose of this field is to constrain resource-intensive jobs to a limited number of threads. The application types, and the rules that govern their access to resources, are defined by the user under the HCL Commerce Administration Console. The default application type is null.
  7. Click OK. Your job is now listed on the Scheduler Status Display page and runs at the specified start time.
    If the job fails, you can review log in the Console view of your development environment.

Results

To ensure that the store assets are successfully added to the servers and that the generated store is successfully populated in your database, browse to the Store management tab in the Management Center.

For example:
  • https://host_name:port/shop/en/MyStore