Custom Program Wizard Import Format

NOTE For general information on using imports, see Imports FAQ.

The following tables list the format for importing header and trailer records in Custom Program Wizard Import.

Header Record

Column

Position

Field

Maximum Length

Format

Required

Description

A

1

Record Type

3

Character

Yes

Enter HDR to indicate the record is a header record.

B

2

File/Report Name

256

Character

Yes

If the custom program does not use Crystal Reports, enter the file name for the custom program, including the .p file extension.

If the custom program uses Crystal Reports, enter the custom report name (as set up in Custom Report Maintenance).

C

3

Type

11

Character

No

Enter Crystal or Non-Crystal to indicate whether the custom program is for a Crystal Reports form or other program. If this field is blank, it defaults to Non-Crystal.

D

4

Menu Description

45

Character

Yes

Enter the text you want to appear as the menu for the custom program.

E

5

Screen Title

40

Character

Yes

Enter the text you want to appear in the title bar of the window for the custom program.

F

6

Default Output

7

Character

No

Enter one of the following default methods for outputting data for the custom program:

  • Screen

  • File

  • Printer

  • Email

  • Excel

If this field is blank, it defaults to Screen. This is selected by default on the Report Options tab of the window associated with the custom program.

G

7

Notes

10000

Character

No

Enter basic instructions on how to use the custom program. The notes you enter in this field appear at the bottom of the custom window generated for the custom program. You can use this field to store instructions for the custom program that users will see when using it.

H

8

Output Extension

3

Character

Yes, only if Non-Crystal is entered for the Type field (position 3).

Enter a file extension for output text reports. This field is only used if Non-Crystal is entered for the Type field (position 3).

I

9

Allow Default Access

3

Character

No

Enter No to prevent all users from having access to the custom program from the menu. If this field is blank, it defaults to Yes.

J

10

Print Button Label

7

Character

No

Enter one of the following to specify the label to display in the ribbon for the custom window:

  • Print

  • Process

  • Import

  • Export

If this field is blank, it defaults to Print.

EXAMPLE If the custom window is for a report that users will print, enter Print.

Trailer Record

Column

Position

Field

Maximum Length

Format

Required

Description

A

1

Record Type

3

Character

Yes

Enter TRL to indicate the record is a trailer record.

B

2

Name

60

Character

Yes

Enter a unique label you want to display for the input parameter field in the window associated with the custom program.

C

3

Parameter Order

2

Integer

No

Enter an input parameter order number (1, 2, 3, etc.). Enter 0 only for a field you want to display that is not an input parameter. You can enter 0 to create a field associated with another input parameter, such as a customer name associated with a customer code input parameter. If you enter a value greater than 0 in this field, it must be unique for the custom program.

Example Your custom program uses one input parameter for a customer code. You enter 1 for the parameter order for this input parameter. You also want to display the customer name associated with the customer code. Enter 0 for it.

D

4

Data Type

9

Character

No

Enter one of the following data types for the input parameter field:

  • Character - Create a field into which a user can enter text.

  • Date - Create a date field into which a user can enter a date, or select a date from a calendar.

  • Logical - Create a check box that a user can select or clear.

  • Numeric - Create a field into which a user can enter numeric values.

If this field is blank, it defaults to Character.

E

5

Length

3

Integer

Yes, only if Character is entered for the Data Type field (position 4) and no related field is entered for the Related Field field (position 22)

Enter the maximum number of characters that can be entered in the field. This field is only used if you enter Character for the Data Type field (position 4). This field defaults to the length of the database field entered for the Related Field field (position 22).

F

6

Default Value

256

Character

No

Enter a default value for the field. If you enter Logical for the Data Type field (position 4), this must be Yes or No.

G

7

Screen Sequence

2

Integer

No

Enter a unique number to indicate the display order of the field in the custom window. Lower numbers are displayed first.

H

8

Integer Places

1

Integer

Yes, only if Numeric is entered for the Data Type field (position 4)

Enter the number of integer places for the field. This field is only used if you enter Numeric for the Data Type field (position 4). This field defaults to the number of integer places of the database field entered for the Related Field field (position 22).

I

9

Decimal Places

1

Integer

No

Enter the number of decimal places for the field. This field is only used if you enter Numeric in the Data Type field (position 4). This field defaults to the number of decimal places of the database field entered for the Related Field field (position 22).

J

10

Use Thousands Separators

3

Yes/No

No

Enter No to not include thousand separators in the numeric values in the field. If this field is blank, it defaults to No. This field is only used if you enter Numeric for the Data Type field (position 4). If this field is blank, it defaults to Yes.

K

11

Use Drop Browser

3

Yes/No

No

