sfpt v1.0.2
sf-pt 使用说明
描述:
本工具目地简单明了,就是通过在Excel中配置权限,通过工具读取本地的PermissionSet 元数据, 将Excel中的权限附加到指定的元数据中,达到批量修改
准备工作
请确保电脑上已经具有
node
环境请确保电脑上已经安装好
SFDX CLI
请确保通过
SFDX
授权了对应SF Org
通过
npm install sfpt
安装sfpt
使用方法
1. 初始化
创建一个目录,进入目录后,sfpt init
会自动生成初始化的目录
config.json 程序的配置文件
input 存放PermissionSet的XML目录
output 生成新的PermissionSet的XML目录
PermissionSetConfig.xlsx 用于权限配置
sfdx-project.json SFDX验证所需要
retrieve SFDX获取PermissionSet 元数据存放的目录
以上目录位置均可以在config.json中配置,但是一般保持默认,所有命令在当前目录下执行
2. 配置username
打开config.json中,将本地授权过的SF用户名填写在SFUserName,要看本地授权的SF Org,通过sfdx force:org:list 查看
3. 获取Org所有的权限集
- 执行
sfpt retrieve
,将获取的权限集元数据存放在retrieve目录下
4. config.json中的permissionSetFiles选
在retrieve目录中选择需要添加权限的权限集,将元数据复制到input目录
新版本中此处可以不需要,只要将要处理的PermissionSet的XML放在input目录下就可以了
执行
sfpt load
程序将input目录下的权限集名称,自动填充到config.json中的permissionSetFiles节点中(避免手动填写)。
5. 在Excel中配置好权限
- 每个sheet的名称与权限集中的节点对应,比如fieldPermissions
- 表头与fieldPermissions节点下的子节点对应,不同类型的权限,子节点不相同
程序默认创建4种常见类型的权限
6. 生成新的权限集元数据
- 当excel中权限配置完成后,执行
sfpt run
后,会在output 目录下生成新的元数据,同时会执行验证程序,来验证permission是否正确 如果输出:Successfully validated the deployment,则表明生成的PemissionSet是没有问题
7. 验证元数据
执行
sfpt verify config.json
执行验证元数据,看元数据合并是否有错误,此处调用SFDX命令新版本中此处可以不需要,在执行 sfpt run时会最后会自动验证
8. 将新的元数据部署到Org中
执行
sfpt deploy
执行元数据部署,此处调用SFDX命令
9. 生成Excel文件
- 执行
sfpt x2e
会将retrieve目录下的permission.xml生成对应的Excel文件
补充:
- tabSettings中的visibility有三个值:Invisible,Visible,Available,当为Invisible时,程序会移除这行,生成新的xml中不含,deploy后就不会有这个权限