IDMReportParams

IDMReportParams is passed as input to CreateIDMReport function. The IDMReportParams properties are as shown in table below. XmlData, templateFileName, targetFileName are required properties that cannot be left null.

Properties Description
xmlData XML Data of Object as String
templateFileName The Report Template name in IDM.
targetFileName Denotes the generated report name.
templateDocCode (Optional)

IDM Document Type which contains Template Word File.

By default, a profile attribute IDM.REPORT_TEMPLATEDOCCODE is added, the function will read value from profile. User can configure any IDM Doc Type as Template Doc Code and assign it to a profile attribute in Optiva or they can give as argument as shown below. A PLM for Process Function Code of the same name is optional. Templates are not attached to PLM for Process objects.

Example:
 reportParams.templateDocCode = 
“OPTIVA_REPORT_TEMPLATES”
sendEmail (Optional)

It is a Boolean type. If user set sendEmail to true, the report generated will be sent to the given email address.

Example: 
reportParams.sendEmail = True
targetEmailAddresses (Optional)

Email address where report should be sent, if sendEmail is set to true.

It will support multiple addresses by passing it as a comma separated.

Example:
 reportParams.targetEmailAddresses = 
“Firstname1.Lastname1@infor.com;
Firstname2.Lastname2@infor.com”
ReturnFileContent (Optional)

It is Boolean type, and you can specify whether you want the file content as byte array in the response or not.

Example: 
reportParams.ReturnFileContent = True
TargetDocCode (Optional)

IDM Doc Type to which generated report should be attached.

By default, a profile attribute IDM.REPORT_STAGINGDOCCODE is added, and the function will read the value from the profile. However, you can configure any IDM Doc Type as Target Doc Code and decide to use different Doc Types for different objects or reports. In most cases, you will also create a PLM for Process function code with the same name for visibility inside PLM for Process. Use of this function will also require the next section of code, creating a CMItem.

Example: 
reportParams.targetDocCode = “OPTIVA_STAGING_DOC”

targetCMItem

(Optional, used with TargetDocCode)

If you specify targetDocCode, then the user should create a CMItem and should pass it to function with all required attributes.

Example: 

Dim targetCMItem As DocICP.CMItem = New DocICP.CMItem()
targetCMItem.EntityName = targetDocCode
targetCMItem.SetAttributeValue("OPTIVA_SYMBOL", _OBJECTSYMBOL, DocICP.DataType.String)
objKey = _OBJECTKEY.Split("\")
targetCMItem.SetAttributeValue("OPTIVA_SYMBOL_ID", objKey(0), DocICP.DataType.String)
If objKey.Length > 1 Then targetCMItem.SetAttributeValue("OPTIVA_SYMBOL_VERSION", 
objKey(1), DocICP.DataType.String)
reportParams.targetCMItem = targetCMItem