:ATTACH_RES

Use the :ATTACH_RES script statement to define the resources you want to attach and transfer to the UNIX or Windows Agent with a Storage object.

Prerequisites and Context

This statement is available only on the Process page of Windows or UNIX Job objects (JOBS).

Syntax

:ATTACH_RES ObjectName, ResourceName, [Usage], [Variable]

Parameters

Parameter Description Format Allowed Values Default Value
ObjectName Defines the name of the Storage object. AE name n.a. n.a.
ResourceName

Defines the name of the resource that should be attached and transferred to the agent.

Note:

  • The size of resources is limited to 95 MB (99900000 bytes). Administrator users can reduce the size by setting the storage size with the MAXIMUM_STORE_RESOURCE_SIZE key in the UC_SYSTEM_SETTINGS system variable to a lower value. For more information, see UC_SYSTEM_SETTINGS - Systemwide Settings.
  • If resources are attached to the Storage object, the Automation Engine system determines the corresponding paths. These paths are not visible to the user. By using the following system variables you can view the details and absolute paths of the resource displayed in the report of the Job object: &$AGENT_RESOURCES_CLIENT# (Client-wide cache directory) and &$AGENT_RESOURCES_TASK# (Task-specific cache directory).
 Script literal n.a. n.a.
Usage (Optional) Determines whether a task-specific or a client-wide cache is used. Script literal
  • T
    Task-specific value, a task-specific cache is used to transfer the resource files. The task resources are available while the job is running and are only visible for the job. These resources are deleted when the job ends.
  • C
    Client-wide value, a client-wide cache is used to transfer the resource files. The resources remain in the cache and are only refreshed when the Automation Engine obtains a new timestamp, for example.
 T
Variable

(Optional) Determines if an Automation Engine variable is replaced by a text-type storage resource just before it is transferred to the agent.

Note:

  • Ensure that the storage resource is text type and that the value defined in Usage is T (task-specific cache). An error message displays if you transfer text-type resources, with the variable replacement set to Yes, to C (client-wide cache).
  • For performance reasons, system variables in a text-type resource are only replaced with their corresponding values if the same system variable is used on the Process page.
 Script literal
  • N[o]
  • Y[es]
 N[o]

Important Considerations

Key considerations include:

  • In a Job that uses :ATTACH_RES, the agent creates a list of all files that should be transferred. If the transfer of the listed files fails, the agent cancels the job.
  • The agent transfers information about the operating system, hardware, and platform to the Automation Engine system. However, the Automation Engine system only transfers those resources from the Storage object that comply with its specified values.
  • You can transfer resources into a pre-determined directory using ATTACH_RES and copy the files afterward with an external script. Use the &$AGENT_RESOURCES_CLIENT# and the &$AGENT_RESOURCES_TASK# system variables for this purpose.

Examples

The following example transfers all the resource files that the specified Storage object contains.

:ATTACH_RES "STORAGE12", "*"

This example transfers all resources whose names start with the term "file".

:ATTACH_RES "STORAGE12", "file*"

The third example transfers all resources into a client-wide cache.

:ATTACH_RES "STORAGE12", "*", C

This example replaces a variable in all files that should be transferred.

:ATTACH_RES "STORAGE12", "*.ini",,Y

The last example uses the &$AGENT_RESOURCES_CLIENT# system variable on the host CURL.EXE for :ATTACH_RES to download a text file from a sample URL. This example would work on every Windows agent, even if CURL were unavailable beforehand.

:ATTACH_RES "PCK.AUTOMIC.STORE", "CURL.EXE", C
    "&$AGENT_RESOURCES_CLIENT#CURL.EXE" -O https://www.sampleurl.com/content.txt

See also: