Session Properties Action Set: Syntax

Provides actions for managing session properties

saveFmtLib Action

Saves a format library.

Example:

Save a Format Library to Disk

CASL Syntax

Expand all Collapse all

sessionProp.saveFmtLib <result=results> <status=rc> /

caslib="string",

fmtLibName="string",

name="table-name",

path="string",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

saveForEP=TRUE | FALSE

;

indicates a required parameter

Parameter Descriptions

caslib="string"

specifies the caslib in which the format library is saved.

Requirement	You must have Write access to the specified caslib.

* fmtLibName="string"

specifies the format library name.

name="table-name"

specifies the format library name in the caslib.

Requirement	You must specify parameter name.
Notes	You can specify the name with or without the .sashdat file extension.
Notes	Do not change the name of the format library file after you save it. If you change the file name, the format library that it contains cannot be loaded.

path="string"

specifies the path to where the format library is saved.

promote=TRUE | FALSE

promotes a format library to global scope for all sessions.

Note	The CAS server can be configured to require administrative Superuser authority to promote a user-defined format library to global scope. By default, it is not required. If administrative Superuser authority is required and you are a CAS administrator, you must use the accessControl.assumeRole action to assume the Superuser role before you promote the format library. See assumeRole. If you do not have administrative authority, you must contact your CAS administrator to promote your user-defined format library.

Note

The CAS server can be configured to require administrative Superuser authority to promote a user-defined format library to global scope. By default, it is not required. If administrative Superuser authority is required and you are a CAS administrator, you must use the accessControl.assumeRole action to assume the Superuser role before you promote the format library. See assumeRole. If you do not have administrative authority, you must contact your CAS administrator to promote your user-defined format library.

replace=TRUE | FALSE

specifies to replace the format library if it already exists.

Default	FALSE

saveForEP=TRUE | FALSE

Save in a form optimized for SAS Embedded Process use

Default	TRUE

saveFmtLib Action

Saves a format library.

Example:

Save a Format Library to Disk

Lua Syntax

Expand all Collapse all

results, info = s:sessionProp_saveFmtLib{

caslib="string",

fmtLibName="string",

name="table-name",

path="string",

promote=true | false,

replace=true | false,

saveForEP=true | false

}

indicates a required parameter

Parameter Descriptions

caslib="string"

specifies the caslib in which the format library is saved.

Requirement	You must have Write access to the specified caslib.

* fmtLibName="string"

specifies the format library name.

name="table-name"

specifies the format library name in the caslib.

Requirement	You must specify parameter name.
Notes	You can specify the name with or without the .sashdat file extension.
Notes	Do not change the name of the format library file after you save it. If you change the file name, the format library that it contains cannot be loaded.

path="string"

specifies the path to where the format library is saved.

promote=true | false

promotes a format library to global scope for all sessions.

Note	The CAS server can be configured to require administrative Superuser authority to promote a user-defined format library to global scope. By default, it is not required. If administrative Superuser authority is required and you are a CAS administrator, you must use the accessControl.assumeRole action to assume the Superuser role before you promote the format library. See assumeRole. If you do not have administrative authority, you must contact your CAS administrator to promote your user-defined format library.

Note

replace=true | false

specifies to replace the format library if it already exists.

Default	false

saveForEP=true | false

Save in a form optimized for SAS Embedded Process use

Default	true

saveFmtLib Action

Saves a format library.

Example:

Save a Format Library to Disk

Python Syntax

Expand all Collapse all

results=s.sessionProp.saveFmtLib(

caslib="string",

fmtLibName="string",

name="table-name",

path="string",

promote=True | False,

replace=True | False,

saveForEP=True | False

)

indicates a required parameter

Parameter Descriptions

caslib="string"

specifies the caslib in which the format library is saved.

Requirement	You must have Write access to the specified caslib.

* fmtLibName="string"

specifies the format library name.

name="table-name"

specifies the format library name in the caslib.

Requirement	You must specify parameter name.
Notes	You can specify the name with or without the .sashdat file extension.
Notes	Do not change the name of the format library file after you save it. If you change the file name, the format library that it contains cannot be loaded.

path="string"

specifies the path to where the format library is saved.

promote=True | False

promotes a format library to global scope for all sessions.

Note	The CAS server can be configured to require administrative Superuser authority to promote a user-defined format library to global scope. By default, it is not required. If administrative Superuser authority is required and you are a CAS administrator, you must use the accessControl.assumeRole action to assume the Superuser role before you promote the format library. See assumeRole. If you do not have administrative authority, you must contact your CAS administrator to promote your user-defined format library.

Note

replace=True | False

specifies to replace the format library if it already exists.

Default	False

saveForEP=True | False

Save in a form optimized for SAS Embedded Process use

Default	True

saveFmtLib Action

Saves a format library.

Example:

Save a Format Library to Disk

R Syntax

Expand all Collapse all

results <– cas.sessionProp.saveFmtLib(s,

caslib="string",

fmtLibName="string",

name="table-name",

path="string",

promote=TRUE | FALSE,

replace=TRUE | FALSE,

saveForEP=TRUE | FALSE

)

indicates a required parameter

Parameter Descriptions

caslib="string"

specifies the caslib in which the format library is saved.

Requirement	You must have Write access to the specified caslib.

* fmtLibName="string"

specifies the format library name.

name="table-name"

specifies the format library name in the caslib.

Requirement	You must specify parameter name.
Notes	You can specify the name with or without the .sashdat file extension.
Notes	Do not change the name of the format library file after you save it. If you change the file name, the format library that it contains cannot be loaded.

path="string"

specifies the path to where the format library is saved.

promote=TRUE | FALSE

promotes a format library to global scope for all sessions.

Note	The CAS server can be configured to require administrative Superuser authority to promote a user-defined format library to global scope. By default, it is not required. If administrative Superuser authority is required and you are a CAS administrator, you must use the accessControl.assumeRole action to assume the Superuser role before you promote the format library. See assumeRole. If you do not have administrative authority, you must contact your CAS administrator to promote your user-defined format library.

Note

replace=TRUE | FALSE

specifies to replace the format library if it already exists.

Default	FALSE

saveForEP=TRUE | FALSE

Save in a form optimized for SAS Embedded Process use

Default	TRUE

Last updated: September 13, 2026