Click here to view the Web Services menu.

Click here to view the complete Optifacts User Documentation Index.

Click here to contact us.

Introduction

This document provides instructions for setting up the Web Services Editor and Job Status table for configuring the sending times. Currently, we send USAGE for DRP and other data using sftp. Web Services is another of communicating instead of sftp.

Procedure

Web Services Send Editor

Use this editor to set up the different types of data that you want to send.

From the Optifacts Main Menu:

Select Option 3 – Editor Utilities and press Enter.

Select Option 22 – Web Services Send and press Enter.

The Web Services Editor screen is displayed.

• Press 'Q' to Query the table.
• Enter some search criteria in any of the fields.
• Press Escape to perform the search.

If the table does not exist:

• Press 'A' to add a new record.
• Enter all the information as required. (Refer to the field definitions below)
• Press Escape to save the data.
• Press 'E' to exit the screen.

Field Definitions

Data Set – Used by jstatus, ofdemon, or other programs in deciding whether it needs to output data. (IE: USAGE, DELTA)

Method – Determines how the data are delivered. (IE: POST, PUT, GET). Inside of the restful communications, there are different methods – you are most likely going to use POST and GET.

• POST – Post data at the receiving site.
• PUT – Puts data at the receiving site.
• GET – Retrieves data from the receiving site.

Content Format – Output File Content-Format. (IE: DRP, JSON, OPTI2.8, and others.). How the contents of the file get laid out.  (IE: DRP for Oracle Usage, delimited for Delta status)

Content-Type – Content-type to include in http header. (IE: txt, json, csv, jpeg, pdf, multipart/form-data.) How the content of the packet of info we send gets laid out. (IE: multipart/form-data application/json)

Send in Sequence – Instructs the system to deliver in the date/time sequence of their creation.

• Enter 'Y' to send in sequence with a timestamp.
• Enter 'N' to send not sequenced, and we do not need to wait for a response.

Secure Connection – Determines whether to send as a secure connection.

• Enter 'Y' secure (https)
• Enter 'N,' not secure (http)

DNS/IP (URL) /IP (URL) – The DNS or IP address of the receiving site. This is the first part of the URL.

Port (URL) – The port on the receiving server. This is the second part of the URL.

End Point (URL) – Send to function. Where to point to on the receiving server. (IE: file_transmit) The final part of the URL.

Receive Directory – Send-to (receiving) directory path. The directory path for where the data is to go.

API Token – Token for a secure connection. Part of the header. The receiving side validates the token before processing the data.

Comment – What type of site is consuming the file? (IE: Oracle.)

Data Sending Times Set-up

From the Optifacts main menu:

Select Option 11 – Retail Transfer and press Enter.

Select Option 7 - Editor: Job Status Set-up and press Enter.

The 'ret_mail' table displays.

• Press 'Q' to Query the table.
• Enter some search criteria in any of the fields.
• Press Escape to perform the search.

If the table does not exist:

• Press 'A' to add a new record.
• Enter all the information as required. (Refer to the field definitions below)
• Press Escape, to save the data.
• Press 'E' to exit the screen.
• Press 'Ctrl-C' to exit the screen without saving the data.

Field Definitions

Account Code - Enter '0' (zero) for all accounts or enter a specific account number or identifier. (IE: DELTA, USAGE) Type spaces to keep the entry to the right.

Module Name - Enter the module name to report: (L: Lookup, S: Statement, or B: Both)

VE Web Number - Vision-Ease Web Assignment Number (Call Optifacts to obtain this number)

Show Notes - Enter 'Y' to include Notes in Job-status reporting.

Show History - Enter 'Y' to include Job History in Job-status reporting.

Show Delays/Breakage (D/B/E/N) - Show History in red: 'D' Delays,' 'B Breakage, 'E' Either, 'N' None.

Show Invoices - Display Invoices in 'L' Lookup, 'S' Statements, 'E' Either, 'N' None.

Days of Mailout - The number of days to include for mailed or canceled jobs.

Begin Time - Enter '0' (zero) if No Sending is to occur on this day. Use the 24-hour clock (IE: 1630 is 4:30 PM).

End Time - Enter Time to stop sending. Use the 24-hour clock (IE: 1630 is 4:30 PM).

Minutes Between Transfers - The interval between sends in minutes. Enter '0' (zero) to only transmit once this day.

Examples

The following examples provide you with details about the different types of data that we send.

The following set up sends the data starting at 8:00 AM with an interval of 2 minutes on Monday through Saturday. The times entered on Sunday indicate that no data gets sent on that day.

The following set sends Usage data Tuesday to Friday from 7:00 AM to 11:00 PM with an interval of 1 minute. Usage data gets sent on Saturday, Sunday, and Monday from 7:00 AM to 11:00 PM at an interval of 20 minutes.

The following set up sends a job status to VisionWeb. The Begin Time indicates the time of the first report to be sent at 7:00 AM with an interval of 20 minutes on Sunday through Saturday. The end time indicates that no report gets generated after 11: 00 PM until 7:00 AM the next day.

The following set up sends a job status from lab to lab, which appears in Quick Lookup. The Begin Time indicates the time of the first report to be sent at 1:00 AM with an interval of 2 minutes on Sunday through Saturday. The End Time indicates that no report gets generated between 12:00 AM and 1:00 AM the next day.

The following set up sends a job status fax report to account 42230 Monday to Friday at 10:30 AM and another at 4:30 PM. The Begin Time indicates the time of the first report to be sent with an interval of 360 minutes before it is sent again at 4:30 PM. The End Time indicates that no report gets generated past 5:00 PM until 10:30 AM the next day.

The following is an example of a job status report printed at the receiving site.

To view and, or download these instructions as a PDF file, click on the following document image.

Click here to return to the top of the page.