Performing User Tasks › How Retrieving an Element from an Inventory Location Works

How Retrieving an Element from an Inventory Location Works

When you use CA Endevor Integration for the Natural Environment to retrieve an element from a CA Endevor SCM inventory location to a specified FUSER/Library (in the case of Natural programming objects or error messages) or to a specified FDIC (in the case of Predict objects or Natural DDMs) using the Retrieve Elements action, CA Endevor SCM performs the following actions and causes these effects:

1. Determines whether the element is signed out. If the element is signed out to someone else, and if you do not set the SIGNOUT ELEMENT option to N, you must set the OVERRIDE SIGNOUT option to Y to retrieve the element. However, your CA Endevor SCM administrator must have set up permissions for you to use the OVERRIDE SIGNOUT option.
2. Searches for the specified element, in the following order:
   1. At the location you specify in the RETRIEVE elements action
   2. In each stage in the environments on the map route

   Note: If CA Endevor SCM finds the element at a subsequent stage that is not part of the map, you will see a warning message in the API Message report. In addition, if you do not know the exact location of the element you want to retrieve, specify the lowest stage in the map route. CA Endevor SCM searches the entire map route for the element.

3. Copies the current level of the element to the specified FUSER/Library or FDIC.

   If the object currently exists in the target FUSER/Library or target FDIC, the Retrieve action fails unless the REPLACE IF PRESENT option was set to Y on the Retrieve Natural Programming Objects panel. If the action fails, you receive an error message.

   When the existence of the object is checked in the Natural library, if a new name for an object was requested, the new name is checked in the Natural library. (A new name can be specified from the selection list or using the New Object Name field on the Retrieve Natural Programming Objects panel.)

   Important: If more than one Retrieve action is requested against the same target object name in a single batch execution of CA Endevor SCM and the REPLACE IF PRESENT option is set to N to indicate no replacement should be done, then the second and all subsequent Retrieve actions will fail to replace the object in the Natural library. The reason being that the first request copied the element to the target so that it is now present at the target location. So, all subsequent requests fail, because of the REPLACE IF PRESENT option set to N restriction. However, CA Endevor SCM will not issue an error message indicating the subsequent failures unless the object existed in the target Natural library prior to the first Retrieve, in which case the first Retrieve also will have failed.

4. If you set the SIGNOUT ELEMENT option to Y, CA Endevor SCM updates the Master Control File (MCF) and signs the element out to you. If you set the SIGNOUT ELEMENT option to N, CA Endevor SCM stops processing the action after it creates the copy in step 3.