Eduard Lebedyuk · Jan 12, 2018 go to post

Some possible code improvements:

1. Instead of:

s sc = httprequest.Post("http://127.0.0.1:57772/api/v0/bwxpert/visiocheck/account")

it's enough to specify:

s sc = httprequest.Post("/api/v0/bwxpert/visiocheck/account")

as the rest of the address is defined beforehand.

2. Instead of:

s httprequest.Authorization = "Basic X1N5c3RlbTpTWVM="

you can specify:

s httprequest.Username = "_SYSTEM"
s httprequest.Password = "SYS"

Which is more readable

3. When specifying server, protocol in not required, incorrect even:

s httprequest.Server="127.0.0.1"

4. Finally, don't use short syntax (s, d) and use one naming convention consistently - in your example some commands are in lowercase and some start with a capital letter.

Eduard Lebedyuk · Jan 12, 2018 go to post

Private is not important in that case - it only affects from where method could be called. Private methods can be invoked only by methods of this class or its subclasses.

The difference between class methods and instance methods is that instance methods can access object context. For example you can access current object property from instance methods. Use instance methods only when you need access to object context. In all other cases use class methods.

Here's a sample code, highlighting the difference:

Class Test.Person Extends %RegisteredObject {

Property Name As %String;

Method PrintName() {
  Write ..Name
}

ClassMethod PrintText(text) {
  Write text
}

}
Eduard Lebedyuk · Jan 9, 2018 go to post
  1. Please ask this as a separate question.
  2. What, and from where do you want to kill? Why? Consider expanding your question.
Eduard Lebedyuk · Jan 8, 2018 go to post

and by the way, is Set Request.Https=1 correct given that Set Request.Https=$$$YES not supported in Ensemble 2014?

Yes, it's the same thing $$$YES macro resolves into 1.

but I get this error :  
{"Errors":["The request entity's media type 'text/html' is not supported for this resource."],"StatusCode":415}

Specify content type. For example:

Set Request.ContentType = "application/json"

or whatever content type the api requires.

Eduard Lebedyuk · Jan 8, 2018 go to post

They are various jobs required for Caché to function. They run tasks, write to database, etc.

Is there any specific reason you ask this question?

Eduard Lebedyuk · Jan 8, 2018 go to post

Not really. KeyFieldName only affects the tracking of processed records.  Example 5 shows configuration where each row is passed each time the service querying the database is ran.

SQL Inbound Adapter always passes rows one by one.

Your options are:

  1. Create a buffer and check if this is a last row. If it's a last row - call bulk API. If it's not a last row then add row to buffer.
  2. Call bulk API after every N (i.e. 100) of rows.
  3. Extend SQL  Inbound Adapter to pass a whole resultset or to pass batches of rows.
  4. Write changes locally row by row. Create a separate service that calls bulk API from local data.

What option to choose? Here are several questions, which may help you:

  1. What are the throughout rates (per second/minute/day/peaks?)?
    • New rows in the source system
    • How much rows Ensemble can process
    • How much requests can API process (does it matter if you pass several rows? For example you can pass 100 individual requests per second or 10 bulk requests with 1000 rows each)
  2. Administrative limits for the above-mentioned external systems?
  3. Can you normalize some of these rates? (For example you receive updates during the work hours, but send the 24/7) 
  4. What's the bulk error strategy (good to bad)?
    • You get an error list which you can easily match to individual records
    • You get an error list but you're unable to match it to the individual records
    • You get one (first/last/random) error
  5. Should you group your records before sending (can be useful for visual tracing, pinpointing error source)?
    • By some criteria (hospital, country, day, etc)
  6. What's the resend strategy in cause of errors?
    • Let's say you sent a batch of 1000 records: 999 ok, 1 failed. Can you easily resend only one record? Would sending a whole batch again break data consistency or just fail altogether? 
  7. Can you send the records individually?
Eduard Lebedyuk · Jan 8, 2018 go to post

so is there a way to get it working with SSLConfig

As I said:

Where  SSLConfiguration is the name of your ssl config.

You need to create a SSL config. Docs explain how.

 test 0 or 1 means as the doc doesn't mention it!?

Test values

  • 0 - send as usual
  • 1 - do not send, output request to the current device
  • 2- send the request and output response to the current device

location in Post method is optional given that we set Set Request.Location = "/STP_IF/rest/Employee/Create"

Yes, it's enough to specify Location property.

Eduard Lebedyuk · Jan 6, 2018 go to post

I'd move

Write !?(%lev*3)

into a separate method:

