OnUnCheckIn.LST script file

<< Click to Display Table of Contents >>

Navigation:  Programming Mechworks PDM > DBWCommandShell > Event Scripts > Revision >

OnUnCheckIn.LST script file

Description

it is executed when un-checkin-in a document.

Using this script it is possible to control the way a document is unchecked in, basing on rules that can be implemented in the script itself.

Location

LST folder

Activation

Options→Revisions

Input

@DOCUMENT_UNIQUE_ID

uid of the doc to uncheckin

@IS_LINKED_DOCUMENT

the currently processed document is
0: the selected/active document
1: a linked document
It allows the script to understand if it is called when unchecking-in the main active document (or the currently selected document in the browser) or if the uncheck-in happens because a related document is being processed by the Drawing↔Part Link Mode manager.

@IS_POST_EVENT

<0/1>
0: the uncheck-in is to be executed
1:the uncheck-in has been completed.
When @IS_LINKED_DOCUMENT is equal to "1", @IS_POST_EVENT is always 1".

Output

@OKUNCHECKIN

0: fail
1: ok to proceede

Remarks

The OnUnCheckIn.LST script is called two times:

1.BEFORE the actual uncheckin operation

2.AFTER the uncheckin operation has been executed

See also

OnCheckin.LST script file