How to read instance information

Question

I am writing my code from studio and then deploying it in engine.
Can someone paste me code that I can use in studio to get information about the instances that were created under any role.
I saw some API but they require instance id. NOt sure how I can get instance id
Please advice.

Answer 1

Hi,
Sorry, I was not clear on what it is you meant by:
.. get information about the instances that were created under any role
Here are a couple examples that retrieve a list of instances, but neither shows any information about the role. I'm not sure what kind of information you're looking for about the role.
This first example is logic that assumes you'd like to look at instances based on a search filter. In this example, the filter is based on the type of customer they are (e.g. "Gold", "Platinum", "Silver"). It only returns those instances currently inside the process (the SearchScope logic below being set to "StatusScope.ONLY_INPROCESS" in the logic below). The only incoming variable it needs is the "customerType" variable that has already been set to some value. Note that this uses the Fuego.Papi.ClientBusinessProcess object. This logic creates a search filter and only returns instances that meet a certain criteria (e.g. active work item instances that are of the customer type "Gold"):
cbp as ClientBusinessProcess = ClientBusinessProcess()
connectTo(cbp, processId : "/NameOfYourProcessHere")
instF as InstanceFilter = InstanceFilter()
create(instF, processService : cbp.processService, viewId : "TypeSearch")
instF.searchScope = SearchScope(participantScope : ParticipantScope.ALL, statusScope : StatusScope.ONLY_INPROCESS)
logMessage "Customer Type is: " + customerType  using severity = DEBUG
// the variable "customerType" is a String variable set to "Gold", "Silver", "Platinum" in the process
addAttributeTo(instF, variable : "customerType", comparator : IS, value : customerType)
for each inst in getInstancesByFilter(cbp, filter : instF) do
   // get the value of the order's amount for the instance
    instanceVarValue as Object = getVar(inst, var : "orderAmount")
    logMessage "amount is: " + Decimal(instanceVarValue)  using severity = DEBUG
endHere's a second example that I'm guessing might be closer to what it is that you're looking for. Again, this has nothing to do with the roles you mentioned you were interested in, but does return the list of work item instances that are in a particular actvity. Note also that it uses a different technique to connect - the Fuego.Papi.BusinessProcess object. This logic assumes that you already created a participant ("auto") who has been assigned a role in the process. It also assumes that you are running this from a method inside the process - this is the reason the predefined variable "process.name" works here. If you use this, be careful to use the id for the activity and not the name. The id is what you see when you right mouse click an activity in a process -> "Properties" and look at the read only "Activity id" field. Do not use the name field that typically has space characters in it for this logic.
bp as BusinessProcess
targetActivity as String
connectTo bp
    using url = Fuego.Server.directoryURL,
          user = "auto",
          password = "auto",
          process = "/" + process.name
logMessage "Connected to: " + process.name using severity = DEBUG
// get the list of instances in a specific activity
for each instance in getInstancesByActivity(bp, activity : "QueueWaitingForDistribution") do
    logMessage "found an instance with the value: " + String(getVar(instance, var : "someVariableNameHere")) using severity = DEBUG
end