ClassMethod Log(text)
{
  Write !?(%lev*3), text
}
Eduard Lebedyuk · Jan 5, 2018 go to post

Google implies that your request is not complete.

Generally, when debugging web services you should follow these steps:

  1. Have a way to send valid requests (i.e. SoapUI)
  2. Send request via Caché/Ensemble
  3. Compare (DiffDog, etc) requests from 1 and 2, here you need to:
    • Modify valid request till it fails
    • Modify invalid request  till it succeeds

Also, don't forget to send new request after each modification. Web services often have GUID/ID by which they identify incoming requests. If incoming request has the same identifier they don't execute it again, but just return cached result. Identifier can be a header or inside message body.

Eduard Lebedyuk · Jan 5, 2018 go to post

Try to remove reNo altogether and get the root node from the xml document:

do ..ShowNode(document.GetDocumentElement())

In GetDocumentElement method, you can see that for node to exist it needs 2 things:

  • Document
  • Pointer to the exact node

When you created the node manually,  you've done the first but not the second.

Eduard Lebedyuk · Jan 5, 2018 go to post

SET JArray=["somthing "] 

OR

Set Array1 = ##class(%Library.DynamicArray).%New()
 SET Array1=[]

so in both cases Array1 or JArray is not understanding [] so should be including or extending a classe(s) or ...etc 

That's available from version 2016.2. Refer to your local documentation or online documentation for 2014 version.

FYI Srever name & port are not required for this Wed Service. 

It's not server name - it's host and it's required. You also need to specify HTTPS and SSLConfig.

If I execute your code in test mode (  Set Status = Request.Post(,1) ) I receive:

POST /https%3A//devtest.altus.net.au/STP_IF/rest/Employee/ HTTP/1.1
User-Agent: Mozilla/4.0 (compatible; Cache;)
Host: localhost
Accept-Encoding: gzip
Content-Length: 239
Content-Type: text/html; charset=UTF-8
 
{
        "Id":123,
        "PayerAustralianBusinessNumbe":"PayerAustralianBusinessNumbe",
        "PayerBusinessHoursPhoneNumbe":"PayerBusinessHoursPhoneNumbe",
        "PayerEmailAddress":"email",
        "PayerWithholdingPayerNumber":"PayerWithholdingPayerNumber"
}

You should probably modify your code like this this:

ClassMethod Test(test As %String(VALUELIST="0,1,2") = 1){Set Body = ##class(%ZEN.proxyObject).%New()Set Body.Id = "123"Set Body.PayerEmailAddress = "email"Set Body.PayerBusinessHoursPhoneNumbe = "PayerBusinessHoursPhoneNumbe"Set Body.PayerAustralianBusinessNumbe = "PayerAustralianBusinessNumbe"Set Body.PayerWithholdingPayerNumber = "PayerWithholdingPayerNumber"Set Request= ##class(%Net.HttpRequest).%New()Set Request.Server = "devtest.altus.net.au"Set Request.Location = "STP_IF/rest/Employee/"Set Request.Https = $$$YESSet Request.SSLConfiguration = "YourSSLConfig"Set Status = ##class(%ZEN.Auxiliary.jsonProvider).%WriteJSONStreamFromObject(Request.EntityBody, Body)Set Status = Request.Post(,test)}

Where  SSLConfiguration is the name of your ssl config. Afterwards with test=1 I get this:

POST /STP_IF/rest/Employee/ HTTP/1.1
User-Agent: Mozilla/4.0 (compatible; Cache;)
Host: devtest.altus.net.au
Accept-Encoding: gzip
Content-Length: 239
Content-Type: text/html; charset=UTF-8
 
{
        "Id":123,
        "PayerAustralianBusinessNumbe":"PayerAustralianBusinessNumbe",
        "PayerBusinessHoursPhoneNumbe":"PayerBusinessHoursPhoneNumbe",
        "PayerEmailAddress":"email",
        "PayerWithholdingPayerNumber":"PayerWithholdingPayerNumber"
}

And the response with test=2 is as follows:

HTTP/1.1 405 Method Not Allowed
ALLOW: GET
CACHE-CONTROL: no-cache
CONNECTION: keep-alive
CONTENT-LENGTH: 73
CONTENT-TYPE: application/json; charset=utf-8
DATE: Fri, 05 Jan 2018 08:16:20 GMT
EXPIRES: -1
PRAGMA: no-cache
SERVER: Microsoft-IIS/8.5
 
{"Message":"The requested resource does not support http method 'POST'."}

You should check the API docs for correct location (or HTTP verb)

I'm basically looking to handcraft the Body.%ToJSON() content to to be contained in []

Wrap Body in %ListOfObjects for that:

Set List = ##class(%ListOfObjects).%New()Do List.Insert(Body)Set Status = ##class(%ZEN.Auxiliary.jsonProvider).%WriteJSONStreamFromObject(Request.EntityBody, List)

And your request body would look like this:

[ {
                "Id":123,
                "PayerAustralianBusinessNumbe":"PayerAustralianBusinessNumbe",
                "PayerBusinessHoursPhoneNumbe":"PayerBusinessHoursPhoneNumbe",
                "PayerEmailAddress":"email",
                "PayerWithholdingPayerNumber":"PayerWithholdingPayerNumber"
        }
]
Eduard Lebedyuk · Jan 4, 2018 go to post

passing sbJSON by reference would make this recursive construct easier to understand

Object are always passed by reference.

Eduard Lebedyuk · Jan 4, 2018 go to post

replacement with %ToJSON()  does it as well.

Is there a way to call %ToJSON, so it would return formatted output?

Eduard Lebedyuk · Jan 4, 2018 go to post

Export it as XML. Store in VCS with code. Import with the rest of the code.

Other option is to store it as XData, here's sample code:

XData DisplayProperies
{
<Export generator="Cache">
<Global>
<Node><Sub>^Test</Sub>
<Node><Sub>1</Sub>
<Data>123</Data>
</Node>
<Node><Sub>Val2</Sub>
<Data>prop3</Data>
</Node>
<Node><Sub></Sub>
<Data>prop1</Data>
</Node>
</Node>
</Global>
</Export>
}

/// Set global
/// do ##class(Class.Installer).setGlobal()
ClassMethod setGlobal() As %Status
{
    #dim sc As %Status = $$$OK
    #dim className As %String = $classname()
    
    // search for XData: DisplayProperies
    #dim xdata As %Dictionary.CompiledXData = ##class(%Dictionary.CompiledXData).IDKEYOpen(className, "DisplayProperies",, .sc)
    quit:$$$ISERR(sc) sc

    set stream = xdata.Data
    set sc = $system.OBJ.LoadStream(stream, "/displaylog=0 /displayerror=0")
    quit sc
}
Eduard Lebedyuk · Jan 4, 2018 go to post
 s ^TMPPRD=reqObj

That won't work. Global can store object serialization or some property value.

Eduard Lebedyuk · Jan 4, 2018 go to post

sbJSON that actually get passed to XmlToJSONNode is not an object. Additionally try this modification to XmlToJSON (you need to specify file if you want to use file stream):

Method XmlToJSON(xml As %Stream) As %Stream
{
            set xmlDoc =##class(%XML.TextReader).ParseStream(xml,.textreader)          
            set sbJSON =##class(%Stream.FileCharacter).%New()
            do sbJSON.LinkToFile("somefile")
            do sbJSON.WriteLine($C(123))
            do ..XmlToJSONnode(sbJSON,textreader.Name,1)
            do sbJSON.writeLine($C(125))
            return sbJSON
}
Eduard Lebedyuk · Jan 3, 2018 go to post

You can redefine these dynamic dispatch methods:

  • %DispatchGetProperty / %DispatchSetProperty / %DispatchSetMultidimProperty
  • %DispatchGetModified / %DispatchSetModified
  • %DispatchMethod / %DispatchClassMethod

And they are available for all classes.

Eduard Lebedyuk · Jan 2, 2018 go to post

 can't find properties Prop1, Prop2...etc in %ZEN.proxyObject documentation

They are dynamic (defined via %DispatchGetProperty/%DispatchSetProperty) so you can assign any properties to %ZEN.proxyObject.

 CopyFrom in %Net.HttpRequest, you can find Write method but not the Copyfrom method so how do we suppose to know those properties and methods?

Unable to reproduce (on 2017.2 though).

You may try to use #Dim directive:

#Dim Stream As %GlobalBinaryStream
Set Stream = ##class(%GlobalBinaryStream).%New()
Do Stream.Write("111")
Set Request.EntityBody = Stream

Autocomplete works better for variables defined with #Dim (also it's useful for lists/arrays with objects).

what the Maximum Props we can have ?

1000 properties per class.

Eduard Lebedyuk · Jan 2, 2018 go to post

Here's a sample request with JSON payload from %ZEN.proxyObject, with object->json serialization via %ZEN.Auxiliary.jsonProvider:

Set Body = ##class(%ZEN.proxyObject).%New()
Set Body.Prop1 = "Val1"
Set Body.Prop2 = "Val2"
Set Array = ##class(%ListOfDataTypes).%New()
Do Array.Insert(1)
Do Array.Insert(2)
Do Array.Insert(4)
Set Body.Array = Array
Set Request= ##class(%Net.HttpRequest).%New()
Set Request.Server = "server"
Set Request.Location = "location"
Set Status = ##class(%ZEN.Auxiliary.jsonProvider).%WriteJSONStreamFromObject(Request.EntityBody,  Body)
Set Status = Request.Post()

Payload looks like this:

Do Body.%ToJSON()
{
        "Array":[1,2,4
        ],
        "Prop1":"Val1",
        "Prop2":"Val2"
}

Documentation on %Net. HttpRequest.

Eduard Lebedyuk · Jan 1, 2018 go to post

I encountered somewhat similar problem, here are the conditions:

  • Several types of business objects
  • Business objects may depend upon other objects, so it's like a dependency graph
  • Updates arrive for objects and they need to be approved by humans
  • Humans approve updates randomly
  • But updates should be applied top to bottom (so base object first, then all objects which depend on it, then all objects which depends on them and so on)
  • Updates arrives continuously

To solve this, we used deferred responses and the class I posted above except it also has dependsOn property which contained a list of tokens which should be satisfied before current token (message corresponding to current token) can be returned.

It looked like this:

Property dependsOn As List Of %String(SQLPROJECTION = "table/column", STORAGEDEFAULT = "array");
// Index dependsOnIndex On dependsOn (ELEMENTS);

So our process was:

  1. if we found new dependency we added to list, if dependency was satisfied we removed it from all lists.
  2. If there was no more dependencies than update would be fired.
  3. Then there was a check to see if current update was a dependency for something else.

Projecting list property as a table helped. Also collection properties are indexable, so it all worked quite fast.

Eduard Lebedyuk · Dec 31, 2017 go to post

You'll need to develop the criteria yourself as it's heavily dependent upon your business logic. There's no common solution there. Generally you need to:

  1. Pass some unique identifier with your request (as one of request properties or in the filename or as a header, etc.).
  2. In your business service parse the response and determine  what is this response to.
  3. Send deferred response

I usually have a Deferred token table where I keep track of tokens and objects to which they relate:

#Include Ensemble
/// Stored Deferred token.
/// Assumption: one BH generates only one type of Deferred token.
Class Production.DeferredToken Extends %Persistent
{

/// Token
Property token As %String;

Index IDKEY On token [ IdKey ];

/// Object's class anme
Property objectContext As %Dictionary.CacheClassname;

/// Object's primary key
Property objectId As %String;

Index objectIndex On (objectContext, objectId) [ Unique ];

/// Update ts (UTC)
Property updatedOn As %TimeStamp [ Required, SqlComputeCode = { set {*} = $$$ts}, SqlComputed, SqlComputeOnChange = (%%INSERT, %%UPDATE) ];

/// Ensemble session
Property sessionId As %Integer [ InitialExpression = {$get($$$JobSessionId)} ];

/// Ensemble BH
Property configName As %Integer [ InitialExpression = {$get($$$EnsJobLocal("ConfigName"))} ];

/// Ensemble BH class
Property ensembleContext As %Integer [ InitialExpression = {$get($$$ConfigClassName($get($$$EnsJobLocal("ConfigName")," ")))} ];

/// Tries to store a new token if possible
/// w ##class(Production.DeferredToken).add()
ClassMethod add(token As %String, class As %String = "", id As %Integer = "") As %Status
{
    return:((class'="") && ('##class(%Dictionary.ClassDefinition).%ExistsId(class))) $$$ERROR($$$ClassDoesNotExist, class)
    return:((class'="") && (id'="") && ('$classmethod(class, "%ExistsId", id))) $$$ERROR($$$GeneralError, $$$FormatText("Object '%2' from class '%1' does not exist", class, id))
    return:..IDKEYExists(token) $$$ERROR($$$GeneralError, $$$FormatText("Token '%1' already exist", token))
    
    set obj = ..%New()
    set obj.objectContext = class
    set obj.objectId = id
    set obj.token = token
    set sc = obj.%Save()
    
    return sc
}

Use %ExistsId, %DeleId, objectIndexExists, objectIndexOpen to manipulate stored tokens.

Eduard Lebedyuk · Dec 30, 2017 go to post

I think you need deferred response.

It works like this:

  1. BP sends message to BO
  2. BO defers response and quits
  3. BS (or anything else really) generates a response  and sends it to BP
  4. BP receives deferred response