豪翔天下

Change My World by Program

0%

Salesforce 中文操作手册

发表于 更新于 分类于 Disqus：

salesforce后台配置

  • Lightning Experience就是新版的系统，classic就是老版本，新功能以后都只会出现在Lightning Experience中

常用需求操作方式

导出数据

  • Setup -> Data -> Data Export -> Export Now -> Start Export，大概等个5到10分钟就能在页面下载了

添加navigation菜单到首页

  • Setup -> App Manager ，然后选择自己的首页的app，一般是Force.com，进入编辑页面就能看到Choose the Tabs设置了

跟踪对象或字段的历史修改

  • 首先需要再对象的Details设置里面打开Track Field History

  • 由于每个对象最多只能设置20个追踪字段，所以默认没有打开，针对单独的字段得单独打开，在Object Manage -> Your Object -> Fields & Relationships

    -> Set History Tracking，选中想要追踪的字段保存即可

  • jsforce sdk可以这样查询history

    • 返回的结果中，ParentId才是原始对象的Id，FIeld则是更改的字段
1
2
3
4
5
6
7
// 注意如果是标准对象，那么直接加History即可，例如AccountHistory，如果是自定义对象__c，那么需要将__c替换为__History
conn.sobject('MyCustomObject__History').find({
  ParentId: "xxxxxxxxx",
  Field: "xxx",
  OldValue: "",
  NewValue: "",
})

将自定义的对象添加为tab

Sandbox

  • Sandbox的价格表，没错，是按照原是数据的价格来按百分比收费的，怪不得很多用户都只是partial copy，得自己想办法去将生产数据同步到sandbox中去。
  • 如果不用salesforce自己的Refresh方式，那么想要同步production到sandbox，要么借助第三方的收费工具，要么就自己去同步了，自己同步是个体力活，你必须得找到不同对象之间的关系，新插入的数据和之前的ID肯定是不一样的，整个migration程序都得维护这些ID的映射，相当麻烦
  • 注意手动刷新sandbox后，相当于删除旧的创建新的，在旧的sandbox环境里面新建的用户会消失的，新的sandbox的users总是和production的一样，只不过email添加了一个后缀.sandboxname

Apps

  • AppExchange(App Store)里面的app氛围APP、Component、Consultant

Connected App

  • New Connected App 菜单在Apps -> App Manager里面，而不是在Apps -> App Manager -> Connected Apps -> Manage Connected Apps里面

  • App Manager和Manage Connected Apps里面如果有相同的app，那么可能这两个菜单点进去会是不同的设置

  • 在设置里面可以设置哪些profile能访问这个app，需要注意的是，即使选择的认证方法是POST的，如果你选择了所有人都能访问app(All users may self-authorize)，那么它仍然不会去使用POST认证，会直接用GET去访问app，所以即使我们要所有人都能访问也要选择只允许选择的人(Admin approved users are pre-authorized)，你可以选择所有的profile都行(在app最右边下拉Manage菜单中设置，不是View也不是edit)。注意修改后可能出现You don't have permissions to view application with namespace 错误，只需要在manage菜单的下面Profiles那里选择Manage Profiles，把System Administrator打开即可

  • app要允许oauth才能将认证token传到第三方或者自己的callback api

  • 如果要作为tab显示在顶部菜单栏，需要

    • 将connected app的canvas打开，并设置canvas app url

    • 创建visualforce page，里面需要包含这个app，创建一个canvas来包含connected app，例如

      1
      2
      3
      <apex:page standardController="Account">
          <apex:canvasApp applicationName="Connected APP的API名称"  width="100%" height="5400px" maxHeight="infinite" />
      </apex:page>

    • 然后在Setup里面搜索Tabs，在visualforce里面选择它，最后再在首页的tabs里面添加即可

  • 创建了带Oauth的app后就能获取到其client_id和client_secret了(也叫Consumer Key和Consumer Secret)

Object & Fields

  • 对象的Record Types只是用于前端可以根据某个值来展示不同的表单，例如根据role来确定admin和user能设置哪些字段
  • __c结尾表示custom，__r结尾表示relationship

Report

  • 一个非常方便的过滤数据的方式，report还能分享和到处excel
  • 添加filter logic，首先要添加filter condition，然后在用A or B, A and (B or C)等等的逻辑控制语句来控制

回收站Recycle Bin

首页左上角搜索app里面有Recycle Bin，最近删除了的对象能在这里找到并恢复

Debug

  • 如果要对网站的用户进行debug，可以在Setup -> Environments -> Logs -> Debug Logs中进行设置，如果是调试sites的guest user，只需要new的时候选择指定的user即可

数据库客户端SoqlXplorer

  • 发现好多对象在后台看不了，但是用客户端或者sdk能看到

jsforce sdk

