iSAMS数据集成:第一部分

The Faria Team
  • 更新

本文提供了一份全面的分步指南,帮助您将iSAMS数据导入SchoolsBuddy 。使用右侧的索引可以快速导航到与您需求相关的部分。

1. 概述

SchoolsBuddy使用批量 API 密钥直接从iSAMS导入您的重要数据,包括学生、联系人和教职工信息。系统会在夜间进行数据更新,确保您的信息始终准确且最新。

请通过iSAMS管理控制面板 > API 密钥部分设置七个独立的批量 API 密钥(医疗密钥为可选)。

分别创建这些密钥可以让SchoolsBuddy独立提取不同类型的数据,从而提高负载处理能力,并确保数据导入顺利进行并按正确的顺序运行。

2. 如何创建批量 API 密钥

要设置 API 密钥,请按照以下步骤操作。根据您使用的是云托管的 ISAMS 实例还是自托管的 ISAMS 实例,这些步骤可能会略有不同。

  1. 以管理员身份登录 ISAMS,然后单击控制面板。
  2. 选择API 服务管理器

    屏幕截图:选择 API 服务管理器
  3. 选择“管理批量 API 密钥”

    屏幕截图:选择“管理批量 API 密钥”
  4. 点击“创建批量 API 密钥” (或者如果您看到的是“请求批量 API 密钥”)。
    您需要先向 ISAMS 申请 6 或 7 个新密钥(取决于您是否要共享医疗信息)。
  5. 根据其用途明确命名密钥(例如, SchoolsBuddy – 学生; SchoolsBuddy – 联系人),以便以后轻松识别。
  6. 设置以下关键配置:

    • 状态:活跃

    • 模式:生产

    • 缓存过期时间: 2 至 4 小时(而非默认的 24 小时)

      截图:缓存过期时间:2 至 4 小时(而非默认的 24 小时)

  7. 选择“批处理方法”选项卡。
  8. 请按照下表所示配置每个键。以下是“联系人”键的示例。
    屏幕截图:请按照下表所示,检查设置以配置每个按键。

    请参考下表,了解每种批量 API 密钥对应的正确设置:

    • API密钥1 团体
      • 学校经理 - 学术宿舍
      • 学校管理系统 - 表单
      • 学校经理 - 年
      API密钥2 职员
      • 人力资源经理 - 现有员工
      截图:人力资源经理 - 现有员工
      API密钥3 学生
      • 学生管理系统 - 在校学生
      屏幕截图:学生管理器 - 当前学生
      API密钥4 联系方式
      • PupilManager -联系人(已筛选) 。
      • 请勿勾选“联系人”或“自定义字段”选项 - 请参见屏幕截图
      • 请查看下方关于SchoolsBuddy联系人导入规则的重要说明
      截图:请查看下方关于 SchoolsBuddy 联系人导入规则的重要说明
      API密钥5 医疗的
      • 此键为可选键
      • 学生管理系统 - 在读学生 - 健康
      • 请勿勾选“自定义字段”选项 - 请参见屏幕截图
      截图:请勿勾选“自定义字段”选项 - 请参见截图
      API密钥6 主题
      • 教师管理系统 - 部门、教学表格、课程列表和课程设置(用于家长会/家长教师会议和沟通)
      API密钥7 离校生(校友)
      • 学生经理 - 校友
      截图:如何创建批量 API 密钥:学生管理系统 - 校友

      ⚠️重要提示:
      仅选择以下每个键对应的方法。
      请勿选择任何其他设置或自定义字段,因为这可能会导致SchoolsBuddy无法正确处理数据。

  9. 转到“集成器”选项卡。
  10. 输入集成商为“ Faria ”,产品名称为“ SchoolsBuddy ”。 屏幕截图:将集成商输入为“Faria”,产品名称输入为“SchoolsBuddy”。
  11. 点击“保存并关闭” 。
  12. 将弹出一个窗口,提供身份验证服务器凭据。
    暂时不要关闭此窗口——您需要这些信息来完成SchoolsBuddy集成。 屏幕截图:将弹出一个窗口,提供身份验证服务器凭据。

3. SchoolsBuddy配置

在iSAMS中创建 API 密钥后,请按照本文中的步骤操作: iSAMS数据集成:第 2 部分,开始与SchoolsBuddy集成。

4. 常见问题解答

问:如果我们需要更新学生、家长或教职工的详细信息该怎么办?

答:请像往常一样直接在iSAMS中更新详细信息。这些更改每晚都会导入到SchoolsBuddy 。但是, iSAMS更新其 API 数据源有时可能需要更长时间,您可能会注意到学生记录会在他们的电子邮件地址完全更新之前出现。我们建议等待最多 48 小时,以便所有新学生的详细信息完全同步。

问:学生离校后,他们的信息会自动删除吗?

答:是的。在iSAMS中被标记为离校生或校友的学生将被自动移除。

问:学生离校时,家长信息会自动从学生名单中移除吗?

答:除非学生有兄弟姐妹目前在该校就读并拥有有效的SchoolsBuddy帐户,否则家长的帐户将被停用。

问:员工离职时,系统会自动从员工列表中移除吗?

答:不。内部和外部员工的SchoolsBuddy账户将一直保留,直到手动删除为止。组织超级管理员用户必须自行删除其SchoolsBuddy账户。这是由于iSAMS API 的限制所致。

问: 为什么要调整缓存过期时间?

A: SchoolsBuddy每 24 小时在夜间查询iSAMS一次。
将缓存过期时间缩短至 2-4 小时可确保:

  • 如有需要,数据可以更快地刷新。

  • 您可以手动运行数据同步(例如,如果当天添加了新学生)。

  • 该系统仍然会将结果缓存几个小时,从而最大限度地减少iSAMS数据库的负载。

  • 如果缓存设置为默认的24 小时,则任何新的或更新的数据都要等到第二天的计划同步才能使用。

问: SchoolsBuddy能否导入iSAMS每日“校外”出勤记录?

答:目前还没有。未来, iSAMS可能会将此数据纳入其公共API,届时SchoolsBuddy即可导入。

问: SchoolsBuddy可以导入医疗信息吗?

答:是的。如果您提供医疗批次管理API密钥,我们可以导入您学生的医疗状况。

问:教师的课程可以直接导入SchoolsBuddy吗?

答:是的,但为了支持家长会和沟通,只会导入基于班级的课程。基于班级的课程不会被导入。

问:寄宿学校可以添加到SchoolsBuddy吗?

答:我们目前的集成仅支持教学楼。不过,一些学校表示有兴趣将寄宿信息添加到学生记录中。请访问我们的产品门户网站,为此功能投票。

问:学生照片可以同步到SchoolsBuddy吗?

答:目前无法通过iSAMS API 同步学生照片。不过,如果您对此感兴趣,请联系我们的支持团队,我们或许可以提供其他解决方案。

问:我们使用一个iSAMS账户管理多个校区,并按如下方式分配年份。这样做会有问题吗?

  • 校区 1:1-10 年级

  • 校区 2:20-30 年级

答: SchoolsBuddy会同步年级的显示名称,因此如果 10 年级和 20 年级使用相同的名称(例如,“5 年级”),它们将被导入为一个年级组。我们建议在年级组名称中添加校区标识符,以便在SchoolsBuddy中区分它们,例如“5 年级校区 1”和“5 年级校区 2”。

Share

这篇文章有帮助吗?

0 人中有 0 人觉得有帮助