versioning

versioning

versioning

Functions to handle versioning of objects

Metadata

Instantiating

approveEmail_approved()

Sends out email informing lastupdated user that object has been approved

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object that has had status changed
comment string Yes Comments that were entered when status was changed

approveEmail_approved_dd()

Sends out email informing lastupdated user that object has been approved

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object that has had status changed
comment string Yes Comments that were entered when status was changed
lApprovers string Yes all List of approvers to send email to

approveEmail_draft()

Sends out email informing lastupdated user that object has been sent back to draft

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object that has had status changed
comment string Yes Comments that were entered when status was changed

approveEmail_draft_dd()

Sends out email informing lastupdated user that object has been sent back to draft

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object that has had status changed
comment string Yes Comments that were entered when status was changed

approveEmail_pending()

Sends out email to list of approvers to approve/decline object

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object that has had status changed
comment string Yes Comments that were entered when status was changed
lApprovers string Yes all List of approvers to send email to

approveEmail_pending_dd()

Sends out email to list of approvers to approve/decline object

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object that has had status changed
comment string Yes Comments that were entered when status was changed

archiveObject()

Archives any farcry object

Arguments

Name Type Required Default Options Description
objectID uuid Yes
typename string No

checkEdit()

See if we can edit this object

Arguments

Name Type Required Default Options Description
stRules struct Yes
stObj struct Yes

checkIsDraft()

Checks to see if object is an underlying draft object

Arguments

Name Type Required Default Options Description
objectId UUID Yes The ObjectId of object to be checked
type string Yes Object type to be checked
dsn string Yes [runtime expression] Database DSN

getArchiveDetail()

returns one archive

Arguments

Name Type Required Default Options Description
objectID uuid Yes

getArchives()

returns all archives for a given object

Arguments

Name Type Required Default Options Description
objectID uuid Yes

getVersioningRules()

Returns a structure of boolean rules concerning the editing of farcry objects

Arguments

Name Type Required Default Options Description
objectID uuid Yes
typename string No

rollbackArchive()

Sends a archived object live and archives current version

Arguments

Name Type Required Default Options Description
objectID uuid Yes
archiveID uuid Yes the archived object to be sent back live
typename string No

sendObjectLive()

Sends a versioned object with draft live.Archives existing live object if it exists and deletes old live object

Arguments

Name Type Required Default Options Description
objectID uuid Yes
stDraftObject struct Yes the draft stuct to be updated
typename string No Providing typename avoids a type-lookup from the objectid, offering a slight performance increase.
bCopyDraftContainers boolean No true Containers configured for the draft object will be copied when the object is sent live.