Print Page as PDF
CALLS TO TIUCOP ICR (6211)

CALLS TO TIUCOP    ICR (6211)

Name Value
NUMBER 6211
IA # 6211
DATE CREATED 2015/07/31
CUSTODIAL PACKAGE TEXT INTEGRATION UTILITIES
USAGE Controlled Subscription
TYPE Routine
ROUTINE TIUCOP
NAME CALLS TO TIUCOP
GENERAL DESCRIPTION
This DBIA documents calls to routine TIUCOP, which are
used to implement Copy/Paste tracking functionality.
STATUS Pending
ID TIUCOP
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$PCT
Returns the copy/paste verification percentage.

Output
- Percent pasted text matches copied text needed to be considered
as derived from the copied text (example ".5")
Or
Error condition "-1^Error Msg"
VARIABLES TYPE VARIABLES DESCRIPTION
INST Input
This is the institution ien (#4).
$$EXC
This returns whether a note is excluded from
copy/paste tracking.

Output
- Boolean (1: Exclude, 0:Don't Exclude)
Or
Error condition "-1^Error Msg"
VARIABLES TYPE VARIABLES DESCRIPTION
TIUDA Input
This is the TIU note ien (#8925).
$$WORDS
This returns the number of words required to begin
tracking copied text as part of the Copy/Paste Tracking functionality.
VARIABLES TYPE VARIABLES DESCRIPTION
INST Input
This is the logged in Institution (#4) of the user.
GETCOPY
This retrieves the copy buffer information.
VARIABLES TYPE VARIABLES DESCRIPTION
INST Input
This is the Institution (#4) of the logged in user.
DFN Input
This is the DUZ of the user.
ARY Output
This is the array which is returned with the copy
buffer information.
STRT Input
This is an optional variable. This is the starting
entry to find copy buffer data.
$$PUTCOPY
Saves copy buffer information for copy/paste.
VARIABLES TYPE VARIABLES DESCRIPTION
ARY Input
This is the input array containing the Copied text
information for storing.
ERR Both
This is the array name to receive error messages.
INST Input
Institution (#4) user is signed into.
CHKPASTE
This checks if a note (#8925) has pasted text data
stored.
VARIABLES TYPE VARIABLES DESCRIPTION
INST Input
This is the Institution (#4) of the logged in user.
DOC Input
This is the TIU note document ien (#8925) to search
for pasted text.
$$VIEW
This component returns the copy/paste tracking
viewing privileges of the specified user.
VARIABLES TYPE VARIABLES DESCRIPTION
USER Input
This is the DUZ of the user who's privileges to view
copy/paste are being determined.
IEN Input
This is the TIU Note IEN (#8925) to have the user
checked against.  This is optional and only needed if you are checking a
specific users viewing rights for a specific Note as the Author or Cosigner of
said note.
INST Input
This is the Institution (#4) the user is logged into.

GETPASTE
This retrieves copy/paste tracked pasted text.
VARIABLES TYPE VARIABLES DESCRIPTION
TIUIEN Input
This is the TIU Note IEN (#8925) in which the pasted
text exists.
INST Input
This is the Institution (#4) of the logged in user.
APP Input
This is the application which is retrieving the
pasted text.
ARY Both
This is the name of the array to return pasted text.
$$PUTPASTE
Saves pasted text for the Copy/Paste Tracking
functionality.
VARIABLES TYPE VARIABLES DESCRIPTION
INST Input
This is the Institution (#4) of the logged in user.
ARY Input
This is the array containing the pasted text
information to be saved.
ERR Both
This is the name of the error array to retrieve error
information.
RSLT Output
This is an output array of the results of each save
of the paste information which was sent in the ARY array.
START
Queues processes to build the copy/paste copy buffer
for a specified user utilizing a GUI.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
This is the user DUZ.
IP Input
This is the IP address of the connecting computer
running the GUI.
HWND Input
This is the Windows Handle passed in from the GUI.
DIV Input
This is the division ien of the Institution (#4) file
the user is logged in to.
VAL Output
The return provides the success of starting the
background process.
1 = Success
0 = Failure
POLL
This polls the copy buffer retrieval background task
for completion and returns data as it becomes available.  This entry should be
called until the done indicator is received.  This call is to be used in
conjunction with the START Component/Entry Point.  START compiles the data
which is retrieved by the POLL.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
This is the user DUZ.
IP Input
This is the IP address of the connecting computer
running the GUI.
HWND Input
This is the Windows Handle passed in from the GUI
application.
LST Output
This RPC will return an array containing the results
of the copy buffer background retrieval process.  If the process has not
completed, it will return whatever entries have been completed.  When the
process finally completes, the final return of data will contain a "~DONE=1"
as the first array entry value, followed by any remaining entries.  Each
return will only contain unique entries, so it will be additive.

Output Array:
ORY - Total number of unique entries^More Boolean (1=more data)
0RY(1..n,0) -
Piece 1: Date/Time of the copy
Piece 2: Date of the ^XTMP global creation
Piece 3: Package Prefix of application which captured the copy
Piece 4: Copy from location in 2 pieces (ien;package)
Piece 5: Number of lines of copied text
ORY(1..n,1..n) - Copied text

Or Error condition:
ORY - "-1^Error Msg"
ORY(-1)=Error Message
STOP
This entry point stops the copy buffer data retrieval
process.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
This is the user DUZ.
IP Input
This is the IP address of the connecting computer
running the GUI.
HWND Input
This is the Windows Handle passed in from the GUI
application.
OK Output
Boolean result. 1=success
$$CLEAN
Starts the background job to clean-up expired
copy/paste ^XTMP global entries. Returns the task number of the background
job.
VARIABLES TYPE VARIABLES DESCRIPTION
TASK Both
This is the name of the variable to retrieve the task
number of the background process job started to clean up Copy/Paste Tracking
^XTMP entries which may have lived beyond their intended lifespan.
EXCLST
This returns a list of notes that are excluded from
Copy/Paste Tracking functionality.
VARIABLES TYPE VARIABLES DESCRIPTION
LST Output
This is the list array which contains the excluded
notes from Copy/Paste Tracking. The array is returned in two pieces.

Output Array:
Piece 1: The ien of the TIU DOCUMENT DEFINITION (#8925.1)
Piece 2: The name (#.01) of the TIU DOCUMENT DEFINITION (#8925.1)
SUBSCRIBING PACKAGE ORDER ENTRY/RESULTS REPORTING