The Schedule module is the main module of ONIXEDIT Scheduler. You can define as many different schedules as you want. Each schedule is dedicated to deliver metadata files and, optionally, asset files to your trading partners according to a specific frequency.

To create a new schedule, click on the New button in the tool bar above the Schedule list:

You should see this screen:

At the top of the form, you will fill the Schedule name and when the schedule should be executed. You must at least define the Schedule name, a beginning date and the frequency at which you want the schedule to be executed. Optionally, you can also set an end date or the number of occurrences after which the schedule will be automatically deactivated.

You must also select a Source Catalogue from your ONIXEDIT Server:

The following screen capture defines an active schedule to transmit metadata from the ONIX 2.1 catalogue "BIG" that will be executed three times starting from 2015-06-01 at the first of each month:

Default Metadata

The Default Metadata section is where you will define the type and format of metadata files that will be delivered to your partners (Recipients):

• Metadata File Type:
• If the Source is an ONIX 2.1 catalogue, you will have the choice between ONIX2 (to produce ONIX 2.1 files), ONIX3 (to automatically convert your ONIX 2.1 titles into ONIX 3.0) or Script (to export your metadata to a text or Excel file using an ONIXEDIT import/export script). If you choose ONIX3, you should be aware that the automatic conversion from ONIX 2.1 to ONIX 3.0 may produce invalid ONIX 3.0 titles even if your ONIX 2.1 titles are 100% valid. To be sure that the automatic conversion will produce valid ONIX 3.0 files, you must activate the option "Validate ONIX 3.0 mandatory elements" in your ONIXEDIT Server settings for ONIX 2.1 catalogues:
  
• If the Source is an ONIX 3.0 catalogue, you will have the choice between ONIX3 (default) or Script (to export your metadata to a text or Excel file using an ONIXEDIT import/export script).
• ONIX Format: You have the choice to produce ONIX files in Short or Long (Reference) tags. Ask your trading partner which format is required.
• ONIX 2.1 Export Format: If the Metadata File Type is ONIX2, you have the choice to produce metadata files corresponding to a specific format supported by ONIXEDIT. Refer to ONIXEDIT User Manual for details.
• ONIXEDIT Export Script: This will be activated only if the Metadata File Type selected is "Script". In that case, you must provide a valid ONIXEDIT import/export script that will be automatically applied by ONIXEDIT Scheduler at runtime. Using an export script, you will be able to provide metadata to your partners in a flat file (tabulated, fixed length, CSV or Excel). Refer to ONIXEDIT User Manual for details.
• Maximum titles in each file: When working on large ONIXEDIT catalogues, the resulting ONIX or Flat files may be huge. Working with huge files is not recommended because it will be much more slower to produce and will require more memory from your ONIXEDIT Scheduler Windows Service (if installed on your own server). It may even cause it to crash in extreme situation. By default, ONIXEDIT Scheduler suggest to produce files having a maximum of 50000 titles in it. Thus, if your schedule should produce metadata files having 100000 titles, then the recipient will receive 2 files of 50000 titles each. Each file will be generated simultaneously with 2 different Windows Service processes. It will then take half the time to finish than if you set this parameter to 0, which is the value to indicate to always produce a single file.  
• Compression option: By default, ONIXEDIT Scheduler suggest to compress metadata and asset files generated into an archive file (.zip). The files produced will be smaller and faster to transmit. But you can set it to "None" if you don't want to archive those files.
• XML Header (FromCompany, FromEmail, FromPerson): By default, you can leave those fields blank and ONIXEDIT Scheduler will fill the header section of each ONIX file produced, with information coming from your ONIXEDIT Server account. But you can override these default values if you want.

After having filled those fields, you should now save your new schedule and complete it with recipients. Indeed, a schedule must be Active prior to be executed by ONIXEDIT Scheduler. By default a schedule is not active.

To activate a schedule, you must first Save it and add at least one Recipient to it.

To do so, click on Save and Close:

You will stay in your new schedule record and new sections will appear in the form:

Recipient(s)

You must provide at least one recipient for each new schedule prior to make it active.

If the Recipient you want to assign to a schedule is already defined from the Recipient module, just click on the Link button in the tool bar above the Recipients list:

You will then see a list of available recipients. Just select the ones you want to assign to your schedule and click OK:

You should then see the selected recipients in the Recipient(s) list of your schedule:

You can also create a new Recipient directly from your schedule by clicking on the New button:

You will then see the Recipient Form. Refer to Recipients section for more information on its usage:

Search Criteria

The Search Criteria section is optional. If you leave it blank, the schedule will produce metadata files having the complete set of titles coming from the selected ONIXEDIT Server catalogue. But of course, you can reduce the result set to select only the titles you want to deliver to your partners. Click on the New button in the Search Criteria grid to add a new criterion. You should see this screen:

The Schedule field is set automatically with the name of the current schedule. Use the other fields to define your search criterion. When completed, click on Save and Close.

If you want to transmit only updates (new or modified titles) since last transmission of the current schedule, you can use the special field "Last modification date" combined with the operator "Greater than last transmission":

If you want to be sure that only valid ONIX titles will be sent, then add this criterion:

You can even add a criterion using your own custom fields:

As an example, the following criteria will produce metadata having only valid titles with Custom Field "Revision_Status" equals to "Completed" that have been modified or added since last transmission:

At any time, you can find out how many titles the schedule will produce by clicking on the "Get Title Count" button in the toolbar:

You can also test a schedule at any time. To do so, enter your email address as indicated below, and press on the green button:

The schedule will be placed in a test queue to be processed by the scheduler agent. Once completed, you will receive the transmission report by email. Because it is a test, the metadata file won't be uploaded to the FTP server defined in the schedule. However, you will find, at the bottom of the report, a section automatically added with a link that you can use to download the resulting metadata file if you want to verify it:

Activate a schedule

Once your schedule is defined and tested, you can activate it and let ONIXEDIT Scheduler deliver your metadata to your partner.

1- Edit the schedule you want to activate.

2- Check the "Schedule Active" checkbox and click on Save and Close:

Your new schedule is now ready for processing.

Forcing a schedule to execute

If you want to force a schedule to execute as soon as possible, open it and click on the "Send this schedule now" button at the right of the tool bar:

You should get this message: