Skip to content

This guide provides instructions and information about Stanford Web Services Jumpstart platform, based on Drupal 7.

We've released our new Stanford Sites on Drupal 8 (D8) platform — the new framework for Stanford Sites in 2020 and beyond. Check out our new User Guide to help you set up your website on the D8 platform. 

Read more about our road to D8 

Configuring CAPx

Configure CAPx settings

In order to add CAP profiles to your site, Faculty and Staff must have their CAP profiles set to Public. Any profile information you wish to appear on the site must first be filled out in the person's CAP profile.

Configuring CAPx

From an admin account, hover over Configuration and click CAPx.

Connect

Before configuring CAPx, you must first connect to the CAP API.

  1. Click the Connect tab on the top right of the page.
  2. File a HelpSU ticket to receive an authentication code and password.
  3. Enter the Client ID and Password you received from HelpSUNote: do not enter your SUNet ID and password
  4. Click Save connection settings.

Settings

Before you begin customizing CAPx, you will need to sync your site to the CAP API to ensure the system functions properly.

  1. Click the Settings tab on the top right of the page.
  2. In the Organization section, click the Get organization data button.
  3. In the Schema Information section, click the Get schema information button.
  4. Click Save settings when you are finished.

Map

Mapping allows you to choose what information is pulled from CAP to display on your site. A default mapping may be provided (depending on the Jumpstart product you are using), otherwise the default mapping will be blank.

View or edit a current mapping

  1. Click the Map tab on the top right of the page.
  2. Click edit on the mapping you’d like to change.
  3. In the Field Mapping section, click Stanford_Person Fields.
  4. If you wish for a field to no longer display data, delete the text in the value box.
  5. To have a field display a different kind of data, delete the current text in the value box and replace it with a new setting code.
    1. A list of commonly used setting codes is provided on the right sidebar under Data Browser.
    2. If the setting you want is not shown in the table, click the Open Data Schema button. Find the setting you want and enter it into the value box.
  6. If you wish to have a blank field display data, you will need to locate the setting code and enter it into the value box.
    1. A list of commonly used setting codes is provided on the right sidebar under Data Browser.
    2. If the setting you want is not shown in the table, click the Open Data Schema button. Find the setting code you want and enter it into the value box.
  7.  When you are finished, click Save Mapping.

Create a new mapping

If you do not wish to use the default mapping, you will have to create a new mapping.

  1. Click the Map tab on the top right of the page.
  2. Click the Create New Mapping button.
  3. Enter a name for your mapping in the Mapping Title box.
  4. In the Entity Mapping section, the Entity Type should already read Node and the Bundle should read Person.
  5. In the Field Mapping section, click Stanford_Person Fields.
  6. Enter the setting code into the fields you wish to display data.
    1. A list of commonly used settings is provided on the right sidebar under Data Browser.
    2. If the setting you want is not shown in the table, click the Open Data Schema button. Find the setting code you want and enter it into the value box.
  7. When you are finished, click Save Mapping.

Import

Importing refers to how CAP syncs with your site to update information.

Note: All data pulled from CAP must be edited on the person’s CAP profile and cannot be edited locally on your site; person fields that are synced with CAP will be greyed out. Any changes made to a CAP profile will be reflected on your site when the next sync occurs.

Create a new importer

  1. Click the Import tab on the top right of the page.
  2. Click the Create new importer button.
  3. In the Configuration section, enter a name in the Importer name field. Under Select Mapping, choose which mapping you wish to use.
  4. Select your preferences in the Automatic Synchronization Options section.
    1. The Interval must be set to something other than Do not sync in order for the importer to be active. We recommend setting the Interval to Once a day with At hour of the day set to a time in the middle of the night.
    2. Action to perform on orphaned profiles will control what happens to Person nodes when the synced profile disappears from CAP (such as deleted or hidden). 
  5. If you wish to add specific groups or individuals you have three options: OrganizationWorkgroup, or by SUNet ID. Fill out desired fields. You can fill out any or all of the fields, and have multiple organizations or SUNet IDs as well.
    1. We recommend importing via workgroups as they are the easiest to manage and use.
  6. If you only wish to save the importer settings, click the Save button. If you wish to save the importer settings and start the initial import, click the Save & Import Now button.

Edit an existing importer

  1. Click the Import tab on the top right of the page.
  2. Find the importer you wish to make changes to and click edit.
  3. Make desired changes. (Note: You will not be able to change the name of the Importer.)
  4. If you only wish to save the importer changes, click the Save button. If you wish to save the importer changes and start the import, click the Save & Import Now button.

Delete importer

  1. Click the Import tab on the top right of the page.
  2. Find the importer you wish to delete and click Delete.
  3. From the dropdown, select what you would like to do with the profiles associated with the Importer.
  4. Click the Yes, please delete the importer button.
  5. Deleting an importer does not delete the profiles or information associated with the importer, but it does stop the sync with CAP from happening.

Update profiles now

If you wish to update profiles before a scheduled import:

  1. Click the Import tab on the top right of the page.
  2. Click Update profiles now next to the importer you wish to update.

Check for orphaned profiles 

Orphaned profiles are profiles that exist on your website but are no longer available or visible on CAP.

  1. Click the Import tab on the top right of the page.
  2. Click Check for orphaned profiles next to the desired importer.
  3. If any orphaned profiles are found, you have the option to delete them or leave them.

Editing an imported profile

Faculty

If the site is configured with CAPx and is using the JSE Default mapping, there are only a handful of fields that can be edited locally on faculty profiles: AffiliationOffice Hours, Office location, Mail Code,  and Faculty Status. All other profile information must be edited in CAP. Publications added to the Jumpstart site can also be linked to the Person node when editing the Publication on the Jumpstart site.

  1. Click Manage Content from the Site Actions menu. In the right sidebar, click Manage People. Find the necessary profile and click edit.
  2. Make any necessary changes to the AffiliationOffice Hours, Office location, Mail Code,  and Faculty Status fields.
  3. Click Save.

Staff

If the site is configured with CAPx and is using the JSE Default mapping, staff profiles should be primarily edited through CAPStaff Type can be edited on the Jumpstart site.