Help Object

Help Object defines a lookup list or a Data Analytics list: its query, the columns it returns, its criteria, kanban settings and where it is used.

Where

Application Configuration › Helps and Document Flow (ACOH)

Who uses it

ABS consultants

When

When the product’s configuration is changed

Needs first

Nothing

What it is for

These are configuration screens: they change the product for every client that shares the configuration, so they are worked by ABS consultants, normally on the development system. The query is tested from the screen: a test needs the edit right on this screen and accepts a single SELECT only. Save refuses a query naming the configuration database directly. A help object still used by a screen cannot be deleted. The Kanban group also holds two keys that set the label and value of the kanban’s criteria.

Every field in plain words

Field	What it means	What to put
SQL	The query.	Optional.
Single Column	The column returned to the field.	Optional.
Multiple Column	The columns returned to several fields.	Optional.
Primary Search Key	The column searched first.	Optional.
Total Key	The column totalled.	Optional. Pick from the list.
Hyper Link	Columns shown as links.	Optional.

Object Specific

Column	What it means	What to put
Process Code	The screen.	Optional.
Object No	The field.	Required. Pick from the list.
Activity	Activity.	Optional.
Create Visible	Shown when creating.	Optional.
Create Enable	Editable when creating.	Optional.
Change Visible	Shown when editing.	Optional.
Change Enable	Editable when editing.	Optional.
Reverse Visible	Shown on a reversed document.	Optional.
Reverse Enable	Editable on a reversed document.	Optional.
Help Object	The lookup list.	Optional. Pick from the Help Object list.
Help Where	Extra condition on the lookup.	Optional.
Mandatory	Required.	Optional.
Help Not Mandatory	A value outside the lookup is accepted.	Optional.
Dimension Required	Needs financial dimensions.	Optional.
Override Hyperlink Jump	Screen to open instead.	Optional. Pick from the Object list.
Duplicate	Must be unique.	Optional.
Exits	Must exist in its list.	Optional.
Base On Legal Entity	Checked per company.	Optional.
Table Name	Table.	Optional.
Mandatory Condition	Conditions under which it is required.	Optional.

Grid

Column	What it means	What to put
Grid	The grid.	Optional.
Process Code	The screen.	Optional.
Process Activity	Activity (create, change…).	Optional.
Object No	The field.	Required. Pick from the list.
Position	Column position.	Optional.
Label Length	Column width.	Optional.
Create Visible	Shown when creating.	Optional.
Create Enable	Editable when creating.	Optional.
Change Visible	Shown when editing.	Optional.
Change Enable	Editable when editing.	Optional.
Help Object	The lookup list.	Optional. Pick from the Help Object list.
Help Where	Extra condition on the lookup.	Optional.
Reverse Visible	Shown on a reversed document.	Optional.
Reverse Enable	Editable on a reversed document.	Optional.
Mandatory	Required.	Optional.
Help Not Mandatory	A value outside the lookup is accepted.	Optional.
Template Field	Included in the import template.	Optional.
Hyper Link Name	Screen the link opens.	Optional.
Hyper Link	Shown as a link.	Optional.
Override Hyperlink Jump	Screen to open instead.	Optional. Pick from the Object list.
Move	Column can be moved.	Optional.
Freeze	Column is frozen.	Optional.
Total Sum	Column is totalled.	Optional.
Line Group	Line group.	Optional.
Line Group Position	Position in the line group.	Optional.
Line Sub Group	Line sub group.	Optional.
Dimension Required	Needs financial dimensions.	Optional.
Separate Dimensionset Required	Needs its own dimension set.	Optional.
Mandatory Condition	Conditions under which it is required.	Optional.

Report

