Click the New icon in the toolbar to save the current RESTful export specification and then reset the page for new data entry.

Click the Save icon in the toolbar to save the current RESTful Interface specification and return to the export specifications listing.

Click the Save As icon in the toolbar to save the current RESTful Interface specification to a new name. You will be prompted to enter a new name. Click OK to save the export to a new name and then continue editing the export. Click Cancel to return to the existing export without saving.

Click the Delete icon in the toolbar to delete the current RESTful Interface specification. You will be prompted with a "Are you sure you want to delete?" dialog. Clicking Yes will permanently delete the export and then return to the export specifications listing. Click Cancel to return to the existing export without deleting.

Click the Test icon in the toolbar to test the RESTful Web Interface and display the results of the data selection as defined using the data selection criteria and any parameters. This will perform a sample data extract using all of the information entered and then output the results to the screen where it can be viewed and validated. Typically a test is performed to ensure that the correct data fields are being extracted and all data conversions, formats, and formulas are working correctly.

After clicking the Test icon, you will see a dialog requesting additional information:

• Export file to test: Select one of the export data files to use in the test. The first export data file entered is selected by default. Note, this prompt will only be available if multiple data export files have been entered on the export specification.
• Sample Number of records: Defaults to 100. This number determines how many records are processed and exported to the screen.
• Record IDs to export: If you want to test individual records, enter one or more item ids separated by commas. Entering a value here overrides the sample number of records.
• Dynamic Parameters: There may be one or my dynamic parameters (e.g., Customer, Part Number, etc) shown in the Test dialog if any have been defined, enter valid data into those fields to qualify the data selection.

Click the OK button to view the results or click the Cancel button to return to the RESTful Interface specification page.

note

WidgetNote

For this feature to work correctly you will need to: 1) Add the Kourier website as a trusted site so pop-up dialogs appear and 2) enable the automatic prompting for downloads option in your browser's internet options (e.g., for Internet Explorer this setting is found in Security | Custom Level dialog). 

 

Click the Get URL icon in the toolbar to generate an URL that will be used to provide call the RESTful Web Service and return the defined information. You will be prompted for the same information as when using the Test command above. After pressing the OK button you will be presented with a new window with two options for how to call the RESTful Web Service :

1. Use the link provided o call the Kourier RESTful Web Interface in your application. Copy this complete URL link shown and use it to call the Kourier RESTful Web Interface from within your application.
2. Post form data to a specified URL to call the Kourier RESTful Web Interface. Copy the URL provided and the list parameters to call the Kourier RESTful Web Interface in your application.

Click the Help balloon to open the help for this page.

Field Name

Description - Usage - Notes

Name

Enter a unique name for the export. By convention, exports are named using an Integration ID such as KS for KommerceServer, followed by an underscore and a string that describes its purpose (e.g., KS_CONTACTS). 

Title

Enter a short descriptive name for this export. This name is displayed in on-line lookups.

Export Format

Enter the export format. If the export verb is KEXPORT, the possible choices are shown below.  Other export verbs (normally user-written BASIC programs)  may or may not support these formats.

Last Update

Display only field, shows the last date/time that the export specification was saved.

Note

Enter a free form comment or note for this Export Specification. If a note is entered, a small icon will display on the Export Specification listing. Hovering your mouse over the icon will display about 40 characters of the note.

Select Verb

Enter a valid verb to perform the selection, such as SELECT or SSELECT.

The export processor first processes the selection portion of the screen, and then passes the selected items to the export section. The selection portion of the screen can be used to limit the number of records exported.

Select Data File

Enter the name of the data file to use to select data records for exporting.

 Parameters

Enter the parameters to be used when calling the RESTful Web Service.

Using File

Enter the name of the file that contains the dictionary items referenced in the select statement.

To use the dictionary file with the same name as the data file, leave this field empty. For example, if you enter CUSTOMER as the data file and do not enter a using file, the CUSTOMER dictionary file is used.

To specify an alternate dictionary file, enter DICT and the file name.

To specify a data file that contains dictionary items you want to use, enter the file name.

Select Statement

Enter the selection criteria statement using standard U2 query syntax.

For example, if you want to select all of the CUSTOMER records with PHONE 619], enter WITH PHONE 619] in the Statement field. This field may also contain substitution tags. 

If you are defining a Kourier RESTful Web Service use the Select statement to define the parameters to pass to the Web Service. For example, if you wanted to use the State (attribute F51) and City (attribute F50) as parameters you would need to include those attributes in your defined Line Item Fields, and then use this for the Select statement: WITH F51 = "{%1}" AND WITH F50 = "{%2}"

Export Data Files

Enter the name of the data file to use to export data records. To enter a list of related export files click the drop-down icon.

Note, if more than one file is entered, the field will be disabled (grayed out) and only the primary file name will be displayed, followed by the total number of files in brackets. For example. If the primary file is GL, and there are two additional related GL files, the field will be disabled and display as "GL [3]". Use the drop-down icon to edit the list of files. Refer to the Related Data Files Guide for more information on using this feature.

Using File

Enter the name of the file that contains the dictionary items referenced in the export statement.

To use the dictionary file with the same name as the export data file, leave this field empty. For example, if you enter CUSTOMER as the data file and do not enter a using file, the CUSTOMER dictionary file is used.

To specify an alternate dictionary file, enter DICT and the file name.

To specify a data file that contains dictionary items you want to use, enter the file name.

Export Verb Requires Select List

If enabled, then an active select list (or an empty selection criteria) must be present before the export statement will be executed.  If disabled, the export statement should be processes even if an active select list is not present. 

Export Options

Enter any valid export options.