Exports

Exports

Info
Module: Exports
Topic: Module Overview
Version(s): Version 5.1 and up 
Editions: Standard, Commerce, Call Center

What Are Exports

The exports page is where you can export order, media, call, and other various types of information from OrderLogix to outside sources. 
Alert
Outbound connection from OrderLogix’s network will originate from 66.186.180.68. You may need to provide this information to the FTP / SFTP server administrator for firewall white-listing on the remote server network.


Making The Connection

Where Will I See This Within OLX?

Process History allows you to review jobs that run within your instance. The data from this module will export from your OLX instance and import to an offsite location such as an FTP site or a vendor's platform.

What Reports Can Be Pulled?

  1. Shipment Batch Report Definitions (orderlogix.com)

Exports Archive and Specs

  1. Export Archive (orderlogix.com)
  2. OLX Order Import/Export V4 Spec (orderlogix.com)
  3. OLX Shipping Export v5.0 (orderlogix.com)

Trouble Shooting

  1. Export delivery via sFTP, FTPS or FTP Failing

  2. Exports-String or Binary Data will be Truncated

  3. Error in onStart():You must set RemoteFile before attempting a download or upload

    1. Navigate to processing > imports/exports > exports > show schedules
      1. Keep schedule open, click on Delivery tab
      2. Set Folder name that is found on server
      3. Save schedule
      4. Try export again
  4. Error in onStart(). The remote server returned an error: (500) Internal Server Error

    1. Connection could not be made to server at time job tried to run. Please try to run job again, if error received a second time on same job please create a ticket
  5. Error in onStart():Error:The remote server returned an error: (401) Unauthorized.

    1. Invalid credentials. Double check username and password is entered correctly - capitalization and spaces matter!
  6. Error in onStart():Open remote file failed [4]: Failure

    1. Pertains to duplicate file names and not being able to write over an existing file.
      1. The quickest and easiest solution to eliminate this issue is to create separate folders for each report to be dropped in.
      2. You may also want to make sure the users overwrite permissions are not being denied.
  7. Error in onStart():Open remote file failed [3]: Permission denied.

    1. Double check setup and credentials
      1. Review all special characters are appropriately placed, remove any that should not be used
      2. Review capitalization and spaces
  8. Error in onStart():ReceiveViaSFTP: Error Connecting to Remote Host Connection closed.

    1. Indicative of the remote FTP server actively denying/closing the connection. This is a good sign that that there was some administrative/maintenance work going on at the time.
  9. Error in onStart():Error:The operation has timed-out

    1. Make sure there are no other jobs running and run the export again. If you receive error a second time, please open a ticket so that we can review.


Setup

Navigate to Processing>Import/Export>Exports.

  1. Choose a client from the Client drop down list.
    1. This will determine eligible specs in following dropdown.
  2. Choose a spec from the Spec Name drop down list.
    1. MBM Calls Export
    2. OLX Leads Export
  3. If a date range is required for that spec, enter a start date and end date.
  4. If partial order options are available for that spec
    1. Require payment of all other items on the orderwill not allow any ship ready items into batch if all items are not ship ready regardless of product group(s) selected.
      Alert
      This will keep orders with an item on backorder from being eligible for the remaining line items not in backorder.
    2. Require that ALL shippable items on the order are included in this export
      all ship ready items on order in product group(s) selected will ship in same batch
      Alert
      If there are multiple shippable items on the order in different product groups and all product groups are not selected, none of the items will export with this option checked.
  5. Select an available product group, or multiple product groups, from the available list. 
    Notes
    (Note: If you are exporting media information, you will need to select the product group that is the same exact name as one of your campaigns)
    1. Move them to the selected list by clicking the right arrow. This product group will now be available for the export.
    2. To move all product groups from the available list to the selected list, click the double right arrow icon.
    3. To remove a product group, select a product group, or multiple product groups, from the selected list.
    4. To move it back to the available list click the left arrow. The product group will no longer be available when performing this export.
    5. To remove all product groups from the selected list, click the double left arrow icon.
  6. Click the Export button to perform the export.
  7. Once the process begins, you will see the results tab displayed; and it will state "Job ran successfully" when the file is complete. 

  8. There will be a "download" file link located in the results tab that allows you to save the file to your computer.
  9. The Delivery and Encryption tabs are associated with Automated Schedules


Show Schedules

Warning
Have the configuration and delivery already set for job being scheduled. You will have to save the job after changes are made to any settings.


Clicking the Show Schedules  button will display the schedule editor.



To modify an existing schedule click on the maximize arrow beside the schedule name and the attributes for that schedule will be displayed.
 

To close the view of that schedule click on the minimize arrow beside the schedule name and you will be returned to the list of the schedules in the editor.


To add a new schedule click on the Add  button located in the Edit Schedules window and a new schedule will appear:


The toggle  button allows you the option to setup the new schedule either based off Time or Linked to another scheduled job.

Time - Schedule Type

  1. New Schedule - Enter the name of the schedule. 
  2. Choose when the schedule will run from the Month, Day, Hour, and Minute drop down menus.
    1. Month,
      1. Every - to run the schedule every month, select every.
      2. Month Specific - to run the schedule only one specific month you can select the name of the month.
    2. Day,
      1. Daily - to run the schedule every day, select daily.
        1. A list of the days of the week will display. Select the day(s) you want the schedule to run:

      2. Date Specific - to run the schedule on a specific date you can select the numerical value of that date. 
        1. example 15 = 15th of the month
    3. Hour, 
      1. Every - to run the schedule every hour, select every.
        1. If Every is selected you will notice a settings icon display beside Hour - 
        2. Click on the settings icon to display the Hourly Options popup

          1. Range Start - this designates what time of the day the job will begin running.
            1. Click on the clock icon immediately to the right  to display the Time Picker popup with a list of every hour.

          2. End - this designates what time of the day the job will stop running.
            1. Click on the clock icon immediately to the right  to display the Time Picker popup with a list of every hour.

          3. Add Time - this will set the times for the job to run between the above Start and End range
            1. Toggle the Add Timebutton
            2. select the duration of how often the job should run between the Start and End range

            3. click on Add once you've made your selection
              1. The schedule times will display beside a red X

            4. Click on the red X to delete any time listed that you do not want the job to run.
            5. If you have time listed in this box the Minute option will be disabled
          4. Close - this will close the popup
      2. Hour Specific - to run the schedule only during a specific hour you can select the hour.
        1. example am 08 = 8:00 am - 8:59 am
    4. Minute
      1. Enabled
        1. Every - this will run the job every minute of the hour/s selected.
        2. Every 5 - this will run the job every 5 minutes of the hour/s selected.
        3. Every 10 - this will run the job every 10 minutes of the hour/s selected.
        4. Every 15 - this will run the job every 15 minutes of the hour/s selected.
        5. Every 30 - this will run the job every 30 minutes of the hour/s selected.
        6. 00 - 59 - this will run the job only for the specific minute of the hour/s selected.
          1. example: if you select 03 here the job will run 1:03, 2:03, 3:03 etc. 
      2. Disabled

        1. if utilizing time management from the Hour gear icon the Minute option will be disabled
          1. if only utilizing start and end time from the Hour gear icon you will still be able to use the Minute option
  3. Schedule is Active - check this box to activate schedule
    1. Uncheck this box to deactivate a schedule
  4. If you need to delete the schedule click the delete  icon.
  5. Click Alert envelope to setup the Process Alert

Linked - Schedule Type

  1. New Schedule - Enter the name of the schedule. 
  2. Choose when the schedule will run:
    1. Job Type - drop down provides different types of jobs within your system to narrow down the options for the Schedule drop down (see below)
    2. Schedule - drop down provides a list of all schedule jobs within the above selected Job Type
    3. Condition -
      1. Unconditional - Every time the above selection runs, the newly created job will run directly after
      2. On Success - Only if the above job runs successfully will the newly created job will run directly after
      3. On Failure - Only if the above job fails will the newly created job will run directly after
  3. Schedule is Active - check this box to activate schedule
    1. Uncheck this box to deactivate a schedule
  4. If you need to delete the schedule click the delete  icon.
  5. Click Alert envelope to setup the Process Alert
Alert
If the job is linked to another job you will not see any records in the Show Upcoming section.

Process Alert

