Collection

An SMS Collection object contains information on how to identify members of the collection, and on how recently membership in the collection has been refreshed.

Table B.4 Collection (SMS_Collection)

PropertyData typeExampleNotes
CollectionIDstring"SMS00001"Indicates the unique identifier of the collection on this SMS site server.
CollectionRules[]SMS_
CollectionRule
Appears as an array of objects.Lazy. An array of SMS_CollectionRuleQuery or SMS_CollectionRuleDirect objects that define the membership criteria for this collection.
Commentstring"Any comment."A comment that applies to the collection.
CurrentStatusuint321The current status of the collection.

Values are:
0 = NONE(0)
1 = READY
2 = REFRESHING
3 = SAVING
4 = EVALUATING
5 = AWAITING_REFRESH
6 = DELETING
7 = APPENDING_MEMBER
8 = QUERYING

LastChangeTimedatetimeSee “Date and Time Formats” at the beginning of this appendix.The last time the collection was altered in any way.
LastRefreshTimedatetimeSee “Date and Time Formats” at the beginning of this appendix.The last time the collection membership was refreshed.
MemberClassNamestring"SMS_CM_RES_
COLL_SMS00001"
This property is the class name whose instances are the members of this collection.
Namestring"All Systems"The name of the collection.
OwnedByThisSiteBooleanTRUELazy. This value, when set to true, denotes that the collection originated from the local SMS site.

Values are:
TRUE
FALSE

RefreshSchedule[]SMS_
Schedule
Token
 An array of schedule tokens that define when the collection will be updated.
RefreshTypeuint322Lazy. Defines if SMS will automatically refresh the collection, or whether it will only be manually updated.

Values are:
1 = MANUAL
2 = PERIODIC

ReplicateToSubSitesBooleanFALSELazy. This value, when set to true, denotes that the collection will be shared with any children SMS sites.

Values are:
TRUE
FALSE