Single Select Lookup > Microsoft Excel > File System

This topic shows how to create a lookup with a Microsoft Excel file stored in the AgilePoint Server machine as the data source for the Single Select Lookup form control.

Background and Setup

Prerequisites

Good to Know

How to Start

  1. On the Single Select Lookup form control configuration screen, on the Configure tab, click Add Lookup.

    For information about how to open this screen, refer to Single Select Lookup form control.


    Click Add Lookup
  2. On the Select Data Source Type screen, select Microsoft Excel.

    Select Excel Table
  3. Click Next.

Lookup Details

Specifies the basic configuration for a lookup.

Figure: Microsoft Excel Lookup Details screen

Microsoft Excel Lookup Details screen

Fields

Field NameDefinition

Lookup Name
Description:
Specifies the name you want to give to your lookup procedure.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Lookup Type
Description:
Specifies the Name/Value type for the lookup procedure.

The Single Select Lookup form control does not support Multiple Columns lookups. If you select the Multiple Columns, the configuration screen shows Name/Value lookup type.

Allowed Values:
Read only.
Default Value:
Name/Value

Choose Document Repository screen

Specifies the repository where your Microsoft Excel file is stored. This section shows the configuration on the AgilePoint Server machine to create a lookup.

Figure: Choose Document Repository screen

Choose Document Repository screen

Good to Know

Fields

Field NameDefinition

Select Document Repository
Description:
Specifies the repository where your Microsoft Excel file is stored.
Allowed Values:
  • File System - Specifies a location on the AgilePoint Server machine as the repository where your Excel file is stored.

    This section shows the configuration for File System. You can use other supported repository types. For more information, refer to the Limitations for this field.

Default Value:
None
Limitations:
  • Your Microsoft Excel file must be permanently stored in a supported repository. The following rules apply:
    • The file name must not change for the Excel file.
    • Once the lookup is configured, the Excel file must not move from the configured location.
    • The names for any folders or other dependent items, such as SharePoint document libraries, in the path to the Excel file must not change.

Configure Lookup > Configure Repository tab

Specifies the location of your Microsoft Excel file on the AgilePoint Server machine.

Figure: Configure Lookup > Configure Repository tab

Configure Repository tab

Fields

Field NameDefinition

File System Folder Path
Description:
Specifies the path of your Microsoft Excel file on the AgilePoint Server machine.
Allowed Values:
An absolute file path on your AgilePoint Server machine.

The file paths may be restricted on the AgilePoint Server machine. If the file paths are restricted, they are specified in the key AllowedLocalSystemPathForFileUpload in the file Configuring Ascentn.AgilePoint.WCFService.exe.config. For help, contact your AgilePoint NX administrator

Default Value:
None

Choose File Path
Description:
Specifies the file in your repository.
Allowed Values:
The name of a file in your repository.
Default Value:
None
Accepts Variables:
No
Example:
Refer to:

Configure Lookup > Quick Config tab

Configures a lookup with the existing data format from your data source.

Figure: Configure Lookup > Quick Config tab

Quick Config tab

Fields

Field NameDefinition

Table
Description:
Specifies the name of the Microsoft Excel table to use for your lookup.
Allowed Values:
A Microsoft Excel table name from the list.

When you select an Excel file from the Choose File Path field, this field shows the table names associated with the Excel file.

Default Value:
None
Example:
Refer to:

Columns - Name
Description:
Specifies the name of the Microsoft Excel column in a key-value pair.
To Open this Field:
  1. Select a table from the Table list.
Allowed Values:
A column name from the list.

When you select the table name from the Table field, this field shows the column names associated with the Excel table.

Default Value:
None

Columns - Value
Description:
Specifies the value for a Microsoft Excel column in a key-value pair.
To Open this Field:
  1. Select a table from the Table list.
Allowed Values:
A column value from the list.

When you select the table name from the Table field, this field shows the column values associated with the Excel table.

Default Value:
None

Column Name
Description:
Specifies the name of the Microsoft Excel column to use in your filter.
To Open this Field:
  1. Click Add Filter Add Filter icon
Allowed Values:
A column name from the list.
Default Value:
None

Operator
Description:
Specifies the operator to use in the filter.
To Open this Field:
  1. Click Add Filter Add Filter icon
Allowed Values:
  • <=
  • <
  • =
  • >
  • !=
  • >=
  • Begins With
  • Ends With
  • Contains
  • NotContains
Default Value:
None

Value
Description:
Specifies the value for the Microsoft Excel column to use in the filter.
To Open this Field:
  1. Click Add Filter Add Filter icon
Allowed Values:
A valid column value.
Default Value:
None
Accepts Variables:
Yes

Select Nest Type
Description:
Specifies the AND and OR logical operators to filter the lookup.
To Open this Field:
  1. Click Add Filter Add Filter icon
Allowed Values:
  • AND - Specifies the AND operator.
  • OR - Specifies the OR operator.
Default Value:
And

Delete Filter Delete Filter icon

Function:
Deletes the filter condition.

Sort By
Description:
Specifies the name of the column to sequence the query results.
Allowed Values:
A column name from the list.
Default Value:
None

Sort Order
Description:
Specifies the sort order for the result set.
Allowed Values:
  • Ascending - Sorts the result set in ascending order.
  • Descending - Sorts the result set in descending order.
Default Value:
Ascending

Configure Lookup > Error Messages tab

Configures the message to show if the lookup does not return any data.

Figure: Configure Lookup > Error Messages tab

Configure Lookup screen Error Messages tab

Fields

Field NameDefinition

No Items Retrieved
Description:
Specifies the error message to show if the lookup does not return any data.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

Lookup Failed
Description:
Specifies the message to show if the data fails to load.
Allowed Values:
More than one line of text.
Default Value:
Failed to load data.