Defining Interfaces
Select “Define Interface” link from the left pane.
The “Define Interface” page appears.
The system displays the date format applicable to the login user.
Select or enter the following:
Interface Definition Unit |
Select the organization unit where the Data Transfer Setup component is deployed. |
Interface Group Description |
From the drop-down list box, select the interface group to which the interface must belong. |
|
When you select the interface group description, the “Interface Type” automatically displays either “upload” or “download”, depending on whether the interface group type is Upload or Download. |
Interface Code |
Enter a unique code to identify the interface. |
Interface Description |
Enter the description of the interface. |
Interface Method |
Select the method of data transfer in the interface. The options available are “BCP“ (Bulk Copy Processing), “ASCII“ or “Direct“.
At present, only the ASCII method is operative. |
Inactive |
Select the check box if you need to disable the interface. |
ASCII File |
Select the path of the ASCII file, which is the source file during data upload and the destination file during data download |
Purge File |
Enter the path of the purge file. The purge file is used to store data from the temporary tables, before data is cleared or deleted in the temporary tables. You can refer to these purge files, in future, if required. |
Column Delimiter |
Select the column delimiter from the drop-down list box. The options available are comma, enter char, new line, single quotes, space, tab and tilda. |
Row Delimiter |
Select the row delimiter from the drop-down list box. The options available are comma, enter char, new line, single quotes, space, tab and tilda. |
Download Procedure |
Enter the download procedure used to download data from application tables to ASCII files. |
Download Table |
Select the download table that is an intermediate table, used to store data fetched by the download procedure. |
Conversion Procedure |
Enter the name of the conversion procedure used to convert data from ASCII format to SQL format while uploading (interface type is upload) and from SQL format to ASCII format while downloading(interface type is download). |
Conversion Table |
Select the conversion table that is an intermediate table, used to store data fetched by the conversion procedure. |
Validation Procedure |
Enter the validation procedure used for performing functional validations of data and data type validations. |
Validation Table |
Enter the validation table that is an intermediate table, used to store data fetched by the validation procedure. |
Error Log |
Enter the name of the error log file that is used to log errors during upload. Examples of errors may be validation errors, data type mismatch etc. |
Upload with check |
Select the check box, if you wish to upload the records only after receiving manual confirmation and correction in case of error messages |
Updation Procedure |
Enter the name of the updation procedure used for updating data into SQL tables or application tables. |
Select or enter the following:
Schedule |
Select the schedule for data transfer. The options available are daily, weekly and non-recurring. Select
|
If non-recurring specify date/time |
Enter the date and time of data transfer, if the schedule selected above is non-recurring |
Day of week |
Select the day of the week in which data transfer must occur if the schedule is recurring. Recurring refers to a schedule that is either daily or weekly. |
Period Type |
Select the period type. The options available in the drop-down list box are “At” and “Every”. If you select “At” you need to specify the time; the data transfer will occur exactly at this time. For example if period type is “At” and “At” = 6.00 pm, the data transfer occurs exactly at 6.00 pm. If the Period Type is “Every” the data transfer will be recurring with respect to the time period mentioned. For example if period type is “Every” and “Every” = 5 hours, then the data transfer recurs every 5 hours. |
At |
Enter the time of data transfer, if the period type selected above is “At” |
Every |
Enter the time period in which the data transfer must recur, if the period type selected above is “Every” |
Comments |
Enter the comments related to this page. |
Select the “Save interface ” pushbutton, to save the entries selected or entered above.
Select “Specify Parameters For Download”, to specify the input parameters required for downloading.
Select “Specify Procedures For Upload”, to specify the names of the procedures for uploading.
Select “Specify User Permissions”, to specify the user permissions for the login user to update the records during data transfer.
6 Hyperlinked topics below
Use this page to define an interface