Oracle SaaS FSM Object Type - Lookups
- Karl Henselin
- Emily Simon
- Rajashekar.Gaddi
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 files containing "SetupTasks/Lookups" (case-insensitive) in their path as a Lookup. Â
File Extensions
.zip
Object Type Code
LOOKUPS
Attributes
Name | Code | Description | Default Value | Supported Values |
|---|---|---|---|---|
Task Code |
| Unique id for Setup Task | Â | Â |
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). |
| |
Rollback Source Type |
| Where to retrieve file when initiating a rollback deployment. | Project Version  | Project Version, SCM Revision, Backup Repository, and Rollback File SCM Revision and Rollback File options are only available when the project has SCM details configured, and Backup Repository should only be used if the FlexDeploy server and project are configured to take backups. |
Rollback File |
| The associated file to deploy which will roll back this file. Only applicable when Rollback Source Type is Rollback File | Â | Any project file sourced from SCM |
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.
How to find Task Code for a Setup Task?
To initiate the export or import process, Oracle endpoints requires providing a code for the task. Following these instructions to find the Task Code. We are assuming you have access to FSM resource.
Click Navigator > My Enterprise > Setup and Maintenance.
In the Setup and Maintenance work area, click Manage Setup Content from the Tasks panel tab.
To search for the code of a task
On the Manage Setup Content page, click Manage Task Lists and Tasks.
In the Search field, select Tasks and click Search.
In the search results, click the name of the task.
On the Task page, look for value that appears against Code.
Copy the code and use it where necessary
Permissions
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.
Execution Failures
Export execution can fail if the artifact (CSV Packages files) contain no data or if the Lookup Type provided in the attributes does not exist on the source environment. First ensure the value for Lookup Type is valid and contains no spelling errors. If the error still persists, then you will need to try another Task Code appropriate for the Lookup Type you are managing. For example, take Manage Common Lookups (Task Code = FND_MANAGE_COMMON_LOOKUPS) and the Lookup Type of LOCATION_ADDRESS_USAGE_TYPE. If export were to fail, in that case Manage Location Lookups (Task Code = PER_MANAGE_LOCATION_LOOKUPS) would make more sense.
Use the Task Code dropdown to find the most appropriate Task for the Lookup Type you wish to export/import.
Â
Note:
As of versions 6.5.0.20, 7.0.0.11, 8.0.0.6, and 9.0.0.0, the following lookup types follow a new approach for building and deploying through the JSON format: FND_MANAGE_COMMON_LOOKUPS, FND_MANAGE_STANDARD_LOOKUPS, and FND_MANAGE_SET_ENABLED_LOOKUPS
- style