Audience: Suppliers

You can create as many automated jobs as necessary to automate your data import and export with the platform. These jobs can be configured to export or import files to and from multiple locations, including your own SFTP site. Jobs can also be configured to run at various times to fit your schedule.

Note: Rithum has limits to the number of records that can be exported for order, shipment, invoice, or return exports. Jobs that exceed 100,000 records will be truncated. If you need to export a large data set, it’s best to consider setting up a report or filtering the data to reduce the size of the export.

File naming convention

When creating an automated job, the workflow, job type (import or export), and file type (such as xls, EDI) dictate the default file name. The table below contains the default naming conventions.

  • For an import file, you create the file and name it according to one of the naming conventions below, or specify a naming convention.
  • For an export file, the platform creates an output file according to one of the naming conventions below, or according to the naming convention you specify.
Workflow Job Type Default File Name
Inventory Import Inventory_*.[file extension]
Inventory Export Inventory_{$ymdt}.[file extension]
Catalog Import Catalog_*.[file extension]
Catalog Export Catalog_{$ymdt}.[file extension]
Catalog
(Advanced catalog services only)		 Import ACS_{retailer_id}
Shipment Import Shipment_*.[file extension]
Shipment Export Shipment_{$ymdt}.[file extension]
Cancel Import Cancel_*.[file extension]
Cancel Export Cancel_{$ymdt}.[file extension]
Invoice Import Invoice_*.[file extension]
Invoice Export Invoice_{$ymdt}.[file extension]
Return Import Return_*.[file extension]
Return Export Return_{$ymdt}.[file extension]
Orders Import Purchase_Order_*.[file extension]
Orders Export Purchase_Order_{$ymdt}.[file extension]
EDI Import No convention

Creating an import job

Want to see a walkthrough of how to create an import job? Click the ? icon in the top-right corner of the page to click through the steps directly in the web application.

Step 1: Click the navigation menu and then click Automation & Reporting > Automation > Jobs.

Step 2: Click Create Job.

Step 3: On the first page:

  • Job Title: Add a name for the import job.
  • Process: Select the process type. Here are some examples:
    • If the job will be importing EDI files, select EDI - Import.
    • If the job will be importing inventory CSV files, select Inventory - Import.
    • If the job will be importing advanced catalog services files, select Catalog-Import.
  • Standard: Select the desired map. The default is DSCO, which will always be kept up to date with the newest schema fields. Here are some examples of other standards to select from:
    • For your own custom-mapped values, select Custom Mapping.
    • For advanced catalog services data, select DSCO_ACS.

Click NEXT STEP to continue.

Step 4: Review the following options:

  • Source Type: Select from where you will import your document. The default option is a Rithum-hosted SFTP site. If you choose to use this option, the Username, Password, and Location fields will be automatically populated.
  • Configure additional job settings depending on the type of job and integration.
  • Be sure to include an email address in the Email Address field so Rithum can notify you of any job failures.

Click NEXT STEP to continue.

Step 5: Choose how often the job will run. The recommended option is Hourly. Click Save Job when you're finished.

Note: The Custom option is an advanced feature that allows users to set specific job schedules for each automated job. For more information about using Crontab scheduling, see https://en.wikipedia.org/wiki/Cron or https://www.adminschoice.com/crontab-quick-reference.

Step 6: Once the job is saved, it will be visible on the Jobs page. Click the desired action icon from the Actions column:

  • View Job: View the specific job settings.
  • Edit Job: Edit and customize the job.
  • Pause/Play: deactivate or reactivate the job. Pausing the job will prevent it from running again until it is reactivated.
  • Upload File: Manually upload a document for the job to process.
  • Automation Link: Create a static automation link to access the job from an external site.
  • Run Now: Force the job to run immediately instead of waiting for the next scheduled run.
  • History: View the process history of the job.
  • Delete: Delete and remove the job.

Creating an export job

Want to see a walkthrough of how to create an export job? Click the ? icon in the top-right corner of the page to click through the steps directly in the web application.

To create an automated export job, follow these steps:

Step 1: On the Jobs  page, click Create Job.

Step 2: On the first page:

  • Job Title: Add a name for the export job.
  • Process: Select the process type for the type of data you wish to export. There are export process types for each of the familiar workflows in the platform. Here are some examples:
    • If you wish to export your orders via automated job, select Order - Export.
    • If you’re looking to export product data, select Catalog - Export.
  • Standard: Select the desired map. The default is DSCO, which will always be kept up to date with the newest schema fields. Here are some examples of other standards to select from:
    • For your own custom-mapped values, select Custom Mapping.
    • For advanced catalog services data, select DSCO_ACS.

Click NEXT STEP to continue.

Step 3: On the second page, select the specific options/parameters for the type of job you are creating. You can click any of the circular question mark icons to learn more about what function a particular field serves.

  • Export Source: Choose which retailers will be included in the exports for this job or the source data for the job. Select any additional options applicable to the job.
  • Export Destination: Select where you would like the export data to be sent and any additional options applicable to the job. One option is for the orders to be sent as an Email Attachment. In that case, include an email address in the Email text box.
  • Requested Locale(s): Click within the text box to select one or multiple languages (if applicable to the job).
  • Failure Notifications?: Be sure to include an email address so you’ll be notified of any job failures.

Click Next Step to continue.

Step 4: Choose how often the job will run. The recommended option is Hourly. Select Save Job when you're finished.

Note: The Custom option is an advanced feature that allows users to set specific job schedules for each automated job. For more information about using Crontab scheduling, see https://en.wikipedia.org/wiki/Cron or https://www.adminschoice.com/crontab-quick-reference.

Step 5: Once the job is saved, it will be visible on the Jobs page. Click the desired action icon from the Actions column:

  • View Job: View the specific job settings.
  • Edit Job: Edit and customize the job.
  • Pause/Play: deactivate or reactivate the job. Pausing the job will prevent it from running again until it is reactivated.
  • Automation Link: Create a static automation link to access the job from an external site.
  • Run Now: Force the job to run immediately instead of waiting for the next scheduled run.
  • History: View the process history of the job.
  • Delete: Delete and remove the job.
Was this article helpful?
1 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.

Articles in this section