In this section: |
These topics describe how to modify your server and communications configuration files.
The following attributes enable you to provide descriptive information about tables and columns.
Is an optional attribute for documenting tables.
Is an optional attribute for documenting columns.
Is an optional attribute for supplying an alternate column title on a report to replace the FIELDNAME value, which is normally used.
For the server, client tools using the API or ODBC will not use the TITLE attribute. The TITLE attribute is available only when directly querying the server catalog.
How to: |
The REMARKS attribute enables you to document a table.
The syntax is
REMARKS=text ,$
where:
Is one line of text. It can consist of a maximum of 78 characters. If the text contains a comma, you must enclose the text in single quotation marks.
The REMARKS attribute cannot span more than one line in the Master File. If necessary, move the entire attribute to a line by itself.
The following example shows how to document the Oracle table SAMPLE.
FILE=SAMPLE,SUFFIX=SQLORA,REMARKS=This is a sample Oracle table.,$
How to: |
The DESCRIPTION attribute enables you to provide a comment for a column in a table.
You can also add documentation to a column declaration—or a segment or table declaration—by typing a comment following the terminating dollar sign. You can even create an entire comment line by inserting a new line following a declaration and placing a dollar sign at the beginning of the line. For the server, a comment added in this manner will not be available to any client application.
If you are using DEFINE fields in a Master File, you must place the DESCRIPTION attribute on a line by itself. The semicolon after the DEFINE must appear on the same line as DESCRIPTION=.
The syntax is
DESC[RIPTION]=text ,$
where:
Is one line of text. It can consist of a maximum of 44 characters.
If the text contains a comma, you must enclose the text in single quotation marks.
The DESCRIPTION attribute cannot span more than one line in the Master File. If necessary, move the entire attribute to a line by itself.
Note: Whenever possible, place the description on the same line with the attributes FIELDNAME and ALIAS, to conserve space.
The following example shows how to provide a description for the column UNITS. The single quotation marks are required because the description contains a comma.
FIELD=UNITS,ALIAS=QTY,FORMAT=I6,DESC='This is quantity sold, not returned',$
The following example shows how to provide a description for the DEFINE field ITEMS_SOLD.
DEFINE ITEMS_SOLD/D8=ORDERED-INVENTORY ;DESC=DAMAGED ITEMS NOT INCLUDED,$
How to: |
When you generate a report, each column title in the report defaults to the name of the column as it appears in the table. However, you can change the default column title by specifying the TITLE attribute.
For the server, client tools using the API or ODBC will not use the TITLE attribute. The TITLE attribute is available only when directly querying the server catalog, or when using WebFOCUS (Windows version).
You can override both the FIELDNAME and TITLE attributes with AS phrases in your report request. To override an existing TITLE attribute, use the SET TITLE command. To control whether the TITLE attribute is propagated in the Master File of a HOLD file, use the SET HOLDATTR command.
The TITLE attribute has no effect in a report if the column is used with a prefix operator such as AVE. You can supply an alternate column title for columns with prefix operators by using the AS phrase.
If you are using DEFINE fields in a Master File, you must place the TITLE attribute on a line by itself. The semicolon after the DEFINE must appear on the same line as TITLE=.
The syntax is:
TITLE='text' ,$ TITLE='text,text,...' ,$ TITLE='text /' ,$
where:
Is any string that consists of a maximum of 64 characters.
You can split the text across as many as five separate lines. Use single quotation marks to delimit the text, and commas to divide the text into separate lines on the report output.
You can include blanks at the end of an alternate column title by entering a slash (/) in the last position that will be blank, followed by a closing single quotation mark.
The TITLE attribute cannot span more than one line in the Master File. If necessary, move the entire attribute to a line by itself.
The following example shows how to replace the default column title, LNAME, with a title of Client Name.
FIELD=LNAME,ALIAS=LN,FORMAT=A15,TITLE='Client Name',$ Client Name -----------
The following example shows how to replace the default column title, LNAME, with a two- line column title of Client Name.
FIELD=LNAME,ALIAS=LN,FORMAT=A15,TITLE='Client,Name',$ Client Name ------
The following example shows how to control the length of the underline for an alternate column title.
FIELD=LNAME,ALIAS=LN,FORMAT=A15,TITLE='Client,Name /',$ Client Name ---------------
The following example shows how to replace the default column title for the DEFINE field, ITEMS_SOLD, with a two-line column title of Items Sold.
DEFINE ITEMS_SOLD/D8=ORDERED-INVENTORY ;TITLE='Items,Sold',$ Items Sold -----
The HELPMESSAGE attribute enables you to specify an online help message for a field on a data entry screen. It is available only for FOCUS data maintenance applications.
How to: |
Messages specified with the HELPMESSAGE attribute appear in the TYPE area of the CRTFORM when you:
Regardless of the condition that triggers the display of the help message, the same message will appear.
The syntax is
HELP[MESSAGE]=text ,$
where:
Is one line of text. It can consist of a maximum of 78 characters.
You can use all characters and digits. If the text contains a comma, you must enclose the text in single quotation marks. Leading blanks are ignored.
The HELPMESSAGE attribute cannot span more than one line in the Master File. If necessary, move the entire attribute to a line by itself.
The following example shows how to display a help message when the DEPARTMENT value is other than MIS, PRODUCTION, or SALES. DEPARTMENT has an ACCEPT attribute which tests values entered for it.
FIELDNAME=DEPARTMENT,ALIAS=DPT,FORMAT=A10, ACCEPT=MIS PRODUCTION SALES, HELPMESSAGE='DEPARTMENT MUST BE MIS, PRODUCTION, OR SALES',$
If you enter a value other than MIS, PRODUCTION, or SALES for DEPARTMENT on a CRTFORM, both the default message and help message display on the screen:
DATA VALUE IS NOT AMONG ACCEPTABLE VALUES FOR DEPARTMENT DEPARTMENT MUST BE MIS, PRODUCTION, OR SALES
The following example shows how to display a help message when a format error occurs in HIRE_DATE. Note that the format for HIRE_DATE is integer.
FIELDNAME=HIRE_DATE,ALIAS=HDT,FORMAT=I6YMD, HELPMESSAGE=THE FORMAT FOR HIRE_DATE IS I6YMD,$
If you enter alphanumeric characters for HIRE_DATE on a CRTFORM, both the default message and help message display on the screen:
FORMAT ERROR IN VALUE ENTERED FOR FIELD HIRE_DATE THE FORMAT FOR HIRE_DATE IS I6YMD
iWay Software |