Column	What it means	What to put
Report	A report.	Optional. Pick from the Report list.
Help Object	The lookup list.	Optional. Pick from the Report list.
Criteria Field	The criteria field. Required.	Optional.
Order	Order.	Optional.
Table Alias in Query	Table alias in the query.	Optional.
Column in Query	Column in the query.	Optional.
Default Value	Default value.	Optional.
Mandatory	Required.	Optional.
Several Values	Several values allowed.	Optional.
Choose Condition	User may choose the comparison.	Optional.
Lookup	Lookup for the value.	Optional. Pick from the Help Object list.
Add to WHERE	Added to the query’s WHERE by itself.	Optional.
Document Number	Holds the document number.	Optional.
Show in Short Form	Shown in the short form.	Optional.
Help Where	Extra condition on the lookup.	Optional.

Data Analytics

Column	What it means	What to put
Help Object	The lookup list.	Optional.
Criteria Field	The criteria field. Required.	Required.
Order	Order.	Optional.
Table Alias in Query	Table alias in the query.	Optional.
Column in Query	Column in the query.	Optional.
Default Value	Default value.	Optional.
Mandatory	Required.	Optional.
Several Values	Several values allowed.	Optional.
Choose Condition	User may choose the comparison.	Optional.
Add to WHERE	Added to the query’s WHERE by itself.	Optional.
Lookup	Lookup for the value.	Optional. Pick from the Help Object list.
Help Where	Extra condition on the lookup.	Optional.

General

Field	What it means	What to put
Help Object	The help object code.	Required. A short code; it cannot be changed once the record exists.
Hyper Link Name	Screen the link opens.	Optional.
Drop Down	Shown as a drop-down.	Tick or leave clear.
Server Paging	Loads page by page.	Tick or leave clear.
Multi Return	Returns several values.	Tick or leave clear.
Total Required	Shows totals.	Tick or leave clear.
Financial Dimension Criteria	Offers financial dimension criteria.	Tick or leave clear.
Kanban View	Offers a kanban view.	Tick or leave clear.
Kanban Column Key	Column that makes the kanban lanes.	Optional.
Kanban Columns Query	Query for the lanes.	Optional.

Criteria

Column	What it means	What to put
Help Object	The lookup list.	Optional.
Criteria Field	The criteria field. Required.	Required.
Order	Order.	Optional.
Table Alias in Query	Table alias in the query.	Optional.
Column in Query	Column in the query.	Optional.
Default Value	Default value.	Optional.
Date Range	A date range.	Optional.
Mandatory	Required.	Optional.
Several Values	Several values allowed.	Optional.
Choose Condition	User may choose the comparison.	Optional.
Add to WHERE	Added to the query’s WHERE by itself.	Optional.
Lookup	Lookup for the value.	Optional. Pick from the Help Object list.
Help Where	Extra condition on the lookup.	Optional.

Settings

Column	What it means	What to put
Object No	The field.	Optional. Pick from the list.
Hidden	Hidden column.	Optional.
Show Summary	Shows a summary.	Optional.
Hyper Link Name	Screen the column opens.	Optional. Pick from the list.
Jumpto Setting	Jump settings.	Optional.
Show in Kanban	Shown on kanban cards.	Optional.
Kanban Sequence	Order on the card.	Optional.

Help Related

Column	What it means	What to put
Help Object	The lookup list.	Required.
Help Object Index	Order.	Optional.

How to configure it

These are configuration screens: they change the product for every client that shares the configuration, so they are worked by ABS consultants, normally on the development system.

What it is connected to

• Picked on these company setup screens: Grid, Object Specific Definition, Object, Report, Widget.
• Picked on Account Dimension in General ledger.
• Picked on Inventory Origin, Movement in Inventory.
• Picked on Purchase Origin in Purchasing.
• Picked on Sales Origin in Sales.
• Picked on Fleet Origin, Service Origin in Service and maintenance.

If something looks wrong

• “Help Object … cannot be deleted - it is still used by ….”
• “A help query must be a single SELECT (or WITH ... SELECT) statement.”
• “You need the edit right on Help Object (ACOH) to run a help query.”
• “A single return column can not be in multi return columns list”