For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

Note

This configuration guide refers to PreBilt transactions beginning 'PB2_' and details the standard process without additional features or enhancements. You should copy these transactions with a different prefix to maintain a backup and protect the originals.

The guide displays the standard PreBilt screens and gives details of the structures in which the on screen fields can be found. Fields within these structures can be used to customise and enhance the screen. For instructions on how to use structures to find fields, please see Available data structures. For instructions on how to maintain the configuration elements in AMD, please see General configuration elements.

PB2_DOC_CAPTURE_ALL and others

All the document capture transactions are a subset of the PB2_DOC_CAPTURE_ALL transaction.

Selection options

Configuration element
Available structures/fields

SELECT_OPTS

OBJECT_TYPE - Object list from the list OBJECT_TYPE_LIST. OBJECT_KEY - Material number, document number or in case of the material documents, the material document number followed by year.

SELECT_OPTS_ACTIONS

BACK - back to previous screen.

CLEAR_INPUT -clear all input fields.

VAR_CHOOSE – select saved variants.

VAR_SAVE – save the selection entries as a variant.

SELECT – proceed to next screen.

Document list

Configuration element
Available structures/fields

LIST_SUMMARY

Primary: /TCTM/SOFOLENTI1_S Secondary: None

LIST_SUMMARY_ACTIONS

CONTINUE - continues to cycle through the signature=>comments=>images screens. CAPTURE_COMMENT - go to Comment Capture screen. CAPTURE_SIGNATURE - go to Signature Capture screen. UPLOAD_IMAGE - go to Image Capture screen. CAPTURE_IMAGE - open camera on device. BACK - back to previous screen.

LIST_SUMMARY_HEADER

TOTAL_NO_ITEMS - Total number of items.

LIST_SUMMARY_HEADER_EX

n/a

LIST_SUMMARY_SORT

Primary: /TCTM/SOFOLENTI1_S

Image capture

Configuration element
Available structures

LIST_IMAGE_CAP

DOC_TITLE - proposed file (which will be prefixed by value in UTILITY_OPTS and suffixed with the file extension type from IMAGE_CAP_FILE_EXT). CREAT_NAME - Name of user. CREATED_DATE - Create date. CREATED_TIME - Create time.

LIST_IMAGE_CAP_ACTIONS

UPLOAD_IMAGE - Uploading an image from the device folders. CAPTURE_IMAGE - Opening the camera to take a picture. SKIP - Skip/continue without saving. SAVE - Saving the change. BACK - Back to previous screen.

LIST_IMAGE_CAP_HEADER

TOTAL_NO_ITEMS - Total number of items. MAX - Maximum number of items that can be added by transaction. MIN - Minimum number of items required by transaction.

LIST_IMAGE_CAP_HEADER_EX

n/a

Filename popup

Configuration element
Available structures

INPUT_IMAGE_CAP

FILE_NAME_IN - proposed file name for the taken or uploaded picture.

INPUT_IMAGE_UPLOAD

FILE_NAME_IN - proposed file name for the taken or uploaded picture.

IMAGE_FILENAME

Structure of the proposed file name.

IMAGE_CAP_FILE_EXT

Extension to be used for the file.

IMAGE_FILE_TYPE_LIST

List with the allowed image file extensions.

Signature capture

Configuration element
Available structures

LIST_SIGNATURE_CAP

DOC_TITLE - proposed file (which will be prefixed by value in UTILITY_OPTS and suffixed with the file extension type from SIGNATURE_CAP_FILE_EXT). CREAT_NAME - Name of user. CREATED_DATE - Create date. CREATED_TIME - Create time.

LIST_SIGNATURE_CAP_ACTIONS

CAPTURE_SIGNATURE - Opening the popup to allow on screen signature. SKIP - Skip/continue without saving. SAVE - Saving the change. BACK - Back to previous screen.

LIST_SIGNATURE_CAP_HEADER

TOTAL_NO_ITEMS - Total number of items. MAX - Maximum number of items that can be added by transaction. MIN - Minimum number of items required by transaction.

LIST_SIGNATURE_CAP_HEADER_EX

n/a

INPUT_SIGNATURE_CAP

SIGNEE - Signee name. Secondary: /TCTM/TOJTT_S

SIGNATURE_FILENAME

Structure of the proposed file name.

INPUT_SIG_WATERMARK_TEXT

Structure of the proposed file name.

SIGNATURE_CAP_FILE_EXT

Extension to be used for the file.

SIG_FILE_TYPE_LIST

List of extensions that can be used for the file.

