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

SET_SYNC

Script Function: Executes the defined actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. of a Sync objectIt synchronizes executable objects based on defined states and actions. A particular Automation Engine object type..

Syntax

SET_SYNC(Sync, Action)

Syntax

Description/Format

Sync

Name of the Sync object whose action should be executed.
Format: AE name, script literal or script variable

Action

Action that should be executed.
Format: AE name, scriptA particular Automation Engine object type. literal or script variableA placeholder for a value within a script.


Return codes

"Y" - Sync action could be executed .
"N" - Sync action could not be executed.

Comments

You can define actions concerning a Sync object in the Sync tab.

Whether or not an action can be executed depends on the specified definitions because each action can only be executed if there is a particular condition.

Note that write access (W) to the specified Sync object is required in order to execute this script element.

Example

:SET &RET#=SET_SYNC("DB.STATUS","EXCLUSIVE")
:
IF &RET# = "Y"
:   
PRINT "Sync condition EXCLUSIVE was set!"
:
ELSE
:   
PRINT "Sync condition EXCLUSIVE was not set!"
:
ENDIF

 

See also:

Script element Description

GET_SYNC

Queries the current condition or value of a Sync object.
:ATTACH_SYNC Assigns a Sync object to a taskAn executable object that is running. Tasks are also referred to as activities..

Script Elements - Read or Modify Objects

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