配置连接

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
var jsforce = require('jsforce');
var conn = new jsforce.Connection({
    loginUrl: process.env.SANDBOX_LOGIN_URL,
    maxRequest: 200,	// 默认最大的并发请求数量(例如同时create多条记录)才10，超过会报错Exceeded max limit of concurrent call，但是这个值最大却只能200，否则也会报这样的错误EXCEEDED_ID_LIMIT: record limit reached. cannot submit more than 200 records into this call
});
conn.login('username@domain.com', `${password}${securityToken}`, function(err, res) {
  if (err) { return console.error(err); }
  conn.query('SELECT Id, Name FROM Account', function(err, res) {
    if (err) { return console.error(err); }
    console.log(res);	// {"totalSize":0,"done":true,"records":[]}
  });
});

// 通过instanceUrl和accessToken进行连接
new jsforce.Connection({
  instanceUrl,
  accessToken,
});

// 通过refresh token登陆，注意refresh token只有在OAuth的response_type为code的时候才能拿来用，否则会报错invalid_grant: expired access/refresh token
// 也只有为code的时候canvas app才会在OAuth后发送signederquest到callback url
// 可以在Connected App中设置refresh token的过期策略，设置为9999个月后过期就能一直拿来用了
const conn = new jsforce.Connection({
  oauth2 : {
    clientId : 'Connected App的OAuth consumer key',  // 如果是安装的package，那么得是package作者的connected app的client id/secret
    clientSecret : 'Connected App的OAuth consumer secret',
    redirectUri : 'Connected App的callback uri',
    loginUrl: 'https://login.salesforce.com',   // 当为sandbox环境时是https://test.salesforce.com
  },
  instanceUrl : 'Oauth得到的instance url',
  accessToken : 'Oauth得到的accessToken', // 其实只要有refreshToken，这个值随便填啥都行
  refreshToken : 'Oauth response_type为code的时候的refresh token'
});

const results = await conn.oauth2.refreshToken(refreshToken); // 获取新的accessToken

conn.identity()	// 能够获取到一些基本信息，例如organization_id

数据库操作

1
conn.describeSObject('Account');	// 获取对象object的数据结构，包括recordTypeInfos

数据表操作

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
conn.metadata.list([{type: 'CustomObject'}]) // 列出所有的Custom Objects
conn.metadata.read('CustomObject', ['tableName__c'])	// 列出指定object名的Custom Object

// 创建Object，会自动创建Created By、LastModified By、Owner、Name、IsDeleted(后台看不到)字段
conn.metadata.create('CustomObject', [{	
  fullName: 'TableName__c',
  label: 'Table Label',
  pluralLabel: 'Table Label',
  nameField: {	// 默认的name字段，这个字段不是唯一的
    type: 'Text',
    label: 'Name'
  },
  deploymentStatus: 'Deployed',
  sharingModel: 'ReadWrite'
}])

// 给Object添加字段
conn.metadata.create('CustomField', [{
  fullName: 'TableName__c.FieldName__c',
  label: 'FieldName',
  type: 'Text',
  length: 80,
  inlineHelpText: 'This is inline help text'
}])

增删改查

  • 针对时间字段，如果是query raw sql， 记得不用加引号: CreatedDate > 2022-07-19T00:00:00Z，如果是sobject来查询，可以const {SfDate} = require("jsforce"); SfDate.SfDate.toDateTimeLiteral('2022-07-19 00:00:00')

  • find方法单次默认只能查询200条记录，可以修改offset，但是最大的offset值也才2000。如果要查询所有，可以这样做

    1
    2
    3
    4
    5
    6
    // 方法1
    const res = await conn.sobject('Contact').run({autoFetch: true, maxFetch: 200000})

    // 方法2
    const res = await conn.query('SELECT * FROM Contacts');	// 仍然只会返回2000条数据
    const res1 = await conn.queryMore(res.nextRecordsUrl); // 类似于现在有些翻页接口，外面套一个while循环就能遍历所有了
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
// 查询
await conn.query('SELECT Id, Name FROM Account') // query语句能够实现简单的SQL(SOQL)查询
await conn.sobject("Contact").count()	// 获取所有的记录数
conn.sobject('Contact').count({})	// 统计指定条件的记录数，注意这里不是find再count，而是直接把条件放到count里面
conn.sobject('Account').find().select(['Id', 'Name']) // 获取指定字段，select必须在find后面，不能在前面
conn.sobject("Contact")	// 类似ORM的查询方式
  .find(
    // conditions in JSON object，查询条件
    {
      LastName : {
      		$like : 'A%',
          $ne: null	// 不等于null
          $not: {	// 非
          	$ne: null
        	}
    	},
  		$or: [
  			{Name: {$like: "ha%"}},
  			{Name: {$like: 'fly%'}},
  		],
      CreatedDate: { $gte : jsforce.Date.YESTERDAY },
      'Account.Name' : 'Sony, Inc.' },
    // fields in JSON object，下面是需要取的字段
    { Id: 1,
      Name: 1,
      CreatedDate: 1
    },
  )
  .sort({ CreatedDate: -1, Name : 1 })
  .limit(5)
  .skip(10)
  .execute(function(err, records) {
    if (err) { return console.error(err); }
    console.log("fetched : " + records.length);
  });

