Class which lists things coming to or from the client as part of the CCR process. More...

Inheritance diagram for ItemSet:

[legend]

Collaboration diagram for ItemSet:

[legend]

Public Member Functions
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	Create (pItems, pJob, pCreatedBy, pLabel, pTarget, pCCR, pEnv)
	Method to create a ItemSet and Payload file which can be passed to another system for import. More...

_.Library.Status	ExportToFile (pItemSetFile)
	Export the ItemSet to the file system.

_.Library.Status	LoadToNS (_.Library.String pQspec, pLoadedlist, _.Library.Boolean pListonly, _.Library.Boolean pCompileProject, _.Library.String pIncPercent, _.Library.String pProjectName)
	Loads the files from the file system into the namespace; creates a project and (optionally) compiles the project. More...

_.Library.Status	LoadToOS (_.Library.String pQspec, _.Library.String pErrorlog, _.Library.String pLoadedlist, _.Library.String pReadWrite, _.Library.Boolean pListonly, _.Library.Boolean pOverwrite, pP4user, pP4pass)
	Load the items in this ItemSet into the local file system. More...

	LogToggle (pIO)
	Logging instance method for this object; redirects IO to ..Log, and then saves it to ..LogHistory and saves the object when logging is turned off.

_.Library.Status	P4SubmitItemSet (_.Library.String pQspec, _.Library.String pErrorlog, _.Library.String pLoadedlist, _.Library.String pP4user, _.Library.String pP4pass)
	Logic used on the server to submit contents of a ChangeList to Perforce.

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
_.Library.Status	Bundle (_.Library.Boolean pInteractive, _.Library.Boolean pIncludeAllUncommitted, pCCR, pCreatedBy, pPerformUpload, pEmailRecipient)
	Wrapper method for bundling pending changes, and added them to an ItemSet which can be uploaded to CCR for check-in. More...

_.Library.Status	ChangeWritableState (pList, _.Library.Boolean pReadOnly, _.Stream.Object pLog)
	method takes a file name, or an array of filenames, and changes the pReadonly state to the pReadOnly value

_.Library.Status	CheckWritableState (pList, pReadOnly, pReadWrite, pAbsent, _.Stream.Object pLog)
	Given a list of files on the OS, returns a list of those that are Readonly, and a list of those that are writable.

_.Library.Status	DisplayLog (pID)
	Displays the LogHistory of an ItemSet.

	Download (_.Library.Boolean pLoad)
	Wrapper method for interactively downloading list of ItemSets from server via Web Service, and then selecting and saving one to disk.

_.Library.Status	Export (pID, pItemSetFile)
	Export the ItemSet to the file system.

_.Library.Status	FindReplaceInFile (pFind, pReplace, pFile, pExtensionRename, _.Stream.Object pLog)
	as cspapplication paths must be unique, if multiple namespaces on this instance need to send/receive More...

_.Library.Status	GetPathTranslation (pRoot, pPath)
	the Utility CSPApplication, called '/itemsetsourcelink*' acts as a mechanism to 'tar' and 'untar' ItemSets for transport to/from Server/Client More...

_.Library.Boolean	HasInstancePrimaryNamespace (_.Library.String namespace)
	check for and return Instance Wide Primary Namespace if it is definted and exists

_.Library.Boolean	IRISLIBReadOnly (mode)
	Utility method to change mount setting for IRISLIB; passing no mode argument will return the current status.

_.Library.Status	Import (pItemSetFile, _.Studio.SourceControl.ItemSet pObj, _.Library.String pServerISID, _.Library.String pToken)
	Import a ItemSet from the file system.

_.Library.Numeric	InstanceVersion ()
	Returns value the Major.Minor version for this instance, so it can be used in comparison code which makes sure certain features are used in appropriate versions.

_.Library.Boolean	IsValidOSProcessName (pCurrentProcess, pSServer)
	Utility method to check the OS username of the current process make sure for UNIX it matches the username that the Super Server is running as.

_.Library.Status	Load (_.Library.Boolean pInteractive, pItemSetFile, _.Library.Boolean pLoadToOS, _.Library.Boolean pOverwrite, _.Library.Boolean pLoadToNS, _.Library.Boolean pCompile, pQspec, pP4user, pP4pass, _.Library.String pNewID, pServerISID, pToken)
	Wrapper method for importing, loading to file system (OS), loading to namespace and compiling ItemSet into this namespace. More...

_.Library.Status	LoadPayload (pPayloadFile, pQspec, pErrorlog, pLoadedlist, pListOnly, pToLoad)
	Method to load an unpacked itemset. More...

_.Library.String	LogTags ()
	holder method for output redirect tags; returns the name of the compiled routine where these tags exist More...

	LogToggleCore (pIO, _.Stream.Object pLog)
	Logging class method; redirects IO to either a Stream.GlobalCharacter or a Stream.FileCharacter.

_.Library.Status	NameCVT (pNameList, _.Library.Boolean pValidate, _.Library.Boolean pDropLeadingSlash)
	takes an item name (or an array of names), and converts it from the file system representation to the csp application representation, or vice versa More...

_.Library.Integer	ServerItemSetCount (pCCR)
	Returns the count of ItemSets destined for the Server.

	SetUpProxyUnauth (_.SOAP.WebClient ws)
	Proxy configuration for un-authenticated proxy connection.

_.Library.Status	Upload (_.Library.Boolean pInteractive, pCCR, pToken, pItemSetFile, pEmailRecipient)
	Wrapper method for Uploading uncommitted changes to CCR for check-in. More...

_.Library.Boolean	ValidateCCR (_.Library.String siteCode, _.Library.String sysCode, _.Library.String state, reasonString)
	Method to validate a CCR for Upload given a CCR ID and Token.

_.Library.String	VersionPostfix ()
	Version string used to append to environment name when transmitting data to the CCR Server web services. More...

_.Library.Status	WSConfirmLoad (_.Library.String pISID, _.Library.String pJob, _.Library.String pEnv, _.Library.String pToken, _.Library.Status pLoadStatus, _.Library.GlobalCharacterStream pLog)
	Wrapper that calls ConfirmLoad WebService to send back the results of an ItemSetLoad.

_.Library.Status	WSDownload (_.Library.String pJob, _.Library.String pEnv, _.Library.String pToken, _.Library.String pDir, _.Library.String pISID, _.Library.String pFilename)
	Wrapper that calls Download WebService to download an ItemSet XML for a given ID to the local filesystem.

_.Library.Status	WSList (_.Library.String pJob, _.Library.String pEnv, _.Library.String pToken, _.XML.DataSet pRS)
	Wrapper that calls List WebService to get a result-set listing ItemSets for a given pJob and pEnv.

_.Library.Status	WSUpload (_.Library.String pItemSetFile, _.Library.String pCCR, _.Library.String pToken, _.Library.String pEmailRecipient)
	Wrapper that calls Upload WebService to upload an ItemSet XML for a given ID to the ItemSet Server.

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	CCR
	CCR for which this ItemSet was created. More...

	Changelists
	If ItemSet is generated by CCR, this contains a list of changelist numbers that are included in this ItemSet. More...

	ClientResponses
	Tracks the deployment of the ItemSet to Primary and Secondary Environments by EID using same values as Deployed (0,1,2,3) More...

	Committed
	Indicates that this ItemSet (created on a Client) has been committed to Perforce by the CCR Server. More...

	CommittedTimestamp
	Time the ItemSet was committed to Perforce. More...

	CreateTimestamp
	Time the ItemSet was created. More...

	CreatedBy
	User who created or imported this ItemSet; this should be a CCR Username. More...

	Deployed
	Indicates the status of the deployment of this ItemSet. More...

	DeployedTimestamp
	Time the ItemSet was deployed. More...

	Environment
	Environment for/from which this ItemSet was created. More...

	ExportTimestamp
	Time the ItemSet was exported. More...

	FileLabel
	Additional identifying Label for the Payload filename. More...

	ImportTimestamp
	Time the ItemSet was imported. More...

	ItemList
	List of Items in this ItemSet, where the key is the item name, and the value is add/edit/delete/failed. More...

	ItemSetFile
	Location path and filename on local file system where exported XML for this ItemSet is stored. More...

	ItemSetFilename
	name of ItemSet file for this ItemSet More...

	Job
	Perforce Job that was exported in this ItemSet; or Job associated with this CCR on this Server. More...

	Log
	Global stream storing the most recent Log for this system. More...

	LogHistory
	Global stream storing the cumulative logs for this ItemSet on this system. More...

	Name
	readable name of this ItemSet; used for file names and project name More...

	Payload
	Object forthe payload file for this ItemSet. More...

	PayloadFile
	Location on local file system where Payload for this ItemSet is stored. More...

	PayloadFilename
	name of Payload for this ItemSet More...

	ServerItemSetID
	Transient property to store the server-side ID for this ItemSet. More...

	SessionToken
	Transient property to store the session token to pull this ItemSet from the Server. More...

	SiteCode
	Site Code for which this ItemSet was created. More...

	Source
	Name of the server where this ItemSet was created. More...

	System
	System for which this CCR was created. More...

	Target
	generic intended destination for this ItemSet More...

Static Public Attributes
	CSPAppLink = None
	Class which lists things coming to or from the client as part of the CCR process. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	SrcVer = None
	This Parameter should be updated when synced from Perforce.

	Version = None
	Revision number of this class when compiled as part of the //custom_ccrs/_common/config/... More...

Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

Class which lists things coming to or from the client as part of the CCR process.

Member Function Documentation

◆ OnAddToSaveSet()

_.Library.Status OnAddToSaveSet	(	_.Library.Integer	depth,
		_.Library.Integer	insert,
		_.Library.Integer	callcount
	)

This callback method is invoked when the current object is added to the SaveSet,.

either because Save() was invoked on this object or on an object that references this object. OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking AddToSaveSet or remove objects by calling RemoveFromSaveSet.

If this method returns an error status then Save() will fail and the transaction will be rolled back.

◆ Bundle()

_.Library.Status Bundle	(	_.Library.Boolean	pInteractive,
		_.Library.Boolean	pIncludeAllUncommitted,
			pCCR,
			pCreatedBy,
			pPerformUpload,
			pEmailRecipient
	)

static

Wrapper method for bundling pending changes, and added them to an ItemSet which can be uploaded to CCR for check-in.

Can be either interactive or scripted

◆ Create()

_.Library.Status Create	(	pItems,
		pJob,
		pCreatedBy,
		pLabel,
		pTarget,
		pCCR,
		pEnv
	)

Method to create a ItemSet and Payload file which can be passed to another system for import.

pItems is an array subscripted by the item name (full file name on file system), with a value of add/edit/delete

◆ FindReplaceInFile()

_.Library.Status FindReplaceInFile	(		pFind,
			pReplace,
			pFile,
			pExtensionRename,
		_.Stream.Object	pLog
	)

static

as cspapplication paths must be unique, if multiple namespaces on this instance need to send/receive

ItemSets, then we may be using a secondary cspApp naming convention which is '/..CSPAppLink<Namespace>/' When this is the case, this method exchanges the values in an XML file on disk to or from the standard (/..CSPAppLink/) or local csp application name.

◆ GetPathTranslation()

_.Library.Status GetPathTranslation	(	pRoot,
		pPath
	)

static

the Utility CSPApplication, called '/itemsetsourcelink*' acts as a mechanism to 'tar' and 'untar' ItemSets for transport to/from Server/Client

this makes sure that the CSP Application is defined for this namespace, and finds where it points on the file system

◆ Load()

_.Library.Status Load	(	_.Library.Boolean	pInteractive,
			pItemSetFile,
		_.Library.Boolean	pLoadToOS,
		_.Library.Boolean	pOverwrite,
		_.Library.Boolean	pLoadToNS,
		_.Library.Boolean	pCompile,
			pQspec,
			pP4user,
			pP4pass,
		_.Library.String	pNewID,
			pServerISID,
			pToken
	)

