Intellicus Enterprise Reporting and Business Insights 19.0

Sample XML file for Integration (Integration.xml)

0 views June 28, 2020 0

Integration xml file contains the various integration requirement details.

Integration requirement may include User management, Host web server IP authentication, Admin user credentials, etc.

Host application would require making changes in the ReportController.jsp and ReportControllerDetail.jsp corresponding to details mentioned in this integration xml.

These two JSPs are placed at:

<Intellicus_Install_path>Jakartawebappsintellicus

Note: If any changes are made in xml, then Intellicus Web server need to be restarted.

Below is sample of Integration xml:

<INTEGRATION_DETAILS CREATE_USER="true" CREATE_ORG="true" CREATE_MAPPING="true" UPDATE_CONN_AR="true" PERMISSION_TO_CONN="ROLE" UPDATE_USER="true" >

	<HOST_WEBSERVER_DETAIL IP="">
	</HOST_WEBSERVER_DETAIL>

	<ADMIN_USER>
	<ID USERID="" PASSWORD="" ORGID=""/>
	</ADMIN_USER>
		
	<REPORTING_ROLES UPDATE_ORG_ROLES="true" UPDATE_USER_ROLES="false">
		<REPORTING_ROLE NAME="Basic">
			<ENTITY_TYPES>
				<ENTITY_TYPE TYPE="CAT">
					<ENTITY  CREATION="Static" ID="4F9245A7-D639-4F99-604D-F32641B77725"  ACCESS_LEVEL="2" ACCESSRIGHT="0,2,4,6,8,10,12" ></ENTITY> 
					<ENTITY  CREATION="Dynamic" ID="&lt;%prmCategoryName%&gt;"  ACCESS_LEVEL="2" ACCESSRIGHT="0,2,4,6,8,10,12" PARAM="prmCategoryName"></ENTITY>	
				</ENTITY_TYPE>
			</ENTITY_TYPES >
		</REPORTING_ROLE>
		<REPORTING_ROLE NAME="Admin">	
			<ENTITY_TYPES >
				<ENTITY_TYPE TYPE="CAT">
					<ENTITY CREATION="Static" ID="Setup"  ACCESS_LEVEL="2" ACCESSRIGHT="0,2,4,6,8,10,12" ></ENTITY> 
					<ENTITY CREATION="Dynamic" ID="Finance_&lt;%prmCategoryName%&gt;"  ACCESS_LEVEL="2" ACCESSRIGHT="0,2,4,6,8,10,12" PARAM="prmCategoryName"></ENTITY>	
					<ENTITY CREATION="Dynamic" ID="HR_&lt;%prmCategoryName%&gt;"  ACCESS_LEVEL="2" ACCESSRIGHT="0,2,4,6,8,10,12" PARAM="prmCategoryName"></ENTITY>	
				</ENTITY_TYPE>
			</ENTITY_TYPES>
		</REPORTING_ROLE>
		
	</REPORTING_ROLES>

</INTEGRATION_DETAILS>

 

Details of xml:

  • <INTEGRATION_DETAILS> tag:

CREATE_USER:

Possible values:

true: Check for existence of User at run time. If User does not exist, create the User at Intellicus.

false: Do not check for existence of User at run time.

If CREATE_USER is true then only further attributes like CREATE_ORG, CREATE_MAPPING will be considered.

No other tag/attribute in xml is dependent on CREATE_USER attribute.

Dynamic user creation is supported only for “Host Application” and “Call Back” authentication mode.

CREATE_ORG:

This attribute is read only when CREATE_USER is true.

Dynamic organization creation is supported only for “Host Application” authentication mode.

Possible values:

true: Check for existence of Organization at run time. If Organization does not exist, create the Organization at Intellicus.

false: Do not check for existence of Organization at run time.

CREATE_MAPPING:

This attribute is read only when CREATE_USER is true.

Possible values:

true: Check for existence for user mapping at run time if user already exists. If user mapping does not exist, create the mapping of at Intellicus.

False: Do not check for existence for user mapping at run time if user already exists.

UPDATE_CONN_AR:

Possible value: true/false

true: Allow modification of access control for any DBCONNECTION Object at Intellicus.

false: Do not allow modification of access control for any DBCONNECTION Object at Intellicus.

PERMISSION_TO_CONN:

This attribute is read only when UPDATE_CONN_AR is true.

It is for providing access control of any DBCONNECTION to any ORG/ROLE/USER.

Possible values: ORG/ ROLE/USER.

ORG: Grant access control of DBCONNECTION Object on ORG. ORG can be existing/new.

ROLE:  Grant access control of DBCONNECTION Object   on ROLE level. ROLE can be existing/new.

USER: Grant access control of DBCONNECTION Object   on USER level. USER can be existing/new.

UPDATE_USER:

This is applicable for both new user (user mapping is added for existing user) as well as existing user

Possible value: true/false

true: Allow modification of existing user’s attributes.

false: Do not allow modification of  existing user’s attributes

<HOST_WEBSERVER_DETAIL> tag:

IP:

List of IP addresses separated by ‘,’ on which Host application is running.

If host application is running on multiple web servers, then IP address for each web server should be mentioned, separated by “,”.

If this authentication is not required, then leave the IP attribute of the <HOST_WEBSERVER_DETAIL> tag empty.

Note: If both Host application and Intellicus are running on the same web server, then give the IP address of localhost i.e. 127.0.0.1

  • <ADMIN_USER> tag:

    Credentials of admin user having system privileges of super admin can be entered in this xml under the tag <ADMIN_USER>.

  • <REPORTING_ROLES> tag:

    All the reporting roles should be defined in this xml under this tag. Only those roles that are defined under this tag are created at Intellicus.

UPDATE_ORG_ROLES:

Possible values:

true:check for the existence of the roles at run time to match with xml if org already exists. If any role does not exist, then add that role to the organization.

false: Do not check for the existence of the roles at run time to match with xml if org already exists.

UPDATE_USER_ROLES:

Possible values:

true: check for the role assigned to user at run time to match with xml, if user already exists.

false: Do not check for the role assigned to user at run time to match with xml, if user already exists.

Each reporting role has following properties:

Name: Name of the role

Access right of Role are:

  1. ENTITY_TYPE: It can be “CAT” for category or “REPORT” for report.
  2. ENTITY on which access need to be provided.
  3. Attributes of ENTITY if ENTITY_TYPE is CAT are:

CREATION: If the entity will be created dynamically or manually.

Dynamic: For dynamic creation.

Static: For manual creation.

ID: Id of entity.

ACCESS_LEVEL:

Deny Access: 0.

Full Access: 1.

Partial Access: 2.

ACCESSRIGHT:The possible values for entity type category are

View reports: 0.

View reports secured: 1

Save reports: 2

Save reports secured:3

Export reports: 4.

Export reports secured: 5

Print reports: 6

Print reports secured: 7

Print reports at server: 8

Print reports at server secured: 9

Schedule reports: 10

Publish layouts: 11

Publish outputs: 12

PARAM: If any parameter is associated with that entity. This is applicable to only Dynamic creation entities.