Variable Usage and Syntax

Transcription

1 DocFinity v Variable Usage and Syntax These charts list the variables available for use throughout DocFinity and detail where and how the variables can be used. The first chart lists the variables in alphabetical order. The second chart lists the variables by DocFinity module. Variable names are case sensitive. Alphabetical List Variable Name Description Usable In Syntax basewatchdir The monitored directory's path as a (Does not include subfolders.) ${basewatchdir} category The Category name the document has been indexed under. Data type = ${PACKAGE.<itemName>.category} category CC The addresses in the 's CC field, as a String[] array. ${CC} createdby The user account or Importer who added the document to the system. Data type = ${PACKAGE.<itemName>.createdBy} createdby createddate The date the document was first added to the database and Repository. Data type = ${PACKAGE.<itemName>.createdDate} currentfile The imported file's name as a ${currentfile}

2 CURRENT_USERNAME The username of the currently logged in user. ${PACKAGE.<FormName>.CURRENT_USERNAME} ${FC_CURRENT_USERNAME} CURRENT_NODE_NAME The name of the current node where the Process Instance is executing. Data type ${CURRENT_NODE_NAME} CURRENT_NODE_NAME displayname The Metadata Object set as the display name of the document. Data type = ${PACKAGE.<itemName>.displayName} displayname documentid The ID of the document, which refers to a unique document in the Repository. Data type = ${PACKAGE.<itemName>.documentId} documentid Id documenttype The Document Type the document has been indexed under. Data type = ${PACKAGE.<itemName>.documentType} documenttype firstname The first name of the user submitting the form. Form Designer > Send ${FirstName} ${folder()} The sub-directory path to the object being imported, by subdirectory. ${folder(1)} returns the first sub-directory, ${folder(2)} returns the second sub-directory, ${folder(3)} the third, and so on. Administration > Documents > Importing > ${folder(1)} FORM_CREATE_DATE The date when the form instance was first saved. ${PACKAGE.<FormName>.FORM_CREATE_DATE} ${FC_FORM_CREATE_DATE} FORM_CREATOR_ID The UserId who created the form instance. ${PACKAGE.<FormName>.FORM_CREATOR_ID} ${FC_FORM_CREATOR_ID} FORM_CREATOR_USERNAME The User Name who created the form instance. ${PACKAGE.<FormName>.FORM_CREATOR_USERNAME} ${FC_FORM_CREATOR_USERNAME} FORM_DESIGN_NAME The name of the form design. ${PACKAGE.<FormName>.FORM_DESIGN_NAME}

3 ${FC_FORM_DESIGN_NAME} FORM_DOCUMENT_ID The ID of the indexed form document. ${PACKAGE.<FormName>.FORM_DOCUMENT_ID} ${FC_FORM_DOCUMENT_ID} FORM_INSTANCE_ID The ID of the form instance ${PACKAGE.<FormName>.FORM_INSTANCE_ID} ${FC_FORM_INSTANCE_ID} FORM_LAST_MODIFIED The date when the form instance last had data modified and saved. ${PACKAGE.<FormName>.FORM_LAST_MODIFIED} ${FC_FORM_LAST_MODIFIED} FORM_LAST_MODIFIED_BY modified the form instance. ${PACKAGE.<FormName>.FORM_LAST_MODIFIED_BY} ${FC_FORM_LAST_MODIFIED_BY} indexed The value for the indexed indicator flag for a document whether the document is indexed or not. Data type = Boolean (true/false). ${PACKAGE.<itemName>.indexed} indexed indexedby The user who indexed the document. Data type = ${PACKAGE.<itemName>.indexedBy} indexedby indexeddate The date the document was indexed or last reindexed. Data type = ${PACKAGE.<itemName>.indexedDate} indexeddate lastname The last name of the user submitting the form. Form Designer > Send ${LastName} LAST_DISTRIBUTED_TO The username of the user assigned to the last personal job distributed. Data type = ${<UserActivityNodeName>.LAST_DISTRIBUTED_TO} ${<UserActivityNodeName>.LAST_DISTRIBUTED_TO} LAST_JOB_ID_GIVEN The job ID of the last personal job distributed. Data type = ${<UserActivityNodeName>.LAST_JOB_ID_GIVEN} ${<UserActivityNodeName>.LAST_JOB_ID_GIVEN} LAST_TAKEN_BY took a job from the specified User Activity. Data type = (This ${<UserActivityNodeName>.LAST_TAKEN_BY}

4 variable can be used along with Specific Person distribution to accomplish user locks.) <UserActivityNodeName>.LAST_TAKEN_BY LAST_TASK_COMPLETED_BY completed a task in the specified User Activity. ${<UserActivityNodeName>.LAST_TASK_COMPLETED_BY} <MetadataName> The value of the Metadata Object specified by the MetadataName. Data type = string. ${PACKAGE.<itemName>.<MetadataObjectName>} <MetadataObjectName> MIGRATED_TO_PROCESS_ MODEL The ID of the new Process Model Instance, when a new instance is created using Start in New Process in DocFinity > Monitoring. ${MIGRATED_TO_PROCESS_MODEL} ORIGINATOR The user who initiated a Process Instance. Data type = ${ORIGINATOR} ORIGINATOR PDF_PATH The path to the PDF of a form where it is stored in the Repository after a Create PDF submit action. ${PACKAGE.<FormName>.PDF_PATH} ${FC_PDF_PATH} PROCESS_CREATE_TIME The datetime when the Process Instance was initiated. Data type = ${PROCESS_CREATE_TIME} PROCESS_CREATE_TIME PROCESS_INSTANCE_ID The ID of a Process Instance (unique in the system). Data type = long. ${PROCESS_INSTANCE_ID} PROCESS_INSTANCE_ID PROCESS_MODEL_NAME The name of the Process Model. Data type = ${PROCESS_MODEL_NAME} PROCESS_MODEL_NAME PROCESS_MODEL_VERSION The version of the Process Model. Data type = Integer. ${PROCESS_MODEL_VERSION} PROCESS_MODEL_VERSION ReceivedDate The date the was received, as a ${ReceivedDate} searchid The ID set when the specified ${PACKAGE.<SavedSearchName>.searchId}

5 search is sent to a package. Data type = String searchid SentDate The date the was sent, as a ${SentDate} Subject The 's subject line, as a ${Subject} submitdate The date the form was submitted by the user. Form Designer > Send ${SubmitDate} ToAddress The address of the sender, as a ${ToAddress} TOKEN_ID The ID number of the current token. Each node in a process receives a unique Token ID, which can be identified for signaling the node or using a macro such as #ReleaseHoldNode(). Data type = long. ${TOKEN_ID} TOKEN_ID url References the URL. URLs can include a macro or variable that evaluates to a string. ${PACKAGE.<itemName>.url} url watchdir The monitored directory's path, including sub-folders, as a ${watchdir} Module-by-Module List Administration Variable Name Description Usable In Syntax basewatchdir The monitored directory's path as a (Does not include sub-folders.) ${basewatchdir} category The Category name the document has been indexed under. Data type = category CC The addresses in the 's CC field, as a String[] array. ${CC}

6 createdby The user account or Importer who added the document to the system. Data type = createdby currentfile The imported file's name as a ${currentfile} CURRENT_NODE_NAME displayname documentid documenttype folder indexed indexedby indexeddate The name of the current node where the Process Instance is executing. Data type The Metadata Object set as the display name of the document. Data type = The ID of the document, which refers to a unique document in the Repository. Data type = The Document Type the document has been indexed under. Data type = The sub-directory path to the object being imported, by subdirectory. ${folder(1)} returns the first subdirectory, ${folder(2)} returns the second sub-directory, ${folder(3)} the third, and so on. The value for the indexed indicator flag for a document whether the document is indexed or not. Data type = Boolean (true/false). The user who indexed the document. Data type = The date the document was indexed or last reindexed. Data type = Administration > Documents > Importing > CURRENT_NODE_NAME displayname documentid documenttype ${folder(1)} indexed indexedby indexeddate LAST_DISTRIBUTED_TO The username of the user assigned to the last personal job distributed. Data type = <UserActivityNodeName>.LAST_DISTRIBUTED_TO LAST_JOB_ID_GIVEN The job ID of the last personal job distributed. Data type = <UserActivityNodeName>.LAST_JOB_ID_GIVEN LAST_TAKEN_BY took a job from the specified User Activity. Data type = (This variable can be used along with Specific Person distribution to accomplish user locks.) <UserActivityNodeName>.LAST_TAKEN_BY

7 <MetadataName> The value of the Metadata Object specified by the MetadataName. Data type = string. <MetadataObjectName> ORIGINATOR The user who initiated a Process Instance. Data type = ORIGINATOR PROCESS_CREATE_TIME The datetime when the Process Instance was initiated. Data type = PROCESS_CREATE_TIME PROCESS_INSTANCE_ID The ID of a Process Instance (unique in the system). Data type = long. PROCESS_INSTANCE_ID PROCESS_MODEL_NAME The name of the Process Model. Data type = PROCESS_MODEL_NAME PROCESS_MODEL_VERSION The version of the Process Model. Data type = Integer. PROCESS_MODEL_VERSION ReceivedDate The date the was received, as a ${ReceivedDate} searchid The ID set when the specified search is sent to a package. Data type = String searchid SentDate The date the was sent, as a ${SentDate} Subject The 's subject line, as a ${Subject} ToAddress TOKEN_ID url watchdir Form Designer The address of the sender, as a The ID number of the current token. Each node in a process receives a unique Token ID, which can be identified for signaling the node or using a macro such as #ReleaseHoldNode(). Data type = long. References the URL. URLs can include a macro or variable that evaluates to a string. The monitored directory's path as a ${ToAddress} TOKEN_ID url ${watchdir} Variable Name Description Usable In Syntax