static

Wrapper method for importing, loading to file system (OS), loading to namespace and compiling ItemSet into this namespace.

Can be either interactive or scripted

◆ LoadPayload()

_.Library.Status LoadPayload	(	pPayloadFile,
		pQspec,
		pErrorlog,
		pLoadedlist,
		pListOnly,
		pToLoad
	)

static

Method to load an unpacked itemset.

This handles IRIS to Cache conversion

◆ LoadToNS()

_.Library.Status LoadToNS	(	_.Library.String	pQspec,
			pLoadedlist,
		_.Library.Boolean	pListonly,
		_.Library.Boolean	pCompileProject,
		_.Library.String	pIncPercent,
		_.Library.String	pProjectName
	)

Loads the files from the file system into the namespace; creates a project and (optionally) compiles the project.

When pCompileProject=1, the project will be compiled after load is complete

When pCompileProject=2, the project will only be compiled after load if the ItemSet does not contain this class in it's payload (i.e. pIncPercent'=2)

◆ LoadToOS()

_.Library.Status LoadToOS	(	_.Library.String	pQspec,
		_.Library.String	pErrorlog,
		_.Library.String	pLoadedlist,
		_.Library.String	pReadWrite,
		_.Library.Boolean	pListonly,
		_.Library.Boolean	pOverwrite,
			pP4user,
			pP4pass
	)

Load the items in this ItemSet into the local file system.

If the file already exists and is ReadOnly, then it will be changed to ReadWrite, loaded to the OS, and then marked as ReadOnly again If the file exists and is ReadWrite, it will not be overwritten by the ItemSet load, unless pOverwrite is set to true

◆ LogTags()

_.Library.String LogTags ( )

static

holder method for output redirect tags; returns the name of the compiled routine where these tags exist

[Previously private]

◆ NameCVT()

_.Library.Status NameCVT	(		pNameList,
		_.Library.Boolean	pValidate,
		_.Library.Boolean	pDropLeadingSlash
	)

static

takes an item name (or an array of names), and converts it from the file system representation to the csp application representation, or vice versa

