Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > GET_CONNECTION

GET_CONNECTION

Script Function: Reads information from a DB-type Connection objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.

Syntax

GET_CONNECTION(Object name, Attribute)

Syntax

Description/Format

Object name

The name of a DB-type Connection object.
Format: AE name, scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.

Attribute

The value that should be read from the object.
Format: AE name, script literal or script variable

Allowed values:

Please note: The value DbUserid has to be used in case-sensitive databases exactly as printed here.

Return Codes

Required value of the CONN object.

Comments

This script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… reads a certain value of a DB-type Connection object and returns it as code.

A runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start). error occurs when the system cannot find the specified object, when it is not a DB-type Connection object or when the specified attribute is not valid.

Examples

The following example retrieved the database type of the Connection object CONN.DB and writes it to the activation reportA report provides more detailed information about a task's execution or a component..

:SET &VAR#GET_CONNECTION(CONN.DB, db.type)
:&VAR#

This is how the related line appears in the activation protocol:

2013-01-30 12:45:21 - U0020408 MSSQL

 

See also:

Script Elements Description
GET_ATT This function returns the values of a taskAn executable object that is running. Tasks are also referred to as activities.'s attributes during the generation process.
GET_LOGIN Reads information from Login objects.

 

 


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

Copyright © 2016 Automic Software GmbH