Registering External Output Files

{"URL":["/*.*/awa/pa_view_sheet_output"],"heroDescriptionIdentifier":"ice_registering_external_output_files","customCards":[{"id":"ice_WhereDoIFindRegJobOutputFiles","title":"Where Do I Find the Registered Job Output Files?","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/obj_external_output_files_page.htm","languages":["en-us"]},{"id":"ice_AnoherWayOfRegistering","title":"Another Way to Register Files for Windows and UNIX Jobs","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/AWA/Objects/obj_external_output_files_page.htm","languages":["en-us"]},{"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"]}]}
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 Jobs, on the target systems. When defining the general object settings, you also specify whether 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.

For Jobs, to have those files available and accessible from the User Interface later on, you register them on the External Output Files page indicating the where they will be stored. The files you enter here are then accessible as Directory reports from the Reports window after the Job has executed.

Once you have registered the files, you can define filters that search for specific strings in those files. You can also define which actions should be taken based on the results of the search. For more information, see Scanning the Output Files.

The External Output Files page is available for Jobs (JOBS) that run on Windows, UNIX, SAP, R3, RA, JMX. SQL, VMS and OA Agents.

Important!

  • The file size is decisive for the time if takes to transfer the files.
  • You can only access the registered output files if your User definition has the necessary authorization to access the Job and the external reports for the particular file and for the Agent.
  • The Agent retrieves the registered output files. If the Agent cannot find the files, or if they cannot be accessed, an error occurs.

Standard Job outputs (Reports, JCL, scripts, etc.) are automatically registered as such and displayed on this 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 window.

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. Consider the folowing:

    • 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.

    Important!

    • 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.

Where Do I Find the Registered Job Output Files?

As soon as the jobs are executed, you can access these files from the Reports dialog:

  1. Right-click the job and select Report from the context menu to open the dialog.
  2. Select Directory from the dropdown list. The reports table displays the files available both on the agent and on the Automation Engine.
  3. Click the icon on the right edge of the File column to download a file.

The file size is decisive for the time that it takes to transfer the files. This is why large reports are truncated in smaller chunks that you can easily download without performance issues.

Important!

  • Output files can only be opened if the Automation Engine user has the relevant authorization ("P") to access the job and external reports (type: "EXTREP") for both the particular file and the agent.
  • Files that have been registered using the Requires User's Login option can only be opened by users that can log on to the agent with their default login.

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: