xECM or Extended Enterprise Content Module, is a module that enables users to manage content. Practically, it may act as a bridge between various applications, allowing users to store and access content in their application of preference.
A save integration has been developed, where the user "checks in" a document to xECM, while simultaneously transferring information from the document's properties or registry keys into the customer's xECM system.
CMD
<cmd
case="Omnidocs.XECM:check-in"
endpoint="xyz"
sharedUsername="xyz"
sharedPassword="xyz"
uploadFolderId="8691234465"
uploadType="11244"
>
<Params key="TITLE1" docPropKey="docpropnamehere" value="defaultvaluehere"/>
<Params key="TITLE2" docPropKey="docpropnamehere"/>
<Params key="TITLE3" value="defaultvaluehere"/>
<Params key="TITLE4" registryPathKey="HKEY_CURRENT_USER\SOFTWARE\Templafy" registryValueKey="Url"/>
</cmd>Command Parameters
The endpointparameter holds a link to the customer's xECM service.
sharedUsername and sharedPassword hold the user name and the password that should be used to log into the xECM service respectively.
In the uploadFolderId parameter, the folder ID of a temporary folder in xECM where the document will be uploaded. The user may change the save location in the window that appears when pressing the button.
Lastly, the uploadType defines the file and upload type. In this case, the value 144 is used to define a static, document upload.
Parameters for the information transfer between Office and xECM
In order to transfer information from the document's properties or from registry keys, the following elements can be used. In these, the key parameter is used to define the xECM parameters that correspond to the respective fields in xECM. A list of such parameters is presented below:
|
Fields |
Parameters |
|
Document Id |
DOCID |
|
Language Code |
LANG |
|
Title |
TITLE |
|
Supplementary Title |
SUPTITLE |
|
Title English |
ENGTITLE |
|
Document Kind |
DOCKIND |
|
Owning Organization |
OWNORG |
|
Business Unit |
BUSUNIT |
|
GPG |
GPG |
|
Hub |
HUB |
|
Country |
COUNTRY |
|
Function |
FUNC |
|
Sub-Function |
SUBFUNC |
|
Sub-Sub Function |
SSUBFUNC |
|
Publish Type |
PUBTYPE |
<Params key="TITLE1" docPropKey="docpropnamehere" value="defaultvaluehere"/>This element can be used to insert information from a document property's default value into an xECM field. The value parameter can also be omitted.
<Params key="TITLE3" value="valuehere"/>Using this element, it is possible to hard-code a value that will be transferred to the specified field in xECM.
<Params key="TITLE4" registryPathKey="HKEY_CURRENT_USER\SOFTWARE\Templafy" registryValueKey="Url"/>Lastly, it is also possible to insert values from a registry key, as demonstrated aboce.
Example:
<button label="Add New Document" tip_text="Add opened document to xECM" showInPowerPoint="true" showInExcel="true" showInOutlook="false" size="large" icon="SaveAndCloseConflictView">
<Cmd case="BaseExtensions:inject-registry-value">
<cmd
case="Omnidocs.XECM:check-in"
endpoint="https://xyz"
sharedUsername="xyz"
sharedPassword="xyz"
uploadFolderId="979asdf84127"
uploadType="14asdf4"
>
<Params key="DOCID" docPropKey="DocumentId"/>
<Params key="LANG" docPropKey="LanguageCode"/>
<Params key="DOCKIND" docPropKey="DocumentKind"/>
<Params key="TITLE" docPropKey="DocumentTitle"/>
<Params key="OWNORG" docPropKey="OwningOrganization"/>
<Params key="SUPTITLE" docPropKey="SupplementaryTitle"/>
<Params key="ENGTITLE" docPropKey="TitleEnglish"/>
<Params key="SECLEVEL" docPropKey="SecurityLevel"/>
<Params key="DOCPARTID" docPropKey="DocumentPartId"/>
<Params key="PREPBY" docPropKey="PreparedByPerson"/>
<Params key="FAV" registryPathKey="HKEY_CURRENT_USER\Software\OfficeExtensions" registryValueKey="SaveLocation"/>
</cmd>
</Cmd>
</button>Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article