Enter Yes to include a Lookup button to the right of the field that allows the user to select a value for the field from a Lookup window. This field is only used if you enter Character or Numeric for the Data Type field (position 4). If this field is blank, it defaults to No.

L

12

Use Standard Browser

3

Yes/No

No

Enter Yes to use a standard Lookup window for the field. This field is not used if you enter Yes for the Allow Multiple Choices field (position 18). This field is only used if Yes is entered for the Use Drop Browser field (position 11). If this field is blank, it defaults to No.

M

13

Standard Browser

50

Character

Yes, only if Yes is entered for the Use Standard Browser field (position 12)

Enter a valid name of a standard Lookup window. This field is only used if you enter Yes for the Use Standard Browser field (position 12).

Note To determine the name of a Lookup window, navigate to it in Apprise, and select Help Lookup Information. The Lookup Information dialog box appears and displays a Lookup value that you can use for the input parameter.

N

14

Valid Values List

3

Yes/No

No

Enter Yes to require the user to enter a value from a list of valid values. This field is only used if you enter Yes for the Use Drop Browser field (position 11) and do not enter Yes for the Use Standard Browser field (position 14). If this field is blank, it defaults to No.

O

15

Syntax

10000

Character

No

Enter the syntax for the Lookup window. This field is only used if you enter Yes for the Use Drop Browser field (position 11), and only available if you do not enter Yes for the Valid Values List and Use Standard Browser fields (positions 14 and 12).

P

16

File Dialog

3

Yes/No

No

Enter Yes if the field will store a file name, and you want to allow users to be able to select a file from a separate dialog box. This field is only used if Character is entered for the Data Type field (position 4). If this field is blank, it defaults to No. You cannot enter Yes for this field and the Folder Dialog field (position 17).

Q

17

Folder Dialog

3

Yes/No

No

Enter Yes if the field will store a folder path, and you want to allow users to be able to select a folder from a separate dialog box. This field is only used if Character is entered for the Data Type field (position 4). If this field is blank, it defaults to No. You cannot enter Yes for this field and the File Dialog field (position 17).

R

18

Allow Multiple Choices

3

Yes/No

No

Enter Yes to allow the user to select multiple choices. If you enter Yes, you must define a list or query for the values from which the user can select. The user will be able to add values to and from a grid of selected values. They can also use the Shift and Ctrl keys to select multiple values. This field is only used if you enter Character or Numeric for the Data Type field (position 4) and enter Yes for the Use Drop Browser field (position 11). If this field is blank, it defaults to No.

S

19

Clear After Print

3

Yes/No

No

Enter Yes to reset the field to the default value after printing a report. If this field is blank, it defaults to No.

T

20

Supports Dot Notation

3

Yes/No

No

Enter Yes to allow the user to enter an abbreviated number for order, invoice, or bill of lading numbers.

EXAMPLE If sales order number NJ000000001 exists and this field is Yes for an order number field, users can type NJ.1 in the field.

If this is Yes for a field with a length of 13 or greater, the field will behave like the order, purchase order, work order, and invoice number fields in Apprise. If this field is Yes for a field with a length of 17 or greater that has a related table of bol-hdr, it will behave like the bill of lading number fields in Apprise.

This field is only used if Character is entered for the Data Type field (position 4). If this field is blank, it defaults to No.

U

21

Related Table

40

Character

No

Enter a database table related to the field. This field is not used if you enter a standard Lookup window for the Standard Browser field (position 13).

V

22

Related Field

40

Character

No

Enter a database field related to the field. This field is not used if you enter a standard Lookup window for the Standard Browser field (position 13).

W

23

Related Parameter

60

Character

No

Enter a parameter related to the field. This field is only used if you do not enter Yes for the Allow Multiple Choices field (position 18).

X

24

Validate

3

Yes/No

No

Enter Yes to verify that values entered or selected for the input parameter field exist in the related database field. This field is only used if you enter a related table and field. If this field is blank, it defaults to No.

Y

25

Required

3

Yes/No

No

Enter Yes to make the field a required field. Required fields appear in red font. If this field is blank, it defaults to No.

Z

26

Disabled

3

Yes/No

No

Enter Yes to disable the field. If this field is blank, it defaults to No.

AA

27

Related Toggle

60

Character

No

Enter a related logical parameter. This field is only used if you do not enter Yes for the Disabled field (position 26).

Example If you created an All Customers parameter, you would enter it in this field for a Customer Code parameter.

AB

28

Enable When Checked

3

Yes/No

No

Enter Yes to enable the field for the parameter only when the check box for the related logical parameter is selected. This field is only used if a related logical parameter is entered for the Related Toggle field (position 27). If this field is blank, it defaults to No.

Import Format Notes