Custom Document View URL

Custom Document View

Custom Document View can be viewed on the left side of the Work Item Detail View page inside the frame as shown in the following image:

In AVEVA Work Tasks, you can provide a custom document view while using any human activity. Enter the proper URL for the Custom Document View URL property to view the custom document view. By default, the custom document view for any human resource activity normally shows the item metadata that alerts the workflow.

1. If the workflow is alerted due to a Enterprise Console event association, document view shows the list item metadata that alerted the workflow. For example, if the workflow is alerted due to a workflow event association to a list, document view shows the list item that alerted the workflow.

2. If the workflow is alerted due to a workflow association in Forms, document view shows the form that alerted the workflow.

You can change the document view as required. If a URL is provided to the custom document view URL property, this can be overridden with the default document view.

3. If you want to show a different form in the Custom Document View, see Custom Document View URL for Forms.

4. If you want to show a different form or list item in the Custom Document View, see Custom Document View URL for List Item.

You can provide any URL can be provided to this property. This URL can be a URL to your custom page, too.

Custom Document View URL for Forms

If the workflow is alerted due to a workflow association in forms, document view shows the form that alerted the workflow.

Use the following URL with respective parameters to show any forms.

http://<%ApplicationPath%>/BPMUITemplates/Default/SkeltaForms/FormDocumentView.aspx?FormName=<Form Name>&FormVersion=<Form Version>&FormInstanceXmlVariable=<Xml Variable Name>

FormName: Name of the form to be loaded in document view.

FormVersion: Version of the form to be loaded. By default the latest published version will be loaded. This parameter need to be used only if a specific version has to be loaded.

FormInstanceXMLVariable: XML variable name which is to be used for populating the form. If this parameter is not passed, SFFormData XML Variable will be considered as default.

Example:

For showing any form and populate data from XML variable, pass the following parameters in query string provided both having same XML schema.

FormName=<Form Name>& FormInstanceXmlVariable=<Xml Variable Name>

Sample URL:

http://<%ApplicationPath%>/BPMUITemplates/Default/SkeltaForms/FormDocumentView.aspx?FormName=Leave Report&FormInstanceXmlVariable=LeaveReportxml

When the workflow is executed, the Custom Document View of the specified form populated using XML variable is displayed in the Work Item detail View page.

Custom Document View URL for List Item or Enterprise Console

If the workflow is alerted due to a workflow association in list, document view shows the form that alerted the workflow.

Use the following URL with respective parameters to show any List Item metadata:

http://<%ApplicationPath%>/BPMUITemplates/Default/SkeltaForms/FormDocumentView.aspx?FormName=<Form Name>& ListName=<List Name>&ListItemId=<List Item Id>&FormInstanceXmlVariable=<Xml Variable Name>

FormName: Name of the form to be loaded in document view.

ListName: Name of the list from where the list item need to be loaded. This parameter needs to be passed only if ListItemId parameter is used.

ListItemId: Id of the list item which need to be loaded to populate the form. If the value of this is passed as 0, then list item id which alerted the workflow is considered as default. This parameter need not be passed, if form is populated using a FormInstanceXMLVariable.

FormInstanceXMLVariable: XML variable name which is to be used for populating the form.

Example:

• To show any form and populate data from XML variable, pass the following parameters in query string: FormName=<Form Name>& FormInstanceXmlVariable=<Xml Variable Name>

  Sample URL:

  http://<%ApplicationPath%>/BPMUITemplates/Default/SkeltaForms/FormDocumentView.aspx?FormName=Leave Report&FormInstanceXmlVariable=LeaveReportxml

• To show any form and populate data from a list item, use the following format:

  FormName=<Form Name>& ListName=<List Name>&ListItemId=<List Item Id>

  Sample URL:

  http://<%ApplicationPath%>/BPMUITemplates/Default/SkeltaForms/FormDocumentView.aspx?FormName=Leave Report&ListName=Leave Application&ListItemId=4b3a003-1719-4015-9128-2fe29b9dc535

  If <List Item Id> is passed as 0, then list item ID which alerted the workflow is taken.

  Sample URL:

  http://<%ApplicationPath%>/BPMUITemplates/Default/SkeltaForms/FormDocumentView.aspx?FormName=Leave Report&ListName=Leave Approval&ListItemId=0