Automation Engine Script Guide > Ordered by Function > Script Structure and Processing > :INCLUDE

:INCLUDE

Script Statement: Integrates an Include objectAn Automation Engine object type for a script that is frequently used in more than one object. into a scriptA particular Automation Engine object type..

Syntax

:INC[LUDE] Include Object [OldString = NewString], [NOFOUND=IGNORE], [EXT_REPORT=OFF]

Syntax

Description/Format

Include Object

The name of the Include object that should be integrated

Enter the complete name of the Include object. Script variables are not allowed.

OldString

The string of the Include object's script that should be replaced by NewString
Format: script literal

NewString

The string that should replace OldString from the script of the Include object.
Format: script literal

Maximum 50 characters

NOFOUND=IGNORE

No error occurs when the specified Include object canot be found.

EXT_REPORT=OFF

Include object contents are not logged in extended reports. A comment line is output instead.

Comments

Many objects use identical processing steps in their scripts. Because of Include objects, they do not have to be written and maintained in every single script. Include objects contain often used script parts.

Use the statement :INC to address an Include object from a different objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task. Whenever an object containing this script statement is activated, the Include object's script is integrated.

OldString and NewString are optional parameters. They can be used to replace an Include object's string by another one. Replacements are only valid for the current generation and do not change the Include object itself.

Examples

This example shows how an Include object is integrated. The string "$MM." specified in the Include object obtains the new name "$MMTEST".

:INC MM.FILEASSIGNMENTS "$MM." = "$MMTEST."  

In the next example, a userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. Include is called. No error occurs if it does not exist.

:INCLUDE HEADER.WINDOWS.USER.HEAD ,NOFOUND=IGNORE

Logging the contents of the Include object to extended reports is suppressed in the example shown below. 

:INC MM.FILEASSIGNMENTS ,EXT_REPORT=OFF

 

See also:

Script element Description

:INC_SCRIPT

Integrates a script into another script of the same object

Script Elements - Script Structure and Processing

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by function

 


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

Copyright © 2016 Automic Software GmbH