Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Lookups are one grouping of Setup Tasks. Make use of the Lookups object type to export and import individual Lookups by Lookup Type.

Object Type Identification

  • When populating files from source control management (SCM), FlexDeploy will classify all zip files containing "SetupTasks/Lookups" (case-insensitive) in their path as a Lookup.  

...

Object Type Code

LOOKUPS

Attributes

Name

Code

Description

Default Value

Supported Values

Task Code

TASK_CODE

Unique id for Setup Task

Lookup Type

LOOKUP_TYPE

The label for a static list that has lookup codes as its values. This can be found in FSM UI on any lookups setup task (IE. Manage Common Lookups).

FILE_NAME


Considerations

Source from Development Environment

In order to download file from an environment, you must configure file for Lookup as shown below. Note that File Name (with Path) should be entered first in format - /SetupTasks/Lookups/<TASK_CODE>/<LOOKUP_TYPE>.zip. File name is used as Lookup Type, and parent folder is used as Task Code. Task Code can be selected from drop down list if necessary. Also Lookup Type can be entered manually as well if necessary. Make sure to update File Name (with Path), respectively, if either of previous attributes are edited manually. Steps - Enter File Name in proper format, Click Evaluate, then click OK and eventually click Save to save configurations. Now you can add this file to Package and perform, export and import.

...

Source from SCM

The following convention is generally used for the File Name (with Path) in Source Code Repository. "/SetupTasks/Lookups/<TASK_CODE>/<LOOKUP_TYPE>.zip". If you follow these conventions, then you do not have to configure Files manually. You are ready to perform export and import using FlexDeploy package once files are discovered in FlexDeploy.

Task Code is derived from zip file sourced from SCM.

...

During deployment, Lookup Types must be read, created, and/or updated via a REST service. Each LookupType will have a REST Access Secured setting. See the below table for possible values and potential actions to take if your Lookup Type has a restricted access level.

Rest Access Secured

Action Required

Description

Anonymous

No

Lookup will be available to anonymous-role and authenticated-role

Authenticated

Yes

Lookup will be available to an authenticated-role.

The service account that is used for the Build and Deploy must be added to the roles that are authenticated to the lookup.

Secured

Yes

Lookup will not be available at all in the generic resources. A separate resource will need to be created and secured to the correct roles using function security.

...

Example Task where REST Access Secured value can be viewed.

...