DOCUMENTATION
Sign In

Get access to My SAS, trials, communities and more.

SAS Viya Platform System Programming Guide
 
CASL
Lua
Python
R

Access Control Action Set: Syntax

Provides actions for managing user access to resources

checkOutObject Action

Reserves an object (and all of its children) for update by only the current client session. Prevents an object (and all of its parents) from being checked out exclusively by another session if checkOutType=Shared.

See:About Transactions
Example:Preview the Results of Access Control Changes

CASL Syntax

Développer toutRéduire tout
accessControl.checkOutObject <result=results> <status=rc> /
checkoutParent=TRUE | FALSE,
checkOutType="EXCLUSIVE" | "SHARED",
ObjectSelector={objType="ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}
;

Parameter Descriptions

checkoutParent=TRUE | FALSE

indicates whether to check out the parent object if the specified object does not exist.

DefaultFALSE

checkOutType="EXCLUSIVE" | "SHARED"

specifies the type of check-out. By default, a check-out is exclusive, so only the current session can update the specified object (and its children). If you specify checkOutType=Shared, the check-out does not lock the object; it merely prevents other sessions from locking the object (and its parents).

DefaultEXCLUSIVE

ObjectSelector={objType="ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}

specifies the type of object that you want to check out.

AliascheckOutObject

The value that you specify for the objType parameter determines the other parameters that apply.

Parameters for objType="ACTION"

action="string"

specifies the action name.

* actionSet="string"

specifies the action set name.

Parameters for objType="ACTIONSET"

actionSet="string"

specifies the action set name.

Parameters for objType="CASLIB"

* caslib="string"

specifies the caslib name.

Parameters for objType="COLUMN"

* caslib="string"

specifies the caslib name.

column="string"

specifies the column name.

* table="string"

specifies the table name.

Parameters for objType="TABLE"

* caslib="string"

specifies the caslib name.

table="string"

specifies the table name.

checkOutObject Action

Reserves an object (and all of its children) for update by only the current client session. Prevents an object (and all of its parents) from being checked out exclusively by another session if checkOutType=Shared.

See:About Transactions
Example:Preview the Results of Access Control Changes

Lua Syntax

Développer toutRéduire tout
results, info = s:accessControl_checkOutObject{
checkoutParent=true | false,
checkOutType="EXCLUSIVE" | "SHARED",
ObjectSelector={objType="ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}
}

Parameter Descriptions

checkoutParent=true | false

indicates whether to check out the parent object if the specified object does not exist.

Defaultfalse

checkOutType="EXCLUSIVE" | "SHARED"

specifies the type of check-out. By default, a check-out is exclusive, so only the current session can update the specified object (and its children). If you specify checkOutType=Shared, the check-out does not lock the object; it merely prevents other sessions from locking the object (and its parents).

DefaultEXCLUSIVE

ObjectSelector={objType="ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}

specifies the type of object that you want to check out.

AliascheckOutObject

The value that you specify for the objType parameter determines the other parameters that apply.

Parameters for objType="ACTION"

action="string"

specifies the action name.

* actionSet="string"

specifies the action set name.

Parameters for objType="ACTIONSET"

actionSet="string"

specifies the action set name.

Parameters for objType="CASLIB"

* caslib="string"

specifies the caslib name.

Parameters for objType="COLUMN"

* caslib="string"

specifies the caslib name.

column="string"

specifies the column name.

* table="string"

specifies the table name.

Parameters for objType="TABLE"

* caslib="string"

specifies the caslib name.

table="string"

specifies the table name.

checkOutObject Action

Reserves an object (and all of its children) for update by only the current client session. Prevents an object (and all of its parents) from being checked out exclusively by another session if checkOutType=Shared.

See:About Transactions
Example:Preview the Results of Access Control Changes

Python Syntax

Développer toutRéduire tout
results=s.accessControl.checkOutObject(
checkoutParent=True | False,
checkOutType="EXCLUSIVE" | "SHARED",
ObjectSelector={"objType":"ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}
)

Parameter Descriptions

checkoutParent=True | False

indicates whether to check out the parent object if the specified object does not exist.

DefaultFalse

checkOutType="EXCLUSIVE" | "SHARED"

specifies the type of check-out. By default, a check-out is exclusive, so only the current session can update the specified object (and its children). If you specify checkOutType=Shared, the check-out does not lock the object; it merely prevents other sessions from locking the object (and its parents).

DefaultEXCLUSIVE

ObjectSelector={"objType":"ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}

specifies the type of object that you want to check out.

AliascheckOutObject

The value that you specify for the objType parameter determines the other parameters that apply.

Parameters for objType="ACTION"

"action":"string"

specifies the action name.

* "actionSet":"string"

specifies the action set name.

Parameters for objType="ACTIONSET"

"actionSet":"string"

specifies the action set name.

Parameters for objType="CASLIB"

* "caslib":"string"

specifies the caslib name.

Parameters for objType="COLUMN"

* "caslib":"string"

specifies the caslib name.

"column":"string"

specifies the column name.

* "table":"string"

specifies the table name.

Parameters for objType="TABLE"

* "caslib":"string"

specifies the caslib name.

"table":"string"

specifies the table name.

checkOutObject Action

Reserves an object (and all of its children) for update by only the current client session. Prevents an object (and all of its parents) from being checked out exclusively by another session if checkOutType=Shared.

See:About Transactions
Example:Preview the Results of Access Control Changes

R Syntax

Développer toutRéduire tout
results <– cas.accessControl.checkOutObject(s,
checkoutParent=TRUE | FALSE,
checkOutType="EXCLUSIVE" | "SHARED",
ObjectSelector=list(objType="ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters)
)

Parameter Descriptions

checkoutParent=TRUE | FALSE

indicates whether to check out the parent object if the specified object does not exist.

DefaultFALSE

checkOutType="EXCLUSIVE" | "SHARED"

specifies the type of check-out. By default, a check-out is exclusive, so only the current session can update the specified object (and its children). If you specify checkOutType=Shared, the check-out does not lock the object; it merely prevents other sessions from locking the object (and its parents).

DefaultEXCLUSIVE

ObjectSelector={objType="ACTION" | "ACTIONSET" | "CASLIB" | "COLUMN" | "TABLE", objType-specific-parameters}

specifies the type of object that you want to check out.

AliascheckOutObject

The value that you specify for the objType parameter determines the other parameters that apply.

Parameters for objType="ACTION"

action="string"

specifies the action name.

* actionSet="string"

specifies the action set name.

Parameters for objType="ACTIONSET"

actionSet="string"

specifies the action set name.

Parameters for objType="CASLIB"

* caslib="string"

specifies the caslib name.

Parameters for objType="COLUMN"

* caslib="string"

specifies the caslib name.

column="string"

specifies the column name.

* table="string"

specifies the table name.

Parameters for objType="TABLE"

* caslib="string"

specifies the caslib name.

table="string"

specifies the table name.

Last updated: February 25, 2026