Follow

Jostle Contributors Template guide & glossary

 

Full Contributor Import Template:

Below is a guide to how to fill out the Contributor Import Template, which can be used to upload your people's data to your intranet. (For more info, see Importing Contributors to Jostle via CSV. If you wish to remove users from your intranet via CSV, see Deleting Contributors)

When you're finished creating your file and you want to import your Contributors via Administration Settings, click the Gear icon and go to Administration settings > Bulk manage Contributors > Import Contributors > Jostle Contributor template.  The file needs to be in CSV format (File > Save As in your spreadsheet editor).

Required fields (must be filled in for each row):

  • FirstName: First name of the Contributor.
  • LastName: Last name of the Contributor.
  • Username: Must be unique per Contributor and must be a valid email address* (using the same address as the WorkEmail field is recommended). To enable Google OpenID for a Contributor, you must enter their OpenID email address as their Username. If your organization is set up for Single Sign-On, you must enter their email address in your organization as Username.
  • WorkEmail: Must be a valid email address* that corresponds to the Contributor. Ideally, this field will match the Username field.

*If you have employees for which you cannot provide a real email address, see here.

Optional fields:

NOTE—If you wish to create your own unique field, refer to OtherLabel/OtherValue

  • Nickname: This is the nickname for the Contributor.  This will be the user's primary name in Jostle if included in the initial import.  If it is added later, the Contributor can choose which name to display (first name or nickname).
  • WorkEmailVisibility: Set the visibility of the work email for the Contributor to be 'EVERYBODY' or 'NOBODY'. By default it will be set to 'EVERYBODY' if left blank. Work email visibility can only be changed by an administrator in Jostle.
  • BirthDate: This is the birthdate for the Contributor. For the date format, you will be able to specify either DD/MM/YYYY or MM/DD/YYYY (Note: For SFTP imports, you can only use the MM/DD/YYYY format). The year is never shown in Jostle, but can appear in an export of all Profile data, available to System Administrators. If you set the year to 1896 the server will remove the year.
  • Joined: (HireDate is an alternative for joined) This is the date the Contributor joined your organization (hire date). For the date format, you will be able to specify either DD/MM/YYYY or MM/DD/YYYY (Note: For SFTP imports, you can only use the MM/DD/YYYY format)
  • OfficialLocation: This is the Address Alias of the Official Location at which the Contributor is located. Official Locations are defined using the “Add/Edit Official Locations” function on the Administration Homepage. (Caution: For entries that do not match already defined Aliases, the system will try to create new locations.) To add multiple locations, use a pipe "|" without spaces in between the different values (eg. location1|location2). Adding Locations
  • ContributorType: This is the type of the Contributor. Specify one of:
    • "INTERNAL" for Internal Contributors (e.g. employees).
    • "EXTERNAL" for External Contributors (e.g. consultants and customers).
    • "VIEW_ONLY" for a view-only account, which can read and download material, but not add / modify any content.
  • EmployeeId This is an optional field that currently is only visible to System Administrators.
  • CustomFilterCategory: This is a custom field which can be used to categorize Contributors. This custom field is used to permit or limit access to content in Jostle. The value is the name of the category to which the Contributor belongs. To add multiple categories, use a pipe "|" without spaces in between the different values (eg. category1|category2).  Custom Filter vs Custom Profile Category
  • CustomProfileCategory: This is a custom Profile field. The value is the Name of the category to which the Contributor belongs. In addition to creating your Custom Profile Categories by including them in this template, Custom Profile Categories can also be created using the “Add/Edit Custom Profile Categories” function on the Administration Homepage. Custom Profile Category can be re-named, for example to "License Plate #" within Edit Custom Profile labels on the Administration Homepage.
  • PrimaryRoleName: Value to choose the Primary Role of the Contributor. The Primary Role is the main/most important Role of a Contributor. Only use this field once an organization structure has been created in Teams. If this value is blank, it will be ignored. (For more on Primary Roles and how to configure them, go here: Primary Role)
  • PrimarySupervisorUsername: This is intended to be used to add new employees into an existing Main Organization structure. (Do not use when bulk importing employees for the first time.) This field can only be used to set the supervisor, not change it. Contributors will be made to report (by solid line) to the specified supervisor in the Main Organization. This supervisor must have a single solid-line Role in the Main Organization and the Contributor cannot have an existing solid-line Role in the Main Organization. In either case, an error will be reported. If PrimaryRoleName is specified, and it exists as a vacant Role under the designated supervisor, the Contributor will fill that existing Role. Otherwise a new Role is created and set to the PrimaryRoleName provided.
  • JobCategory: This is the human resources job category, or similar. It should be a generic description of the contributor’s profession. This is separate from Roles that are defined in the Jostle Application in association with contributions to specific teams. Job Category
  • AllowManageRelationships: Allow this person to publish teams and manage relationships down hierarchy.  (Options: true or false).
  • WorkOfficePhone: This is the office phone number for the Contributor.
  • WorkMobilePhone: This is the mobile phone number for the Contributor.
  • PersonalEmail: This is the personal email address for the Contributor
  • PersonalMobilePhone: This is a second (Contributor owned) mobile phone number for the Contributor.
  • HomePhone: This is a Contributor owned phone number for the Contributor.
  • AlternateEmail1Label: Label for the first optional, Contributor owned email field.
  • AlternateEmail1: Email address for the first optional, Contributor owned email field.
  • AlternateEmail2Label: Label for the second optional, Contributor owned email field.
  • AlternateEmail2: Email address for the second optional, Contributor owned email field.
  • PreferredEmail: Valid values are WORK, ALTERNATE1, ALTERNATE2, PERSONAL (Values are case sensitive.)
  • PreferredEmailVisibility: Valid values are EVERYBODY, DIRECT_CONNECTIONS, NOBODY. Note that the PreferredEmail field must be set in order to set the visibility.(Values are case sensitive.)
  • OtherLabel: This is an open-ended field to be used how you like. Enter the title here, such as "Favorite color".
  • OtherValue: This is the content of the open-ended field, as titled in OtherLabel above.  Using that "Favorite color" example, you would enter something like "Orange" here.
  • CustomBadge: This is the program level's name for the Contributor (e.g. "Senior"). The Badge program should already be configured prior to entering data in this column, entries not matching previously setup values will be ignored. Custom Badges

  • WorkMessagingLabel: This is used for the label of the optional Custom Profile Field that appears in the Other section of a Contributor's Profile.
  • WorkMessagingId: This is designed for a free-form value for the Custom Profile Field (see above). It can be set to Contributor-owned in Administration settings > Contributor Profiles > Manage Profile fields.
  • MessagingAddress1Label: Under the Contact section of Profile, label for the first optional data pair. The second and third pairs are modified by changing the 1 to a 2 or 3.
  • MessagingAddress1: Under the Contact section of Profile, data for the first optional data pair. The second and third pairs are modified by changing the 1 to a 2 or 3.
  • MailingAddress1Label/MailingAddress2Label: Under the Location section of Profile, label for the first (or second) optional address.
  • MailingAddress1Street/MailingAddress1Street: Under the Location section of Profile, first row of data for the first (or second) optional address.
  • MailingAddress1City/MailingAddress1City: Under the Location section of Profile, second row of data for the first (or second) optional address.
  • MailingAddress1State/MailingAddress2State: Under the Location section of Profile, third row of data for the first (or second) optional address.
  • MailingAddress1Zip/MailingAddress2Zip: Under the Location section of Profile, first fourth of data for the first (or second) optional address.
  • MailingAddress1Country/MailingAddress2Country: Under the Location section of Profile, fifth row of data for the first (or second) optional address.

Optional upload only fields:

InviteForAuthenticationMethod: This field allows you to specify that a Contributor is to be invited when the import file is processed. If you leave this value blank then the Contributor will created/updated, but not invited to log in. There are three types of authentication methods for which a Contributor can be invited, only some of which will apply to your organization:

  • "JOSTLE" for authenticating using Jostle credentials. If you did not sign up through Google Apps Marketplace, and you are not set up for Single Sign-On then this would be the only applicable value for you. If you signed up through Google Apps Marketplace or you are set up for Single Sign-On, then you can only specify this value if you have not disabled Jostle-managed passwords.
  • "GOOGLE" for authentication using Google credentials. You can specify this value if you signed up through Google Apps Marketplace.
  • "SSO" for authentication using Single Sign-On credentials. You can specify this value is you are set up for Single Sign-On.

NOTE—while on Administration settings > Bulk manage Contributors > Import Contributors > Jostle Contributor template use the drop down menu next to Invite to indicate the types of Contributors you wish to invite with your import.

If you select to not invite ("no one") as part of the import, then this field will be ignored and all Contributors will be set to the organization's default. You will then be able to change the login type when you do the invitation through the Contributor invite page.

Attachment(s):

Was this article helpful?
7 out of 7 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.