8 firstname The first name of the user submitting the form. Form Designer > Send ${FirstName} lastname The last name of the user submitting the form. Form Designer > Send ${LastName} submitdate The date the form was submitted by the user. Form Designer > Send ${SubmitDate} Process Designer Variable Name Description Usable In Syntax category The Category name the document has been indexed under. Data type = ${PACKAGE.<itemName>.category} createdby The user account or Importer who added the document to the system. Data type = ${PACKAGE.<itemName>.creator} createddate The date the document was first added to the database and Repository. Data type = ${PACKAGE.<itemName>.createdDate} CURRENT_NODE_NAME The name of the current node where the Process Instance is executing. Data type ${CURRENT_NODE_NAME} CURRENT_USERNAME The username of the currently logged in user. ${PACKAGE.<FormName>.CURRENT_USERNAME} ${FC_CURRENT_USERNAME} displayname The Metadata Object set as the display name of the document. Data type = ${PACKAGE.<itemName>.displayName} documentid The ID of the document, which refers to a unique document in the Repository. Data type = ${PACKAGE.<itemName>.documentId} documenttype The Document Type the document has been indexed under. Data type = ${PACKAGE.<itemName>.documentType} FORM_CREATE_DATE The date when the form instance was first saved. ${PACKAGE.<FormName>.FORM_CREATE_DATE} ${FC_FORM_CREATE_DATE} FORM_CREATOR_ID The UserId who created the form instance. ${PACKAGE.<FormName>.FORM_CREATOR_ID} ${FC_FORM_CREATOR_ID} FORM_CREATOR_USERNAME The User Name who created the form instance. ${PACKAGE.<FormName>.FORM_CREATOR_USERNAME}

9 ${FC_FORM_CREATOR_USERNAME} FORM_DESIGN_NAME The name of the form design. ${PACKAGE.<FormName>.FORM_DESIGN_NAME} ${FC_FORM_DESIGN_NAME} FORM_DOCUMENT_ID The ID of the indexed form document. ${PACKAGE.<FormName>.FORM_DOCUMENT_ID} ${FC_FORM_DOCUMENT_ID} FORM_INSTANCE_ID The ID of the form instance. ${PACKAGE.<FormName>.FORM_INSTANCE_ID} ${FC_FORM_INSTANCE_ID} FORM_LAST_MODIFIED The date when the form instance last had data modified and saved. ${PACKAGE.<FormName>.FORM_LAST_MODIFIED} ${FC_FORM_LAST_MODIFIED} FORM_LAST_MODIFIED_BY modified the form instance. ${PACKAGE.<FormName>.FORM_LAST_MODIFIED_BY} ${FC_FORM_LAST_MODIFIED_BY} indexed The value for the indexed indicator flag for a document whether the document is indexed or not. Data type = Boolean (true/false). ${PACKAGE.<itemName>.indexed} indexedby The user who indexed the document. Data type = ${PACKAGE.<itemName>.indexedBy} indexeddate The date the document was indexed or last reindexed. Data type = ${PACKAGE.<itemName>.indexedDate} LAST_DISTRIBUTED_TO The username of the user assigned to the last personal job distributed. Data type = ${<UserActivityNodeName>.LAST_DISTRIBUTED_TO} LAST_JOB_ID_GIVEN The job ID of the last personal job distributed. Data type = ${<UserActivityNodeName>.LAST_JOB_ID_GIVEN} LAST_TAKEN_BY took a job from the specified User Activity. Data type = (This variable can be used along with Specific Person distribution to accomplish user locks.) ${<UserActivityNodeName>.LAST_TAKEN_BY} LAST_TASK_COMPLETED_BY completed a task in the specified User Activity. ${<UserActivityNodeName>.LAST_TASK_COMPLETED_BY}

10 <MetadataName> The value of the Metadata Object specified by the MetadataName. Data type = string. ${PACKAGE.<itemName>.<MetadataObjectName>} MIGRATED_TO_PROCESS_ MODEL The ID of the new Process Model Instance when a new instance is created using Start in New Process in DocFinity > Monitoring. ${MIGRATED_TO_PROCESS_MODEL} ORIGINATOR The user who initiated a Process Instance. Data type = ${ORIGINATOR} PDF_PATH The path to the PDF of a form where it is stored in the Repository after a Create PDF submit action. ${PACKAGE.<FormName>.PDF_PATH} ${FC_PDF_PATH} PROCESS_CREATE_TIME The datetime when the Process Instance was initiated. Data type = ${PROCESS_CREATE_TIME} PROCESS_INSTANCE_ID The ID of a Process Instance (unique in the system). Data type = long. ${PROCESS_INSTANCE_ID} PROCESS_MODEL_NAME The name of the Process Model. Data type = ${PROCESS_MODEL_NAME} PROCESS_MODEL_VERSION The version of the Process Model. Data type = Integer. ${PROCESS_MODEL_VERSION} searchid The ID set when the specified search is sent to a package. Data type = String ${PACKAGE.<SavedSearchName>.searchId} TOKEN_ID The ID number of the current token. Each node in a process receives a unique Token ID, which can be identified for signaling the node or using a macro such as #ReleaseHoldNode(). Data type = long. ${TOKEN_ID} url References the URL. URLs can include a macro or variable that evaluates to a string. ${PACKAGE.<itemName>.url} Published Copyright 2012 Optical Image Technology, Inc. All rights to possess, use, and permissions to use reserved.