Document creation with Category Metadata not set in single shot using Rest and CWS SOAP Web service.

marimuthusundaraj · 2021-01-07T15:02:40+00:00

There was an error rendering this rich post.

My requirement is need to create document along with existing Category Metadata in single method call.

I am using OTCS 16.2.11 ( with Rest API as well as CWS SOAP Web services) for applying the existing Category while creating document from Java code.

Application log with Rest API,

17:36:28,958 INFO [STDOUT] ----------------------------------Payload passed for document creation----------------------------------{"advanced_versioning":false,"file":"D:\\CWSTest.txt","mime_type":"text/x-setext","parent_id":2000,"roles":{"categories":{"112705":{"112705_4":30,"112705_10":"D:\\CWSTest.txt"}}},"name":"CWSTest.txt","type":144}

17:36:28,959 INFO [STDOUT] Executing EndPoint: http://X.X.X.X/otcs/cs.exe/api/v1/nodes

I have used the above endpoint for document creation. Here, document is getting created but, existing category is not applied for the created document. Not getting any issue in my application log for this rest api endpoint. Not sure what is missing in Payload.

So, I started with CWS SOAP web service using Apache Tomcat.

Here, I have used createDocument method from DocumentManagement Service

document = docManClient.createDocument(2000, "CWSTest.txt", null, false, metadata, attachment);

It is not creating document and I was getting some error if I pass metadata.

Same method is working fine without metadata. we have another method called setMetadata, which is not helpful for me because, after creating document without Metadata, it will be moved immediately from that parent folder with some trigger. Setting metadata in second method call will not be useful in my case.

So, tried with docManClient.createDocumentContext method which is also not working with Category Metadata. It is also required setMetadata call to update Category metadata. So, this method is not helpful for my scenario.

In CWS Web service approach also it is not working with single method call for creating document with metadata.

It is not working with both approaches such as CWS SOAP Web service as well as Rest API.

Any approach is fine but it needs to set the Category Metadata in a single shot while creating document.

Any suggestion please?

Find more posts tagged with

Comments

Appu Nair

Some Advice I try to give this to young upcoming developers :)

For small-scale testing meaning you are a developer and the company has given you free rein on a CS instance when you say File in a payload you will be able to use postman to put a file on the server, run postman on the server and do all these things. However, when your code needs to work in production it will just fail as CS is actually a Document management system and they have to abide by web regulations, OT is on a typical threat mitigation team as many governmental organizations use CS, ( a virus is essentially something you put on a server) so this expectation of creating a payload with these things in your code should definitely be avoided I mean these kinds, "file":"D:\\CWSTest.txt",

Several great programmers before like @Ferdinand Prantl @Matthew_Pinkney and all have commented why you should refrain from trying to send a file that you have to put in a CS server ...

So I tried your code on my system and it worked in POSTMAN (on a server :)) before that, I went to JSONLINT.com to understand what you were doing as you are sending a list of categories From this screencap look at what the postman code is doing it is definitely not sending the File from a server point

SendingFileCategory.txt

in my headers, I have otcsticket that I got from an earlier call

In closing my advice is if you can afford it try with the simplest of categories stabilize your code with just text attributes then move on to more complicated like Date and other things. REST API errors are sometimes not very user-friendly...

I am not sure if CWS you need as it is getting very old and not many people to want to use SOAP nowadays...

I work with Oscript so many times I open up the debugger and see what is wrong with my rest call

If the simplest of REST works progress with the next category as in your example

marimuthusundaraj

Thank you @Appu Nair, As you mentioned I have tried with single String attribute based on your screen shot now document is getting created with Category. Thanks a lot.

Appu Nair

Glad I could be of help. It always amazes me what POSTman does so does SOAPUI. Sometimes POSTman code adds hidden headers etc so when possible create a new form from scratch and take baby steps. Also as you can see in HTML form terminology the body and file are two name-value pairs that travel with it...

I was creating a form for an RH and I had forgotten the ground rules so when I forgot that ENCTYPE I never got the file from my browser...I spent

hours chasing it looking at code I had written like thousands of times....

Hopefully, now you can send it with more than one category....

marimuthusundaraj

Yes . I tried with 2 Categories in Postman for document creation. It is working fine with below payload.

{

"parent_id":2000,

"name":"log4j.properties",

"type":144,

"roles":{

"categories":{

"771861":{

"771861_7":"Sample Text"

"770170":{

"770170_2_1_3":"India",

"770170_2_1_4":"Sample Value Entered for Testing Purpose. It will accept multi-line text"

}

Category ID: 770170 has Set Attribute. It seems working well with multiple categories too.

Ferdinand Prantl

When you use REST API to create a document, categories are not assigned to the new node from the parent folder or from the workspace type automatically, as you know it from Classic UI. You have to include them in the request body explicitly in the "roles" property. The same goes for classifications and other scenarios like copy or move. A REST client is supposed to enquire about the needed metadata to be able to add them to the creation or modification request. (Smart UI uses /api/v1/forms/nodes/create?parent_id=20013&type=144.)

If you need an example of a more complicated payload, you can configure such scenario in CS and then upload a document using Smart UI. The body of the POST or PUT request will show you an example for your code.

marimuthusundaraj

Thank you @Ferdinand Prantl.

You mentioned that we can configure CS for more complicated payload. Could you mention how to configure CS to handle more complicated payload? Because I need to process Set and Date attribute as well from Java.

Thanks in advance.

Appu Nair

Date I was able to do it like this

{

"type": 144,

"parent_id": 2000,

"name": "apooppan",

"roles": {

"categories": {

"51279": {

"51279_2": "bbb",

"51279_3": "2020-09-02T13:30:00"

}

I think the Date that you give is a Date locale i tried like this as well

51279_3": "2020-09-02" in my category which I created for test it looks like this I didn't include time

marimuthusundaraj

Thank you @Appu Nair. It is working fine after creating new Tab in postman with same format which you mentioned.

In Java code also the same date format needs to be handled as below,

SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd=HH:mm:ss");

categoryJson.put(category_attribute_id, sdf.format(new Date()).replace("=", "T"));

So that, the date format will be passed in proper format to Java http post request.

Formatted Date using Java code: 2020-09-02T13:30:00

After this date format, it is working fine in Java code too.