Registering External Output Files

{"URL":["/awa/pa_view_sheet_output"],"heroDescriptionIdentifier":"ice_registering_external_output_files",{"id":"ice_registered_job_output","title":"Registered Job Output","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/obj_Job_RegisteredOutput.htm","languages":["en-us"]},{"id":"ice_register_outputfile_script","title":"Registering Output Files through Script","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Script/Reference/REGISTER_OUTPUTFILE.htm","languages":["en-us"]}]}

The External Output Files page allows you to register files that are stored on the Agent. After a Job has been executed, you can access those files directly from the Reports window. On the Output-Scan page you set the filters that should be used to search the report of a task or an external output file. You also define the reaction to your search results.

After adding an object, the object definition pages open to the object-specific page. Expand the Output tab on the left pane to access the External Output Files and Output Scan pages.

This page is active for Jobs (JOBS) that run on Windows, UNIX, SAP, R3, RA, JMX. SQL, VMS and OA Agents.

Overview

Registering External Output Files,output files,register reports,reports available from the ui,reports available from AWI

When executing objects, comprehensive output files and reports are generated both in the Automation Engine and, in the case of Job objects, in the target systems. When defining the general object settings you also specify if the reports should be stored in the Automation Engine database or as a file in the target system. From an Automation Engine perspective, reports stored on the agent are external reports and are transferred from the agent to the Automation Engine via File Transfer.

To have those files available and accessible from the User Interface later on, you register them on the External Output Files page indicating their path. The files you enter here are then accessible as Directory reports from the Reports window.

Important!

  • The file size is decisive for the time if takes to transfer the files.
  • The registered output files can only be accessed if the user has the necessary authorization to access the Job and the external reports for the particular file and for the Agent.
  • The registered output files are retrieved by the Agent. If the Agent cannot find the files, or if they cannot be accessed, an error is thrown.

Standard Job outputs (Reports, JCL, scripts, etc.) are automatically registered as such and displayed on is page after execution. You can add other outputs as well. Once the Job has been executed, the files registered here are available for display from the Reports dialog.

Tip: Specify files that are expected through the execution of Jobs, such as the text file that the JCL generated, on the Process page.

To Register Output Files

  1. In the Fully Qualified Name column enter the path and name of the file to be registered. You must specify the full path.

    Notes:

    • Wildcard characters are not allowed
    • The file extension is irrelevant
    • You can use variables to enter the qualified name.

  2. When the Agent accesses the output file through the Automic Web Interface, it logs on to the computer and transfers the file. If you activate the checkbox in the Requires User's Login column, the Login object that has been assigned to that particular user is applied. Otherwise, the login information of the job Login object is used.

Notes:

  • If you activate this option, do not forget to define a default login to log on to the Agent in the User object. Otherwise an error occurs when you open the output file.
  • This option is only relevant for operating system Jobs and has no impact on other Jobs (for example, Rapid Automation, SAP and so on).

For more information, see Inserting Variables/VARA Objects in Objects and Scripts.

Another Way to Register Files for Windows and UNIX Jobs

Registering Windows External Output Files,Registering UNIX External Output Files,output files,register reports,reports available from the ui,reports available from AWI

In addition to entering the files here, you can also register files as external output using the :REGISTER_OUTPUTFILE script element. The difference between both methods lies in the registration time:

  • Files specified on the Output page are registered immediately when the job is executed, regardless of whether the Job could create them or not.
  • If the script element is used, the specified file is only registered when it is called.

See also: