multiple nspace support added

Author: albertoft

Dockerfile

@@ -37,5 +37,6 @@ ENV IRISNAMESPACE "DPIPE"
 # run iris.script
 RUN iris start IRIS \
     && iris session IRIS < /opt/irisapp/iris.script \
+    && iop --init \
     && iop -m /opt/irisapp/src/python/Demo/settings.py \
     && iris stop IRIS quietly

README.md

@@ -116,6 +116,18 @@ Usually you will add:
 
 Have a look at a full example in [DataPipe.Test.Production.cls](src/DataPipe/Test/Production.cls)
 
+# Installation
+1) Install [IPM package manager](https://github.com/intersystems/ipm) if you don't have already done it.
+2) Create a new namespace (e.g. `DPIPE`)
+3) Switch to the namespace you want to install DataPipe.
+4) Install DataPipe using ipm:
+
+```objectscript
+zpm "install iris-datapipe"
+```
+
+5) Set up users and roles as needed (see next section).
+
 ## Users and privileges
 
 DataPipe uses different security resources you can assign to InterSystems IRIS user account:
@@ -154,15 +166,64 @@ write ##class(Security.Users).Create("dpadmin","DataPipe_Admin","demo")
 
 You can also check out the [DataPipe_Admin](http://localhost:52773/csp/sys/sec/%25CSP.UI.Portal.Role.zen?PID=DataPipe_Admin) role definition in InterSystems IRIS. 
 
-# Installation
-1) Install [IPM package manager](https://github.com/intersystems/ipm) if you don't have already done it.
-2) Create a new namespace (e.g. `DPIPE`)
-3) Switch to the namespace you want to install DataPipe.
-4) Install DataPipe using ipm:
+## Using DataPipe in multiple namespaces
+
+You can install DataPipe in one namespace and use it in different namespaces using the same UI.
+
+To do so, you need to:
+* Install DataPipe in source namespace
+* Map DataPipe and Restforms2 package and globals to target namespace
+* Grant access to tables and views on target namespace
+
+The following example uses the **quickstart container** to configure Datapipe also in `USER` namespace:
+
+1) DataPipe is already installed in `DPIPE` namespace.
+2) Map DataPipe and Restforms2 package and globals from `DPIPE` to `USER`:
 
 ```objectscript
-zpm "install iris-datapipe"
+zn "%SYS"
+
+// package mapping
+set props("Database")="DPIPE-DATA"
+write ##class(Config.MapPackages).Create("USER", "DataPipe", .props)
+write ##class(Config.MapPackages).Create("USER", "Form", .props)
+
+// global mapping
+write ##class(Config.MapGlobals).Create("USER", "DataPipe*", .props)
+write ##class(Config.MapGlobals).Create("USER", "Form*", .props)
+
+// routine mapping
+write ##class(Config.MapRoutines).Create("USER", "Form*", .props)
+```
+
+3) Grant access to tables and views on `USER` namespace:
+
+```sql
+GRANT INSERT,SELECT,UPDATE ON DataPipe_Data.Pipe, DataPipe_Data.Preference TO DataPipe_Admin
+```
+
+```sql
+GRANT SELECT ON DataPipe_Data.VInbox, DataPipe_Data.VIngestion, DataPipe_Data.VStaging, DataPipe_Data.VOper TO DataPipe_Admin
 ```
+
+4) Load a sample production in `USER` which already have DataPipe components:
+
+```objectscript
+zn "USER"
+do $system.OBJ.Load("/app/install/SampleProduction.cls", "ck")
+```
+
+5) Start the production
+
+6) Send a test message
+
+```objectscript
+zn "USER"
+write ##class(DataPipe.Test.REST.Helper).SendHTTPRequests(1, "/test/user/api/message")
+```
+
+6) Check datapipeUI
+
 ## DataPipeUI considerations
 
 When enabling [datapipeUI](https://github.com/intersystems-ib/iris-datapipeUI), you must consider the following:

install/SampleProduction.cls

@@ -0,0 +1,27 @@
+Class Test.SampleProduction Extends Ens.Production
+{
+
+XData ProductionDefinition
+{
+<Production Name="Test.SampleProduction" TestingEnabled="true" LogGeneralTraceEvents="true">
+  <Description></Description>
+  <ActorPoolSize>2</ActorPoolSize>
+  <Setting Target="Adapter" Name="ShutdownTimeout">5</Setting>
+  <Setting Target="Adapter" Name="UpdateTimeout">5</Setting>
+  <Item Name="REST API In" Category="" ClassName="DataPipe.Test.REST.BS.ApiService" PoolSize="0" Enabled="true" Foreground="false" Comment="" LogTraceEvents="false" Schedule="">
+  </Item>
+  <Item Name="REST Ingestion" Category="Ingestion" ClassName="DataPipe.Test.REST.BP.RESTIngestion" PoolSize="1" Enabled="true" Foreground="false" Comment="" LogTraceEvents="false" Schedule="">
+  </Item>
+  <Item Name="REST Staging" Category="Staging" ClassName="DataPipe.Staging.BP.StagingManager" PoolSize="1" Enabled="true" Foreground="false" Comment="" LogTraceEvents="false" Schedule="">
+    <Setting Target="Host" Name="TargetConfigName">REST Oper</Setting>
+  </Item>
+  <Item Name="REST Oper" Category="Oper" ClassName="DataPipe.Oper.BP.OperManager" PoolSize="1" Enabled="true" Foreground="false" Comment="" LogTraceEvents="false" Schedule="">
+  </Item>
+  <Item Name="Person Operation" Category="Oper" ClassName="DataPipe.Oper.BO.OperationHandler" PoolSize="1" Enabled="true" Foreground="false" Comment="" LogTraceEvents="false" Schedule="">
+  </Item>
+  <Item Name="REST Delayed Oper Update" Category="" ClassName="DataPipe.Test.REST.BP.DelayedProcessing" PoolSize="1" Enabled="true" Foreground="false" Comment="" LogTraceEvents="true" Schedule="">
+  </Item>
+</Production>
+}
+
+}

install/roles.xml

@@ -11,6 +11,10 @@
         <Name>%DB_DPIPE</Name>
         <Permission>3</Permission>
       </Resource>
+      <Resource>
+        <Name>%DB_USER</Name>
+        <Permission>3</Permission>
+      </Resource>
       <Resource>
         <Name>%DB_HSLIB</Name>
         <Permission>3</Permission>

install/webapps.xml

@@ -31,4 +31,35 @@
     <UserCookieScope>2</UserCookieScope>
     <Version>2</Version>
   </Applications>
+  <Applications>
+    <AutheEnabled>32</AutheEnabled>
+    <AutoCompile>true</AutoCompile>
+    <CookiePath>/test/user/api/</CookiePath>
+    <CSPZENEnabled>true</CSPZENEnabled>
+    <CSRFToken>false</CSRFToken>
+    <DeepSeeEnabled>false</DeepSeeEnabled>
+    <DispatchClass>DataPipe.Test.REST.BS.ApiService</DispatchClass>
+    <Enabled>true</Enabled>
+    <HyperEvent>0</HyperEvent>
+    <iKnowEnabled>false</iKnowEnabled>
+    <InbndWebServicesEnabled>true</InbndWebServicesEnabled>
+    <IsNameSpaceDefault>false</IsNameSpaceDefault>
+    <JWTAuthEnabled>false</JWTAuthEnabled>
+    <JWTAccessTokenTimeout>60</JWTAccessTokenTimeout>
+    <JWTRefreshTokenTimeout>900</JWTRefreshTokenTimeout>
+    <LockCSPName>true</LockCSPName>
+    <Name>/test/user/api/</Name>
+    <NameSpace>USER</NameSpace>
+    <Recurse>true</Recurse>
+    <RedirectEmptyPath>false</RedirectEmptyPath>
+    <ServeFiles>1</ServeFiles>
+    <ServeFilesTimeout>3600</ServeFilesTimeout>
+    <Timeout>900</Timeout>
+    <TwoFactorEnabled>false</TwoFactorEnabled>
+    <Type>2</Type>
+    <UseCookies>2</UseCookies>
+    <SessionScope>2</SessionScope>
+    <UserCookieScope>2</UserCookieScope>
+    <Version>2</Version>
+  </Applications>
 </ApplicationsExport>

module.xml

@@ -3,7 +3,7 @@
   <Document name="iris-datapipe.ZPM">
     <Module>
       <Name>iris-datapipe</Name>
-      <Version>2.0.2</Version>
+      <Version>2.0.3</Version>
       <Description>DataPipe an interoperability framework to ingest data in InterSystems IRIS in a flexible way.</Description>
       <Keywords>datapipe ingestion staging validation</Keywords>
       <Author>

src/DataPipe/Data/Inbox.cls

@@ -35,6 +35,10 @@ Property LastStaging As Staging(%JSONREFERENCE = "ID");
 /// Ref. to last Oper
 Property LastOper As Oper(%JSONREFERENCE = "ID");
 
+/// Namespace where this record is processed
+/// This is useful when different namespaces map DataPipe package
+Property Namespace As %String [ InitialExpression = {$namespace} ];
+
 /// *Calculated* StagingStatus (from LastStaging). Used in queries from app
 Property StagingStatus As %String(MAXLEN = "") [ SqlComputeCode = { set {StagingStatus} = ##class(DataPipe.Data.Inbox).CalcSqlFieldById("LastStaging->Status", "N/A", {%%ID})
 }, SqlComputed, SqlComputeOnChange = %%UPDATE ];
@@ -80,6 +84,8 @@ Index ElementIdx On Element;
 
 Index SubjectIdx On Subject;
 
+Index NamespaceIdx On Namespace [ Type = bitmap ];
+
 /// Open callback. Check user can access record in view
 Method %OnOpen() As %Status [ Private, ServerOnly = 1 ]
 {
@@ -224,6 +230,9 @@ Storage Default
 <Value name="18">
 <Value>OperErrors</Value>
 </Value>
+<Value name="19">
+<Value>Namespace</Value>
+</Value>
 </Data>
 <DataLocation>^DataPipe.Data.InboxD</DataLocation>
 <DefaultData>InboxDefaultData</DefaultData>

src/DataPipe/REST/Main.cls

@@ -100,6 +100,8 @@ ClassMethod multiRepeat() As %Status
 			set %response.Status=..#HTTP401UNAUTHORIZED
 			quit
 		}
+		new $namespace
+		set defaultNs = $namespace
 
 		// parse body
         set input = {}.%FromJSON(%request.Content)
@@ -126,6 +128,13 @@ ClassMethod multiRepeat() As %Status
 					$$$ThrowStatus($$$ERROR($$$GeneralError, "Invalid type"))
 				}
 
+				// change namespace, this is used when DataPipe is mapped to multiple namespaces
+				if obj.Namespace'="" {
+					set $namespace = obj.Namespace
+				} else {
+					set $namespace = defaultNs
+				}
+
 				// resend interop message
 				;do $system.Security.Login("_Ensemble")
         		$$$ThrowOnError(##class(Ens.MessageHeader).NewDuplicatedMessage(.duplicatedHeader, headerId, ""))

src/DataPipe/Test/REST/Helper.cls

@@ -11,7 +11,7 @@ Parameter USERNAME = "superuser";
 
 Parameter PASSWORD = "SYS";
 
-ClassMethod SendHTTPRequests(pNumRequests As %Integer = 1) As %Status
+ClassMethod SendHTTPRequests(pNumRequests As %Integer = 1, appName = "/test/api/message") As %Status
 {
     set ret = $$$OK
     try {
@@ -27,7 +27,7 @@ ClassMethod SendHTTPRequests(pNumRequests As %Integer = 1) As %Status
             set headers("X-Forwarded-For") = "client-"_##class(%PopulateUtils).Syllable()
             set headers("X-Request-ID") = $system.Util.CreateGUID()
 
-            set sc = ..Post("/test/api/message", .headers, body, .resp)
+            set sc = ..Post(appName, .headers, body, .resp)
             $$$ThrowOnError(sc)
 
             if resp.StatusCode '= 200 {