// 也可以写Raw SQL
conn.sobject("Contact")
  .select('*, Account.*') // asterisk means all fields in specified level are targeted.
  .where("CreatedDate = TODAY") // conditions in raw SOQL where clause.
  .limit(10)
  .offset(20) // synonym of "skip"
  .execute(function(err, records) {
    for (var i=0; i<records.length; i++) {
      var record = records[i];
      console.log("First Name: " + record.FirstName); 
    }
  });

// 联表子查询
conn.sobject("Contact")
  .select('*, Account.*')
  .include("Cases") // include child relationship records in query result. 
     // after include() call, entering into the context of child query.
     .select("*")
     .where({
        Status: 'New',
        OwnerId : conn.userInfo.id,
     })
     .orderby("CreatedDate", "DESC")
     .end() // be sure to call end() to exit child query context
  .where("CreatedDate = TODAY")
  .limit(10)
  .offset(20)
  .execute()

conn.sobject("Contact").find({ CreatedDate: jsforce.Date.TODAY })	// 如果要查询所有字段可以不给find第二个参数
conn.sobject("Contact").find({ CreatedDate: jsforce.Date.TODAY }, '*')	// 同上

// 在所有对象上进行搜索
conn.search("FIND {Un*} IN ALL FIELDS RETURNING Account(Id, Name), Lead(Id, Name)",
  function(err, res) {
    if (err) { return console.error(err); }
    console.log(res);
  }
);

// 直接根据主Id获取对象
await conn.sobject("Account").retrieve("0017000000hOMChAAO");
await conn.sobject("Account").retrieve(["0017000000hOMChAAO", "0017000000hOMChAAO"]);	// 获取多个


// 创建记录
await conn.sobject("Account").create({ Name : 'My Account #1' });
await conn.sobject("Account").create([{ Name : 'My Account #1'}, { Name : 'My Account #2'} ]); // 同时创建多条记录
await conn.sobject("Account").create(accounts, {allowRecursive: true}); // 同时创建多条记录，默认一次最多200条，可以添加allowRecursive参数创建更多的记录