Process Alert notify you of key pieces of information for the task depending on the status; Unconditional, Successful, or Failed. Process Alerts are a great way to stay proactive within your system.

  1. Click on the "Alert" Envelope  located beside the "Schedule is active" checkbox and a Process Alert window will appear.

  2. Enter the name of the Alert.
  3. Select from the drop down menu whether the alert should be sent unconditionally, if the job runs Successfully, or on Failure.

  4. Enter the from email address to match the DefaultDeliveryProfile setup in your instance.
  5. Enter the email address that the processing alert is to be sent to. 
    NotesNote: You can verify the email address by clicking on the  "Validate Email" button .
  6. Enter any CC recipients in the "CC" field, and separate multiple addresses by semi colons.
  7. Enter the subject of the email.
  8. Enter the body of the email message.
  9. Place the cursor where you wish to add an alias.
    1. Select the alias from the drop down menu.
      EndTime - {EndTime} is Job Ending Time
      JobLog - {JobLog} is the job log messages
      JobName - {JobName} is Job {FileName} 
      JobStatus - {JobStatus} is Job Status e.g Pending, Running, Succeeded, Failed, Cancelled, SysCancelled
      StartTime - {StartTime} is Job Starting Time

    2. Click the Insert  button.
  10. If you need to have more than one alert set up with different criteria for a given job, select the "Select Other" button  which will prompt a dialog box asking if you want to keep changes for this alert. 

  11. By clicking "OK" you will be brought to the process alert lister screen, allowing you to add multiple alerts and edit any existing alerts.


  • Click the  Save button, the changes will be saved and the Edit Schedule window will close.
  • To cancel any of the current changes you have made, click the  Cancel button. This will close the Edit Schedule window without saving any changes.

Show Upcoming

By clicking the Show Upcoming  button you will see all upcoming scheduled and the most recently ran jobs for this section of your system.

Alert
If the job is linked to another job you will not see any records in the Show Upcoming section.



  1. ID - this is the jobID; can be referenced on the Process History screen
  2. Name - name of the job
  3. Start - day and time the job started; can be referenced on the Process History screen
  4. Status -
    1. Pending - job will run at a future date
    2. Succeeded - job ran successfully but may or may not have errors found within the job log
    3. Failed - job did not complete due to an error
    4. SysCancelled - job was cancelled

Clicking on the status of jobs that have already ran will display a popup with the job log.


Alert
You will start to see some screens now say Show Instance and have a different view. We are in the process of updating all of our scheduling screens to this new view. See below for more information

Show Instances

Clicking the Show Instances  button will display a popup with a tab for Recent (the most recently ran jobs) and Upcoming (shows all upcoming scheduled jobs) for this section of your system.

  1. ID - this is the jobID; can be referenced on the Process History screen
  2. Name - name of the job
  3. Start - day and time the job started; can be referenced on the Process History screen
  4. Status -
    1. Pending - job will run at a future date
    2. Succeeded - job ran successfully but may or may not have errors found within the job log
    3. Failed - job did not complete due to an error
    4. SysCancelled - job was cancelled

Under the Recent tab, clicking on the status of jobs that have already ran will display a popup with the job log.


Under the Upcoming tab you will see jobs that are schedule to run at a future time.




Copyright 2019
Revised 11.07.2024
    • Related Articles

    • 5.1.36 - Make Client Filter a Required Field for DW Exports

      Version: 5.1 Patch: 036 Title: Make Client Filter a Required Field for DW Exports Application Category: Reports; Other Patch Type: Bug Description: Data Warehouse & Flattened Data Warehouse exports need to have clients selected in order for client ...
    • R20.3 p2 - Added types for categorizing Call Dispositions for Reports and/or Exports

      Version: 5.1 Release Number: 20.3 Patch: 2 Title: Added types for categorizing Call Dispositions for Reports and/or Exports Application Category: Other, Order Entry Patch Type: Feature Description: Created new optional feature to allow Call ...
    • 5.1.229 - Updated Export Processing Screen

      Version: 5.1 Patch: 229 Title: Updated Export Processing Screen Application Category: Other; Export Processing Patch Type: Feature Description: Updated Export Processing screen. Updated UI controls and refined how scheduling interface works.  ...
    • Export Archive

      Module: Export Archive Topic: Module Overview Version(s): Version 5.1 and up  Editions: Standard, Commerce, Call Center Navigate to Processing>Import/Export>Export Archives. The Export Archives page contains a list of all exports you have run and has ...
    • Trouble Shooting How To's

      There are times the OMS will not respond the way in which you are expecting. Use the following links to resolve these events: Exports Export delivery via sFTP, FTPS or FTP Failing Export Error: Server error 4: Failure Exports-String or Binary Data ...