INPUT_SIG_WATERMARK_IMAGE

Comments capture

Configuration element
Available structures

LIST_COMMENTS_CAP

DOC_TITLE - proposed file (which will be prefixed by value in UTILITY_OPTS and suffixed with the file extension type from COMMENTS_CAP_FILE_EXT). CREAT_NAME - Name of user. CREATED_DATE - Create date. CREATED_TIME - Create time.

LIST_COMMENTS_CAP_ACTIONS

CAPTURE_COMMENT - Opening the popup to allow comments to be entered. SKIP - Skip/continue without saving. SAVE - Saving the change. BACK - Back to previous screen.

LIST_COMMENTS_CAP_HEADER

TOTAL_NO_ITEMS - Total number of items. MAX - Maximum number of items that can be added by transaction. MIN - Minimum number of items required by transaction.

LIST_COMMENTS_CAP_HEADER_EX

n/a

INPUT_COMMENTS_CAP

FILE_NAME_IN - proposed file name for the comments.

COMMENT_FILENAME

Structure of the proposed file name.

COMMENT_CAP_FILE_EXT

Extension to be proposed for the file.

COM_FILE_TYPE_LIST

List of extensions that can be used for the file.

Object display

Configuration element
Available structures

OBJECT_DISPLAY_DOC

n/a

OBJECT_DISPLAY_DOC_ACTIONS

DELETE - Delete attachment. SAVE - Save changes and continue. EDIT - Edit attachment. BACK - Back to previous screen.

OBJECT_DISPLAY_DOC_HEADER

Primary: /TCTM/SOFOLENTI1_S (ATTACHMENT)

OBJECT_DISPLAY_DOC_HEADER_EX

n/a

General configuration elements

Configuration element
Description

FE_APP

Frontend class to use in running the transaction. Reference to the platform specific frontend application that should be used to run the transaction. Included in the App Master Data file supplied for setting up the initial transactions.

APP_CLASS

Sets the app processing class.

UTILITY_OPTS

Sets the features used in the app for PDF, image, signature and comments.

PDF_FILE_TYPE_LIST

Configure the file types that should be shown in the summary list. Any file types not configured, will not show in the list.

APP_TEXTS

Defines standard app text to be used in screen headers, buttons etc.

TRANS_INFO

Information about the transaction.

UTILITY_OPTS details

The UTILITY_OPTS table defines the behaviour of each utility configured within an application. The following utility types are supported:

  • Signature Screen

  • Comments Screen

  • Image Capture

  • PDF Screen

Each utility can be configured using the settings described below.

Capture Mode

Defines how content can be captured or uploaded within the utility.

Signature Screen

Value
Description

X

Signature capture enabled

Blank

Signature capture disabled

Comments Screen

Value
Description

C

Comment capture enabled

Blank

Comment capture disabled

Image Capture

Value
Description

C

Capture images using the device camera

U

Upload existing images

B

Capture and/or upload images

Blank

Image capture and upload disabled

PDF Screen

PDF documents are display-only and cannot be uploaded through the application.

Display Mode

Controls whether captured objects are displayed on the Summary List screen.

All Utilities

Value
Description

X

Object is displayed in the application

Blank

Object is hidden from the application

Delete Mode

Controls whether captured objects can be edited or deleted.

Signature Screen, Image Capture, PDF Screen

Value
Description

X

Object can be deleted

Blank

Object cannot be deleted

Comments Screen

Value
Description

E

Comments can be edited

D

Comments can be deleted

B

Comments can be edited and deleted

Blank

Comments cannot be edited or deleted

Minimum Number of Captures

Applicable to: Signature Screen, Image Capture, Comments Screen

Defines the minimum number of items that must be captured or uploaded. If this value is greater than 0, the utility becomes mandatory.

Maximum Number of Captures

Applicable to: Signature Screen, Image Capture, Comments Screen

Defines the maximum number of items that can be captured or uploaded.

Filename Prefix

Applicable to: All Utilities

Only objects whose filenames begin with the configured prefix are displayed on the Summary List screen.

Example

If the filename prefix is configured as SIG:

  • SIG UNAME 20210505 → Displayed

  • GIF UNAME 20210505 → Not displayed

File Type

Applicable to: All Utilities

Only files with the configured file type can be displayed by the application.

This setting references the file types defined in XXX_FILE_TYPE_LIST (see Section 3).

Example

If PNG and JPG are configured as valid file types:

  • PNG signature files → Displayed

  • JPG signature files → Displayed

  • GIF signature files → Not displayed

Last updated

Was this helpful?