// 更新记录
await conn.sobject("Account").update({ 
  Id : '0017000000hOMChAAO',
  Name : 'Updated Account #1'
};
await conn.sobject("Account").update([	// 更新多条
  { Id : '0017000000hOMChAAO', Name : 'Updated Account #1' },
  { Id : '0017000000iKOZTAA4', Name : 'Updated Account #2' }
];
await conn.sobject('Opportunity')	// 查找并更新
    .find({ 'Account.Name' : 'Salesforce.com' })
    .update({ CloseDate: '2013-08-31' }
                                     
                                     
// 创建或者更新upsert
await conn.sobject("UpsertTable__c").upsert({ 
  Name : 'Record #1',
  ExtId__c : 'ID-0000001'
}, 'ExtId__c')
                                     
                                    
// 删除记录
await conn.sobject("Account").destroy('0017000000hOMChAAO');
await conn.sobject('Account').find({xxx}).destroy()
conn.sobject("Account").del(['0017000000hOMChAAO','0017000000iKOZTAA4']; // 删除多条

常见错误处理

  • DUPLICATES_DETECTED: 如果在Object Manager没有发现什么唯一键，可以在Setup -> Data -> Duplicate Management -> Duplicate Rules里面看看有没有什么检测重复的规则

SFDX命令行工具

1
2
3
4
5
npm install sfdx-cli --global
sfdx force:auth:web:login -d -a DevHub	# 登录
sfdx force:auth:web:login -r https://test.salesforce.com	# 登录sandbox

sfdx force:mdapi:retrieve -s -r ./mdapipkg -o DevHub -p <package name>	# 获取package的元数据

AppExchange Package app / Connected App / Canvas App开发

  • Connected App用于连接第三方服务，第三方服务可以通过OAuth授权来获取token来获取salesforce的数据
  • AppExchange app是可以发布到salesforce的应用商店的(AppExchange)，但是开发者需要支付2500美元，并且以后每年还需要200美元，怪不得上面的app那么少
  • AppExchange App是原生的，无需身份验证和集成
  • Canvas App和Connected App都可以打包为AppExchange App
  • Canvas App/Connected App开发步骤
  • AppExchange App开发步骤
  • Canvas App的认证方式
    • SF会根据权限的设置来决定是用GET还是POST，但是默认是GET请求，即Permitted User选择的是All users may self-authorize。如果是GET请求，会带一个参数_sfdc_canvas_authvalue = user_approval_required到callback，callback收到该参数来决定是否启动OAuth认证流程。当用户Approve了后，canvas app应该调用一个repost方法取获取signed request
    • Verifying and Decoding a Signed Request
  • 安装完AppExchange App后无法做到自动修改授权或者自动获取access token或者自动跳转到app页面，参考，只能用户手动点击Configuration才行
  • AppExchange App可以添加一个post install脚本，但是其作用有限，只能获取到最基本的信息，org名称、版本信息等，并且不能设置重定向
  • 给AppExchange的app的uninstall旁边增加一个Configure按钮以打开app的首页
    • 这个只有在classic页面才有: Setup > Build > Customize > Home -> Custom Links，创建一个新的Link
    • Setup > Create > Packages，选择package，在package的编辑页面的Configure Custom Link添加该link即可
  • Canvas APP的sdk并没有一个比较现代的npm包，不过还好有个大概能用的SalesforceCanvasJavascriptSDK
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
const onClickOAuth = () => {
  // 需要注意的是sandbox的login uri是不一样的
  const uri = hostname.includes('sandbox') ? 'https://test.salesforce.com/services/oauth2/authorize' : Sfdc.canvas.oauth.loginUrl();

  Sfdc.canvas.oauth.login({
    uri,
    params: {
      response_type : "code",   // 使用code的方式才能获取到refresh token
      client_id : SFDC_CLIENT_ID, // 在package的canvas app的client id
      redirect_uri : encodeURIComponent(SFDC_REDIRECT_URI), // 在Package的canvas app里面设置的回调地址
    }
  })
}

// oauth完成后关闭弹窗
if (window.opener) {
  try {
    window.opener.Sfdc.canvas.oauth
      .childWindowUnloadNotification(window.location.hash);
  } catch (e) {
    // do nothing
  }
  window.close();
}

// 登陆成功后获取对应的信息
const _loggedIn = Sfdc.canvas.oauth.loggedin();
const token = Sfdc.canvas.oauth.token();
const client = Sfdc.canvas.oauth.client();
Sfdc.canvas.client.refreshSignedRequest(function(data: any) {
  if (data.status === 200) {
    const signedRequest =  data.payload.response;
    const part = signedRequest.split('.')[1];
    const obj = JSON.parse(Sfdc.canvas.decode(part));

    console.log('obj', obj);    // 可以获取到obj.client.instanceUrl,obj.client.oauthToken,obj.client.refreshToken,obj.context.organization.organizationId,obj.context.organization.name
  }
})

Sfdc.canvas.client.ctx(function(ctx: any) {
  if (ctx.status === 200) {
      console.log(ctx.payload.organization.organizationId, ctx.payload.organization.name);
  }
}, client);

推荐Packages

Survey Force

  • 一个调查问卷包，可以添加调查问卷给用户
  • 如果想要允许外部用户直接访问，那么需要新建sites，新建完成后按照文档修改权限，但是最后有一点需要注意的是创建Survey的时候那个可以复制的地址是代码里面写死的，如果需要修改就要去developer console修改其源代码，且生产环境不允许直接修改。有了sites后真实的访问地址是${sites_url?id=xxxx ，这里的ID就是那个survey的id
  • 其实其README中的配置步骤还是比较详细，就是可能salesforce后台的UI变了有些配置找不到地方，这里记录一下
    • Public Access Settings和文档里面的描述不一样，View Users现在是点进Assigned Users里面设置，如果要修改那几个object的权限以及Apex Classes，需要在Public Access Settings里面设置Apex Class Access和 Object Settings
  • 如果出现Authorization Required错误，多半是访问的url的问题，可能是id没有填

Troubleshooting

  • The requested resource no longer exists: 可能是使用的rest api的版本太低了导致的，可以通过这个方式获取当前支持的API版本列表: List Available REST API Versions
  • Unable to create/update fields: xxx. Please check the security settings of this field and verify that it is read/write for your profile or permission set: 需要去检查一下这个字段的权限，在Setup -> Object Manager -> 选择Object再选择Fields，点击Field Level Security检查权限
  • Can’t alter metadata in an active org：无法在生产环境直接修改部分代码，只能现在sandbox里面修改了同步过去
  • Bad Message 431 reason: Request Header Fields Too Large: 可能是字段太多了，因为不支持select * ，所以默认情况会在select后列出所有的字段，就可能导致header太大了，解决办法就是select指定的字段
坚持原创技术分享，谢谢支持

欢迎关注我的其它发布渠道