Reminders Portlets in SDF Custom Objects

You can create Reminders portlets in SuiteCloud Development Framework (SDF) using the publisheddashboard SDF custom object. For information about the appropriate context, see Published Dashboards as XML Definitions.

A Reminders portlet displays important tasks in NetSuite, such as things that are past due or soon due to be completed. You can define a reminders portlet in a published dashboard using the reminders element.

You can define the following kinds of reminders:

System-defined reminders, are reminders provided by NetSuite for frequently needed use-cases. Some system-defined reminders require that the days field be specified in the reminder definition.

For the list of available standard reminders that can be specified in SDF, see reminders_standard_reminders_with_days and reminders_standard_reminders_without_days. For the equivalent NetSuite user interface names with descriptions, see System-Defined Reminders Table.

Valid system-defined reminders in SDF depend on the user’s role and the features enabled in the target NetSuite account. To determine the NetSuite features that need to be added to the project manifest, consult the SuiteCloud Development Framework XML Reference or validation log.

The following example defines a reminder that displays the number of direct deposits the user needs to approve. Clicking this reminder in NetSuite takes the user to the Approve Direct Deposit Payments page filtered to list all payments pending approval.
```
              <reminder>
    <id>DIRECTDEPOSITSTOAPPROVE</id>
</reminder> 

            
```
Custom reminders, are reminders defined by you. Custom reminders can be useful when the reminders provided by NetSuite do not meet all of your users’ needs. Custom reminders are based on the results of a saved search.

Important:
Each custom reminder requires a reference to a savedsearch object. If the referenced savedsearch object is not included in your SuiteCloud project, ensure the manifest file is updated with the dependency. If your SuiteCloud project is a SuiteApp project, it must include the savedsearch object. Only account customization projects can exclude the savedsearc h object from the SuiteCloud project.

If you are including the savedsearch object in your SuiteCloud project, the XML must be generated by NetSuite. Do not edit the savedsearch object in SDF.

Before a saved search can be used in the custom reminder, the Available for Reminders box must be enabled on that saved search. For more information, see Defining a Saved Search and Creating Custom Reminders.

The following example defines a customer reminder that references a saved search object:
```
              <reminder>
    <id>[scriptid=customsearch_emps_kwolfe]</id>
</reminder> 

            
```

For each reminder, highlighting can be defined using the highlightingrules element. For the list of possible color values, see reminders_highlighting_rules_colors.

The following example defines a reminder that is highlighted red when there are 5 or more employes with authorization expiring in the next 15 days.

          <reminder>
    <days>15</days>
    <id>EMPLOYEESWITHEXPIRINGAUTHORIZATION</id>
    <highlightingrules>
        <rule>
            <color>RED</color>
            <greaterthanorequalto>5</greaterthanorequalto>
        </rule>
    </highlightingrules>
</reminder>

The following global options can be specified for all reminders in the portlet:

To display the reminder in the reminders portlet even when there is nothing to remind, set showzeroresults to T.
To minimize the reminder in the reminders portlet, set isminimized to T.

Reminders can be specified in the following locations of the reminders portlet:

Adding reminders to the headline element displays the reminders in the upper part of the reminders portlet and with a more prominent layout.

The following example defines a reminder in the headline location:
```
              <headline>
    <reminder>
        <days>7</days>
        <id>EMPLOYEESWITHUPCOMINGBIRTHDAY</id>
    </reminder>
</headline> 

            
```
Adding reminders to the other element displays the reminders in the lower part of the reminders portlet with the standard layout.

The following example defines a reminder in the other location:
```
              <other>
    <reminder>
        <id>[scriptid=customsearch_emps_kwolfe]</id>
    </reminder>
</other> 

            
```

The following example defines a Reminders portlet with several reminders as part of a published dashboard object:

          <publisheddashboard scriptid="custpubdashboard_reminders">
    <center>ACCOUNTCENTER</center>
    <locknewbar>F</locknewbar>
    <lockshortcuts>F</lockshortcuts>
    <name>Reminders</name>
    <notes/>
    <roles>
        <role>
            <role>HUMAN_RESOURCES_GENERALIST</role>
       </role>
    </roles>
    <dashboards>
        <dashboard>
            <centertab>BASICCENTERHOMEHOME</centertab>
            <layout>THREE_COLUMN</layout>
            <mode>UNLOCKED</mode>
            <leftcolumn>
                <reminders>
                    <isminimized>F</isminimized>
                    <showzeroresults>T</showzeroresults>
                    <headline>
                        <reminder>
                            <days>5</days>
                            <id>EMPLOYEESWITHUPCOMINGANNIVERSARY</id>
                            <highlightingrules>
                                <rule>
                                    <color>BLUE</color>
                                    <greaterthanorequalto>1</greaterthanorequalto>
                                </rule>
                            </highlightingrules>
                        </reminder>
                        <reminder>
                            <days>7</days>
                            <id>EMPLOYEESWITHUPCOMINGBIRTHDAY</id>
                        </reminder>
                    </headline>
                    <other>
                        <reminder>
                            <id>[scriptid=customsearch_emps_kwolfe]</id>
                        </reminder>
                    </other>
                </reminders>
            </leftcolumn>
        </dashboard>
    </dashboards>
</publisheddashboard>

Related Topics