User Guide > UserInterface > Search / Replace > Search for Object Usage

 Searching for Object Usage

The search-for-use functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… can be used to find objects. It can even be used to search for the usage of particular objects. For example, if the indicated jobAn Automation Engine object type for a process that runs on a target system. is part of a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."], the search result shows this particular workflow.

Click the Objects tab and select "Usage of objects" in the "Search for" section in order to search for objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task usages. Object name and type should also be specified.

This search function can be accessed even more easily by highlighting the object in the Explorer and selecting the command Search for Use in the context menu. The Search window opens with the required information already being inserted. The search starts immediately with all folders by default.

In scriptA particular Automation Engine object type., the search-for-use function is deactivated by default and the checkbox "Include Script" is grayed out. The administrator can activate this functionality in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. UC_CLIENT_SETTINGS using the key SEARCH_SCRIPT_FOR_USAGE. Two methods are available: 

  1. The searched string must be somewhere in the script as otherwise it cannot be displayed. For example: The search for MM lists results in which it is included as a whole or partially.
  2. The searched string is handled as a word which is enclosed in delimiters such as blanks, left and right parentheses, equals (=), comma, single quotations, double quotations, end of lines and script ends.

     Underscores are not delimiters. Searching for MM in _MM_ does not return a result.

    For example: The search for MM lists results in which it is enclosed in the described delimiters.

When searching for calendar keywords in scripts, the result only includes lines that include the keyword as well as the name of the Calendar object.

Note that the search function does not find calendarAn Automation Engine object type that defines a set of days based on calendar keywords. and calendar keywordThe attribute of a Calendar object that defines which days included in the calendar. usages if the settings of recurring task are concerned.

The Search function does not search a calendar keyword in the Calendar object in which it has been created.

For example: The Calendar object ON_CALL_DUTY contains the calendar keywords MONDAY_TO_FRIDAY and WORKDAYS. The latter one is a groupAn Automation Engine object type that integrates tasks so that they can be processed together.-type calendar keyword which contains the calendar keyword MONDAY_TO_FRIDAY. The result of searching the usage of MONDAY_TO_FRIDAY does not include the calendar keyword WORKDAYS because it is stored in the very same Calendar object.

The search function does not find agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host usages if the filter specifications refer to agent groups.

The search for use function also includes fields that include an object but have been deactivated using a particular option and are grayed out. For example, Runtime tab - Else - Execute.

Note that the object typeAn individual object is provided for the individual activities: There are User, UserGroup, Notification, Cockpit, CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include, Job, Workflow, Calendar, Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync, Variable and TimeZone objects is not considered if the wildcards "?" and "*" are included in your search for object names.

The "Use" column in the search result describes where the object was found. It contains for example:

A special feature has been included in the search for usage: If you open an object that is shown in the search result, the searched object is highlighted with a red frame. This feature is supposed to make it easier to find the particular object especially in workflows which contain many tasks.

A blue frame is used when the searched object was entered in the properties of a task (such as in the Result tab). This can affect schedules, workflows and elements of cockpits.

The colored frame highlights checkboxes of workflows, lines in schedules, elements in cockpits, text fields in which the object was entered and object names used in script lines.

See also:

Search
Replacing Object Usage
Searching and Replacing Texts

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH