Customization

Create new project

Create a new project that depends on PortalTemplate.

Project structure

Create new home page

Set category for tasks

To categorize tasks, set values for Category field. Task category can be multi-level if it is separated by slash / signs, as below.

How to use feature warning on closing browser/tab

Sometimes when users are working on a task, if they close tab, browser or refresh page then they may lose their current work. It's a good idea to ask users to verify that they truly want to proceed with the action they just invoke. To use this feature, add WarnOnClosingBrowserTab component to the page you want to be affected.

<ic:ch.ivy.addon.portalkit.feature.WarnOnClosingBrowserTab confirmMessage="You may lose your work in progress. Do you want to continue?" />

Depending on browser, content of confirmMessage and names of buttons may vary.

Create a new home page which uses the DefaultHomePageTemplate.xhtml template. By doing this, your new home page will inherit the widgets from the default home page and has a place holder for your own widgets.

Your custom home page should look like below:

<ui:composition template="/layouts/DefaultHomePageTemplate.xhtml" ... >

<ui:define name="customWidget">

...

</ui:define>

</ui:composition>

In case of single Portal: Create a new process start for the new home page. Now you will use this process start as the entry point of your portal instead of the default one. To let portal know about your new portal home, you have to go to the portal settings and set the portal home url to the new one. e.g: HOMEPAGE_URL=http://localhost:8081/ivy/pro/designer/CustomizePortalHome/157454FCA39C3844/start.ivp

In case of multi Portal: refer to Setup multi portals to setup.

Introduce an Axon Ivy project which has PortalTemplate as a required library.

To customize task widget, you must customize Portal Home first. Refer to Customize Portal home to set new home page.

Copy the PortalStart process from PortalTemplate to your project. Point PortalHome element to your custom home page in previous step. This process is new home page and administrator should register this link by Portal's Admin Settings.

Override Task widget in: TaskList page, Task Search result, Relate tasks of a case, History tasks of a case.

After previous steps, you can override TaskHeader and TaskListHeader and TaskBody and TaskFilter

Introduce a Axon Ivy project which has PortalTemplate as a required library and its own PortalStart process. Refer to step 1, 2, 3, 4 in override task widget's UI guide.

In your project, override the callable subprocess CalculateTaskDelegate

The callable subprocess data contains the current user in.currentUser and the current task to be delegated in.task. The lists in.users and in.roles contain all possible users and roles that the task can be delegated to. Modify those two to have your own delegate list.

Introduce an Axon Ivy project which has PortalTemplate as a required library.

Copy the PortalStart process from PortalTemplate to your project.

Introduce a new HtmlDialog Page which uses the template /layouts/PortalCasesTemplate.xhtml (refer to Responsiveness to override responsiveness). The PortalCasesTemplate is designed such that it will insert the content between its predefined place holder. Put your customized content in there. There is a placeholder named: caseBody. The effect only takes place when the ui:param named useOverrideBody is set to true. Clients can set this parameter to a value expression for flexibility. For example:

<ui:composition template="/layouts/PortalCasesTemplate.xhtml">

<ui:param name="useOverrideBody" value="#{not case.getCustomVarCharField1().isEmpty()}" />

<ui:define name="caseBody">

This is the customized content of the case: #{case.getId()}

<ui:fragment rendered="#{case.getCustomVarCharField1().equals('I am a secret')}">

<h:outputText value="I'm a secret case so I'm displayed differently" />

</ui:fragment>

<ui:fragment rendered="#{case.getCustomVarCharField1().equals('I am even more secret')}">

<!-- Put your secret content here -->

</ui:fragment>

</ui:define>

</ui:composition>

If you need to apply the responsiveness behavior of Portal, there are 2 components which can be used: ResponsivenessHandleContainer and ResponsivenessHandleButton:

Use Axon Ivy Override to override the OpenPortalCases callable . The original implementation is calling PortalCases, change it to call the Page introduced in the step above. The signature of this callable is useView(CaseView) and your customized Page must receive this CaseView instance, put in the dialog's Data with the exact name caseView.

Introduce a Business Process which starts the page PortalHome. To make the overriding take effect, the client must use this process to start Portal (instead of the original one on PortalTemplate). Remember to set the home page variable to the new home page url (see Portal home for more details).

In case you want to use the CaseTempate template, you may want to define the caseStatusTab with your customized content. For example:

<ui:composition template="/layouts/CaseTemplate.xhtml">

<ui:define name="caseStatusTab">

This is the customized content of the case: #{caseId}

</ui:define>

</ui:composition>

Create a new UI and start link of the new end page.

Create a callable sub process in your project with the handleEndPage() signature, make sure this signature is unique in your application. It must return start link of new end page you define in step 1.

Create a new additional case details UI and a start process which will display the new UI.

Store the URL of start process in "CUSTOMIZATION_ADDITIONAL_CASE_DETAILS_PAGE" additional property of case. You could use SetAdditonalCaseDetailPage.mod callable process, and input the friendly URL of process as parameter.