if pName includes a Perforce version identifier (e.g. <file>#<ver> ignore the version when validating the file's existence

When <argument>pValidate</argument> is '1', the method will confirm that the file exists.

◆ Upload()

_.Library.Status Upload	(	_.Library.Boolean	pInteractive,
			pCCR,
			pToken,
			pItemSetFile,
			pEmailRecipient
	)

static

Wrapper method for Uploading uncommitted changes to CCR for check-in.

Can be either interactive or scripted

◆ VersionPostfix()

_.Library.String VersionPostfix ( )

static

Version string used to append to environment name when transmitting data to the CCR Server web services.

Uses '@' as postfix piece separator and avoids

use of ":" which can be used to indicate a secondary postfix of EnvID

Member Data Documentation

◆ CSPAppLink

CSPAppLink = None

static

Class which lists things coming to or from the client as part of the CCR process.

This is the string used for naming the default proxy CSPApplication that is referenced for exporting/importing files

◆ MANAGEDEXTENT

MANAGEDEXTENT = None

static

The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager.

to ignore this class. If set to 1 then the Extent Manager will register globals used by the class and detect collisions. Unmanaged extents (MANAGEDEXTENT = 0) are not checked.
Currently, only classes using default storage (Storage.Persistent) can be managed.

This is required since each Namespace will have it's own Change extent

◆ Version

Version = None

static

Revision number of this class when compiled as part of the //custom_ccrs/_common/config/...

branch.

This version will not be updated (by design) when the class is integrated to other branches. This allows the user to tell what version of the Studio client tools are in use.

◆ CCR

CCR

CCR for which this ItemSet was created.

◆ Changelists

Changelists

If ItemSet is generated by CCR, this contains a list of changelist numbers that are included in this ItemSet.

◆ ClientResponses

ClientResponses

Tracks the deployment of the ItemSet to Primary and Secondary Environments by EID using same values as Deployed (0,1,2,3)

Does not need abandoned or stale since these are specific to the whole ItemSet

a value of 0 means that it has not been deployed

a value of 1 means that it has been downloaded but not yet deployed

a value of 2 means that it has been deployed successfully

a value of 3 means that there has been an attempt to deploy but there was an error

◆ Committed

Committed

Indicates that this ItemSet (created on a Client) has been committed to Perforce by the CCR Server.

a value of 0 means that it has not been committed

a value of 1 means that it is currently being committed

a value of 2 means that it has been committed successfully

a value of -1 means that it has been aborted

◆ CommittedTimestamp

CommittedTimestamp

Time the ItemSet was committed to Perforce.

◆ CreateTimestamp

CreateTimestamp

Time the ItemSet was created.

◆ CreatedBy

CreatedBy

User who created or imported this ItemSet; this should be a CCR Username.

◆ Deployed

Deployed

Indicates the status of the deployment of this ItemSet.

a value of 0 means that it has not been deployed

a value of 1 means that it has been downloaded but not yet deployed

a value of 2 means that it has been deployed successfully

a value of 3 means that there has been an attempt to deploy but there was an error

a value of -1 means that it has been abandoned

◆ DeployedTimestamp

DeployedTimestamp

Time the ItemSet was deployed.

◆ Environment

Environment

Environment for/from which this ItemSet was created.

◆ ExportTimestamp

ExportTimestamp

Time the ItemSet was exported.

◆ FileLabel

FileLabel

Additional identifying Label for the Payload filename.

◆ ImportTimestamp

ImportTimestamp

Time the ItemSet was imported.

◆ ItemList

ItemList

List of Items in this ItemSet, where the key is the item name, and the value is add/edit/delete/failed.

◆ ItemSetFile

ItemSetFile

Location path and filename on local file system where exported XML for this ItemSet is stored.

◆ ItemSetFilename

ItemSetFilename

name of ItemSet file for this ItemSet

◆ Job

Job

Perforce Job that was exported in this ItemSet; or Job associated with this CCR on this Server.

◆ Log

Log

Global stream storing the most recent Log for this system.

◆ LogHistory

LogHistory

Global stream storing the cumulative logs for this ItemSet on this system.

◆ Name

Name

readable name of this ItemSet; used for file names and project name

◆ Payload

Payload

Object forthe payload file for this ItemSet.

◆ PayloadFile

PayloadFile

Location on local file system where Payload for this ItemSet is stored.

◆ PayloadFilename

PayloadFilename

name of Payload for this ItemSet

◆ ServerItemSetID

ServerItemSetID

Transient property to store the server-side ID for this ItemSet.

◆ SessionToken

SessionToken

Transient property to store the session token to pull this ItemSet from the Server.

◆ SiteCode

SiteCode

Site Code for which this ItemSet was created.

◆ Source

Source

Name of the server where this ItemSet was created.

◆ System

System

System for which this CCR was created.

◆ Target

Target

generic intended destination for this ItemSet

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ OnAddToSaveSet()

◆ Bundle()

◆ Create()

◆ FindReplaceInFile()

◆ GetPathTranslation()

◆ Load()

◆ LoadPayload()

◆ LoadToNS()

◆ LoadToOS()

◆ LogTags()

◆ NameCVT()

◆ Upload()

◆ VersionPostfix()

Member Data Documentation

◆ CSPAppLink

◆ MANAGEDEXTENT

◆ Version

◆ CCR

◆ Changelists

◆ ClientResponses

◆ Committed

◆ CommittedTimestamp

◆ CreateTimestamp

◆ CreatedBy

◆ Deployed

◆ DeployedTimestamp

◆ Environment

◆ ExportTimestamp

◆ FileLabel

◆ ImportTimestamp

◆ ItemList

◆ ItemSetFile

◆ ItemSetFilename

◆ Job

◆ Log

◆ LogHistory

◆ Name

◆ Payload

◆ PayloadFile

◆ PayloadFilename

◆ ServerItemSetID

◆ SessionToken

◆ SiteCode

◆ Source

◆ System

◆ Target