Skip Navigation
Expand
Configuring Custom Objects for the Mobile Agent App
Answer ID 7028   |   Last Review Date 01/07/2019

How do I configure a custom object on the Mobile Agent App?

Environment:

Oracle Human Capital Management Cloud (Oracle HCM Cloud)
Also known as Mobile Agent App / Oracle Tap

  • Apple iPad with iOS6 or iOS7 operating system
  • Oracle Tap iOS application (downloaded from the Apple appstore)
  • Oracle Service Cloud May 2014 and newer

NOTE: Oracle Service Cloud Mobile Agent App (TAP) is deprecated as of May 2017

Resolution:

The Mobile Agent App allows users to interact with custom objects that you have configured in your system, including searching and viewing custom objects, and viewing custom objects associated to contacts and incidents.

This answer specifies the steps to configure custom objects in the Mobile Agent App for your Oracle Service Cloud instance. It is meant to be an addendum to the published Service / Mobile Agent App section of the User Guide linked here.

Before You Begin:

  • Enable the mobile agent application for users in your environment (See the Getting Started section of the User Guide for instructions).
  • Determine the relationship of your custom object to the standard objects used in the mobile agent application. In particular, note if the custom object is modeled as a parent or child of the related standard object, then please see the appropriate section below.


Click the plus sign next to the appropriate heading below to expand that section for viewing.

 Steps to enable Custom Objects as a Parent of Another Object 

  1. Create and deploy a custom object, and add a relationship where the custom object is the parent of the related object. You can also use existing custom objects that you already set up in your Oracle Service Cloud instance. Refer to the Custom Object section of the online documentation.
  2. Create a new workspace for the custom object.

    a. Go to Configuration > Application Appearance > Workspaces/Workflows

    b. From the ribbon, select New Workspace

    c. Find the section listing the Mobile Workspace types and find the type containing the name of your custom object.

    d. The workspace designer will display a left hand side with a summary form, and child tabs along the right hand side.

    e. In the workspace designer, use the Insert Fields section of the ribbon to add fields from your custom object to the layout. You can add fields from your custom object to the summary form (left hand side) or the details tab (right hand side).

    f. Save your workspace.

  3. Associate the custom object to the related object's workspace (contact, incident, or another custom object).

    a. In this example, we will use the mobile incident workspace. Steps for associating to the mobile contact workspace or another related custom object are similar.

    b. Go to Configuration > Application Appearance > Workspaces/Workflows.

    c. Browse through the folders to find your active Mobile Incident Workspace. Be sure to copy the workspace if you want to preserve your previous layout.

    i. If this is the first time you are configuring the mobile incident workspace, you can find a default sample workspace in the Standard folder (name = Mobile Incident) and make a copy.

    d. Open and edit the workspace definition for your copy.

    e. In the Insert Fields section of the ribbon, you should see an association field for the related custom object.

    f. Add the field to the summary or detail form of the incident. This field will allow the user to search and select from a list of custom object records to associate to the incident.

    g. Save your workspace.

  4. Create a table report to display a list of custom object records to users.

    h. Go to Analytics > Reports Explorer.

    i. On the ribbon, select New Report and choose standard report.

    j. In the data dictionary, find the table for your custom object. The name of the table will usually show the display name, followed by the folder where you created the custom object in the Object Designer followed by $ and the name of your custom object. For example, a custom object in the CO folder would appear as MyDisplayName (CO$MyCustomObject).

    k. Add the desired columns to the report.

    l.  Be sure to include the ID field from the custom object in the column set.

    m.  Optionally, add filters if you want to constrain the data that is returned to users.

    n.  Save your report.

  5. Add access permissions to the custom object to the profile.

    o.  Find the profile where you want to expose the custom object data to users. ( Note that you can have multiple profiles used across mobile users to support different layouts and permissions.) Go to Configuration > Staff Management > Profiles.

    p.  Open the profile.

    q.  In the ribbon, select Permissions.

    r.  Select the Custom Objects tab and find your custom object.

    s.  Give the profile the desired permissions for the object (Create/Read/Update/Delete).

  6. Associate your custom object workspace to the profile.

    t.  Go to Configuration > Staff Management > Profiles.

    u.  Open the profile.

    v.  Select the Workspaces/Workflows tab. Scroll down the table to find your custom object for mobile. The naming convention is "CustomObjectName Mobile".

    w.  Use the magnifying glass to browse for the mobile custom object workspace you created above and associate it to your profile.

  7. Associate your modified mobile incident workspace to the profile. (Follow similar steps for mobile contact workspaces).

    x.  Go to Configuration > Staff Management > Profiles.

    y.  Open the profile.

    z.  Select the Workspaces / Workflows tab. Scroll down to find "ContactMobile".

    aa.  If you have never modified this setting before, the default value will show [No Value].

    bb.  Override the setting to select your modified mobile incident workspace. Use the magnifying glass to browse for the modified incident workspace you edited previously and associate it to the profile. Click OK.

  8. Associate the custom object to the mobile shuttle menu using the mobile navigation set.

    cc.  Go to Configuration > Application Appearance > Navigation Sets.

    dd.  Find the Default Mobile Navigation item and Copy it.

    ee. Double click to start editing your copied navigation set.

    ff.  In the navigation set editor, in the upper right section, select the custom object in the tree. Then use the left side folders to browse and select for the report you created previously. Use the 'Add' button to associate it to the navigation set on the bottom right-hand section.

    i. Note that you can only associate one report to the custom object in the navigation set.

    gg. Save your Navigation set.

  9. Associate the modified navigation set to the interface(s) for the user.

    hh.  Go to Configuration > Staff Management > Profiles.

    ii.  Open the profile.

    jj.  On the top of the main page for the profile will be a table listing the interfaces.

    kk.  In the Mobile Navigation Set column, use the magnifying glass to browse for the navigation set you modified in the previous step. Click OK.

  10. To test your configuration, log into the mobile agent app on your iOS device. Each time you login, it will reload the configuration changes. Log out and relogin anytime you change the User Interface configuration. 

 Steps to enable a Custom Object as a Child of Another Object

  1. Create and deploy a custom object, and add a relationship where the custom object is the child of the related object. You can also use existing custom objects that you already set up in your Oracle Service Cloud instance. Refer to the Custom Object section of the online documentation.
  2. Create a new workspace for the custom object.

    a. Go to Configuration > Application Appearance > Workspaces/Workflows

    b. From the ribbon, select New Workspace

    c.  Find the section listing the Mobile Workspace types and find the type containing the name of your custom object.

    d.  The workspace designer will display a left hand side with a summary form, and child tabs along the right hand side.

    e.  In the workspace designer, use the Insert Fields section of the ribbon to add fields from your custom object to the layout. You can add fields from your custom object to the summary form (left hand side) or the details tab (right hand side).

    f.  Save your workspace.

    1. Create a table report to display a list of custom object records to users.

      a.  Go to Analytics > Reports Explorer.

      b.  On the ribbon, select New Report and choose standard report.

      c.  In the data dictionary, find the table for your custom object. The name of the table will usually show the display name, followed by the folder where you created the custom object in the Object Designer followed by $ and the name of your custom object. For example, a custom object in the CO folder would appear as:  MyDisplayName (CO$MyCustomObject).

      d.  Add the desired columns to the report.

      e.  Be sure to include the ID field from the custom object in the column set.

      i. Note: the ID column in the report must be set to return an integer. If you have used the labels feature on the underlying custom object definition, the ID column might return a different data type. In this case, you may need to go into the report definition and override the expression that defines the ID column in the report to include ID.id, like this: CO$MyCustomObject.ID.id.

      f.  Add a filter to the report, so that only the child records related to the parent record are returned. In the report designer, on the ribbon select Home > Filters > Filter Editor from the ribbon then add a new filter.

      The table below describes the filter you need to create.
       Filter Field  Description

       Type

       Run-time selectable
       Name

       Use the name of the parent object.

       e.g. Incident

       Prompt

       Depends on the parent object

       Contact

       or

       Incident

       or

       Parent Custom object

       Expression

       Follow the expression structure:

       ObjectFolders$MyCustomObject.ParentObject

       e.g. CO$MyCustomObject.Incident

       Note: when you are defining the expression for your filter in the report, you can browse the data dictionary and find the parent field from your custom object. This will insert the correct syntax into the expression to match the above example.

       Operator  Equals
       Value  (leave blank) will be passed at runtime
       Data Type   Integer


      g.  Save your report.

  3. Add a report tab to display the list of associated custom object records in the parent object's workspace (contact, incident, or another custom object).

    a.  In this example, we will use the mobile incident workspace. Steps for associating to the mobile contact workspace or another related custom object are similar.

    b.  Go to Configuration > Application Appearance > Workspaces/Workflows.

    c.  Browse through the folders to find your active Mobile Incident Workspace. Be sure to copy the workspace if you want to preserve your previous layout.

    i  If this is the first time you are configuring the mobile incident workspace, you can find a default sample workspace in the Standard folder (name = Mobile Incident) and make a copy.

    d.  Open and edit the workspace definition for your copy.

    e.  On the right-hand side, add a tab.

    f.  Select the tab with your mouse. On the ribbon, go to Design > then select Tab Type. Set the Tab Type as 'Report'.

    g.  Once the tab type is set to 'Report' the ribbon will show a 'Report' button. Place your mouse on the body of the child tab, then click the Report button. In the popup, find the report that you created previously. Click OK.

    i.  Note: your report must include the ID column from the child custom object.

    h.  Save your workspace.

  4. Add access permissions to the custom object to the profile.

    i.  Find the profile where you want to expose the custom object data to users. (Note that you can have multiple profiles used across mobile users to support different layouts and permissions.) Go to Configuration > Staff Management > Profiles.

    j.  Open the profile.

    k.  In the ribbon, select Permissions.

    l.  Select the custom objects tab and find your custom object.

    m.  Give the profile the desired permissions for the object (Create/Read/Update/Delete).

  5. Associate your custom object workspace to the profile.

    n.  Go to Configuration > Staff Management > Profiles.

    o.  Open the profile.

    p.  Select the Workspaces/Workflows tab. Scroll down the table to find your custom object for mobile. The naming convention is "CustomObjectName Mobile".

    q.  Use the magnifying glass to browse for the mobile custom object workspace you created above and associate it to the profile. Click OK.

  6. Associate your modified mobile incident workspace to the profile. (Follow similar steps for mobile contact workspaces).

    r.  Go to Configuration > Staff Management > Profiles.

    s.  Open the profile.

    t.  Select the Workspaces/Workflows tab. Scroll down the table to find "Contact Mobile".

    u.  If you have never modified this setting before, the default value will show [No Value].

    v.  Override the setting to select your modified mobile incident workspace. Use the magnifying glass to browse for the modified incident workspace you edited previously, and associate it to the profile. Click OK.

  7. Associate your custom object to the mobile shuttle menu using the mobile navigation set.

    w.  Go to Configuration > Application Appearance > Navigation sets.

    x.  Find the Default Mobile Navigation item and Copy it.

    y.  Double-click to start editing your copied navigation set.

    z.  In the navigation set editor, in the upper right section, select the custom object in the tree. Then use the left side folders to browse and select for the report you created previously. Use the 'Add' button to associate it to the navigation set on the bottom right-hand section.

    i.  Note that you can only associate one report to the custom object in the navigation set.

    aa.  Save your Navigation set.

  8. Associate your modified navigation set to the interface(s) for the user.

    bb.  Go to Configuration > Staff Management > Profiles.

    cc.  Open the profile.

    dd.  On the top of the main page for the profile will be a table listing the interfaces.

    ee.  In the Mobile Navigation Set column, use the magnifying glass to browse for the navigation set you modified in the previous step. Click OK.

  9. To test your configuration, log into the mobile agent app on your iOS device. Each time you login, it will reload the configuration changes. Log out and relogin anytime you change the User Interface configuration.


Limitations

  • The Mobile Agent App only supports associating custom objects to Contacts, Incidents or other custom objects. Custom Object data cannot be displayed within the mobile User Interface pages for Organization, Tasks, or Accounts.
  • For custom mobile reports:
    • The mobile application will only display a limited number of columns on the device. On the iPad, the report will show the first 8 columns. On the iPhone, the report will show the first 5 columns.
    • The mobile application only supports basic table formatting. Other visualizations such as charts and conditional formatting cannot be displayed.
  • When you create a new custom object record within the mobile application, the association with the parent object will not automatically be populated on the custom object record. The user must manually select the correct parent object to associate, as well as populate the other fields on the record. When users are creating new custom records within the child tab of the parent workspace, you should include the pick list field for the parent on the summary form of the custom object to ensure users can select this value in the UI.
  • Mobile Workspaces are distinct from regular workspaces in the Agent Desktop SmartClient. The Workspace Rules and Workflow frameworks are not available for mobile workspaces in the Mobile Agent App.

Available Languages for this Answer:

Notify Me
The page will refresh upon submission. Any pending input will be lost.